Authoring Apple Immersive Video

At a glance

Project structure

Source bundle/
├── ImmersiveMediaSupport Authoring/
│   ├── CreateAIVU.swift
│   └── CreateAIVUWriter.swift
├── Configuration/
│   └── SampleCode.xcconfig
└── ImmersiveMediaSupport Authoring.xcodeproj/
    ├── .xcodesamplecode.plist
    └── project.pbxproj

Structure observations

• Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
• Primary languages: Swift.
• The verified tree contains 3 project/configuration file(s) and 3 source declaration(s).

Overall architecture

flowchart LR
    N1["CreateAIVU"]
    N2["ImmersiveMediaSupport APIs"]
    N1 --> N2

Reference code

ImmersiveMediaSupport Authoring/CreateAIVU.swift:14 — architecture anchor

@main
struct CreateAIVU: AsyncParsableCommand {
    // ...
    var inputFile: String
    // ...
}

Interpretation

The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into Immersive Media Support.

Ownership and state

classDiagram
    CreateAIVU *-- String : inputFile
    CreateAIVU *-- String : aimeFile
    CreateAIVU *-- String : usdzFile
    CreateAIVU *-- String : maskFile

Ownership evidence

ImmersiveMediaSupport Authoring/CreateAIVU.swift:17 — stored dependency or nearest verified ownership anchor

@main
struct CreateAIVU: AsyncParsableCommand {
    // ...
    var inputFile: String
    // ...
}

Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.

Concurrency, scheduling, and thread safety

Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.

@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.

Reference code

ImmersiveMediaSupport Authoring/CreateAIVU.swift:35 — representative execution boundary

    mutating func run() async throws {
        guard outputFile.lowercased().hasSuffix(".aivu") else {
            throw RuntimeError("Output file must end in .aivu")
        }
        // ...
    }

State propagation, frameworks, and dependencies

Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.

receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.

Class and protocol design

ImmersiveMediaSupport Authoring/CreateAIVU.swift:15 — representative type boundary

@main
struct CreateAIVU: AsyncParsableCommand {
    // ...
    var inputFile: String
    // ...
}

No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.

Access control

Reference code

ImmersiveMediaSupport Authoring/CreateAIVU.swift:33 — representative boundary

@main
struct CreateAIVU: AsyncParsableCommand {
    // ...
    private var customCreatedCalibrationId = "CustomCreatedCalibration"

    // ...
}

Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.

Logic ownership and placement

Design patterns

Main application flow

sequenceDiagram
    participant CreateAIVU
    participant CreateAIVUWriter
    participant AIVUValidator
    CreateAIVU->>CreateAIVU: createVenueDescriptor()
    CreateAIVU->>CreateAIVU: createPresentationDescriptor()
    CreateAIVU->>CreateAIVUWriter: create()
    CreateAIVU->>AIVUValidator: validate()

Reference code

ImmersiveMediaSupport Authoring/CreateAIVU.swift:61 — run()

    mutating func run() async throws {
        guard outputFile.lowercased().hasSuffix(".aivu") else {
            throw RuntimeError("Output file must end in .aivu")
        }

        print("Creating .aivu file")

        // Setup the `inputURL` and `outputURL`.
        let inputURL = URL(filePath: inputFile)
        let outputURL = URL(filePath: outputFile)

        // Create the `VenueDescriptor` for the AIVU file from the provided input options.
        let venueDescriptor = try await createVenueDescriptor()

        // Create a `PresentationDescriptor` for the AIVU file with some default commands.
        let presentationDescriptor = try await createPresentationDescriptor(with: venueDescriptor)

        print("Input: \(inputURL)")
        print("Output: \(outputURL)")

        if FileManager.default.fileExists(atPath: outputURL.path()) {
            print("Output file already exists, removing to rewrite output file.")
            try? FileManager.default.removeItem(at: outputURL)
        }

        // Use the writer to create the AIVU output file.
        try await CreateAIVUWriter.create(from: inputURL, venue: venueDescriptor, presentation: presentationDescriptor, to: outputURL)

        // Validate the created AIVU file.
        let valid = try await AIVUValidator.validate(url: outputURL)
        guard valid else {
            throw RuntimeError("Invalid AIVU file created.")
        }
    }

Naming conventions

• Types: feature-specific names rather than reusable layer suffixes.
• Protocols: no local protocol declaration in the scanned source.
• Methods: run, createVenueDescriptor, createPresentationDescriptor, create, getMetadataItem, getTimedMetadataGroup, getOutputProvider, getMetadataFormatDescription.
• Files: ImmersiveMediaSupport Authoring/CreateAIVU.swift, ImmersiveMediaSupport Authoring/CreateAIVUWriter.swift.

Architecture takeaways

• CreateAIVU is the main source-visible entry or composition anchor for this sample.
• Framework work reaches AVFoundation, ImmersiveMediaSupport, ArgumentParser through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
• Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
• Access-control conclusions separate verified language visibility from the likely design rationale.
• The source does not justify labeling the design protocol-oriented.

Source map

• Official Apple documentation