Sample CodevisionOSReviewed 2026-07-21View on Apple Developer

Playing immersive media with RealityKit

At a glance

Item Summary
Purpose Create an immersive video playback experience with RealityKit.
App architecture A Swift sample with the source-visible chain RealityKitImmersivePlaybackAppContentViewAppModelSwiftUI / RealityKit APIs.
Main patterns No named application pattern supported by the extracted structure
Project style 19 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries.
Execution model Source-visible boundaries: @MainActor, Task closure isolated to MainActor, Task, await suspension point; none alone proves a background thread.
State/event model Source-visible mechanisms: @Observable, NotificationCenter, SwiftUI state property wrapper.
Key frameworks/packages SwiftUI, RealityKit, AVFoundation, Foundation; these are source dependencies, not architecture labels.

Project structure

Source bundle/
└── RealityKitImmersivePlayback/
    ├── RealityKitImmersivePlaybackApp.swift
    ├── Models/
    │   ├── AppModel.swift
    │   ├── VideoModel.swift
    │   ├── PlayerModel.swift
    │   ├── PlaybackReadiness.swift
    │   └── VideoModes.swift
    ├── Views/
    │   ├── ContentView.swift
    │   ├── ImmersiveControlsView.swift
    │   ├── LoadingIndicator.swift
    │   ├── TransportView.swift
    │   └── VideoPlayerView.swift
    └── Scenes/
        └── PlayerImmersiveSpace.swift

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 4 project/configuration file(s) and 26 source declaration(s).

Overall architecture

Reference code

RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift:10 — architecture anchor

@main
struct RealityKitImmersivePlaybackApp: App {
    @Environment(\.openWindow) private var openWindow
    // ...
}

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 visionOS.

Ownership and state

Ownership evidence

RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift:17 — stored dependency or nearest verified ownership anchor

@main
struct RealityKitImmersivePlaybackApp: App {
    // ...
    @State private var appModel = AppModel()
    // ...
}
Owner Object or state Relationship Mutation authority
RealityKitImmersivePlaybackApp AppModel (appModel) owns wrapper-managed state Owning lexical scope
AppModel AVPlayer (player) stores or receives Initialized by the owner; the binding is immutable
AppModel PlayerModel (playerModel) stores or receives Initialized by the owner; the binding is immutable
AppModel WindowState (windowState) stores or receives App/module collaborators

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.

Concern Source mechanism Verified placement or handoff Evidence
Main isolation @MainActor The cited annotation marks its attached declaration or closure as main-actor isolated. RealityKitImmersivePlayback/Models/AppModel.swift:13
Main isolation Task closure isolated to MainActor The cited operation explicitly enters a main-actor-isolated region. RealityKitImmersivePlayback/Models/PlayerModel.swift:44
Task creation Task The source creates an unstructured task; surrounding context determines inherited actor isolation. RealityKitImmersivePlayback/Models/PlayerModel.swift:44
Suspension boundary await suspension point The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. RealityKitImmersivePlayback/Models/PlayerModel.swift:73

@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

RealityKitImmersivePlayback/Models/AppModel.swift:13 — representative execution boundary

@MainActor
@Observable
final class AppModel {
    let player: AVPlayer
    // ...
}

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.

Category Mechanism or module Verified role Evidence
State propagation @Observable Observation macro publishes source-visible changes. RealityKitImmersivePlayback/Models/AppModel.swift:14
State propagation NotificationCenter NotificationCenter distributes named process-local events. RealityKitImmersivePlayback/Models/PlayerModel.swift:73
State propagation SwiftUI state property wrapper A SwiftUI property wrapper supplies or observes UI state. RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift:12
Source import SwiftUI The cited file imports this module; runtime use and architectural role are not inferred. RealityKitImmersivePlayback/Extensions/VideoModel+Library.swift:9
Source import RealityKit The cited file imports this module; runtime use and architectural role are not inferred. RealityKitImmersivePlayback/Extensions/Entity+Extensions.swift:9
Source import AVFoundation The cited file imports this module; runtime use and architectural role are not inferred. RealityKitImmersivePlayback/Extensions/AVPlayer+Extensions.swift:8
Source import Foundation The cited file imports this module; runtime use and architectural role are not inferred. RealityKitImmersivePlayback/Extensions/VideoModel+Library.swift:8

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

RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift:11 — representative type boundary

@main
struct RealityKitImmersivePlaybackApp: App {
    @Environment(\.openWindow) private var openWindow
    // ...
}
Type Responsibility Depends on or conforms to
RealityKitImmersivePlaybackApp Application entry and top-level composition App
AppModel Feature data or observable state Concrete collaborators/imported frameworks
PlaybackScene Scene lifecycle or scene-level composition Equatable
VideoModel Feature data or observable state Hashable, Identifiable
PlayerModel Feature data or observable state Concrete collaborators/imported frameworks
ContentView User-interface presentation and input forwarding View
ImmersiveControlsView User-interface presentation and input forwarding View
TransportView User-interface presentation and input forwarding View
VideoPlayerView User-interface presentation and input forwarding View
ImmersiveSpaceState Represents mutable feature state Concrete collaborators/imported frameworks

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

Access control

Symbol Access Verified effect Likely rationale
displayMessage (RealityKitImmersivePlayback/Extensions/VideoPlayerComponent+Extensions.swift:17) public The symbol is visible to importing modules. Inference: make the declaration available across a module or target boundary.
pendingStage (RealityKitImmersivePlayback/Models/AppModel.swift:22) private(set) Read access follows the declaration; writes remain in the private scope. Inference: allow observation while reserving invariant-changing writes for the owner.
selectedVideo (RealityKitImmersivePlayback/Models/AppModel.swift:23) private(set) Read access follows the declaration; writes remain in the private scope. Inference: allow observation while reserving invariant-changing writes for the owner.
videoModes (RealityKitImmersivePlayback/Models/AppModel.swift:24) private(set) Read access follows the declaration; writes remain in the private scope. Inference: allow observation while reserving invariant-changing writes for the owner.

Reference code

RealityKitImmersivePlayback/Extensions/VideoPlayerComponent+Extensions.swift:17 — representative boundary

    public var displayMessage: String? {
        // ...
        case .play:
        // ...
    }

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

Logic Owning type or file Placement rationale
Application entry and top-level composition RealityKitImmersivePlaybackApp The source’s App suffix makes this role explicit.
Feature data or observable state AppModel, PlayerModel, VideoModel The source’s Model suffix makes this role explicit.
Scene lifecycle or scene-level composition PlaybackScene The source’s Scene suffix makes this role explicit.
User-interface presentation and input forwarding ContentView, ImmersiveControlsView, TransportView, VideoPlayerView The source’s View suffix makes this role explicit.

Design patterns

Pattern Source evidence Purpose or tradeoff
No named application pattern RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift:10 The verified source directly composes concrete framework types; this document avoids forcing a pattern name.

Naming conventions

  • Types: App: RealityKitImmersivePlaybackApp; Model: AppModel, PlayerModel, VideoModel; Scene: PlaybackScene; View: ContentView, ImmersiveControlsView, TransportView, VideoPlayerView.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: closeImmersivePlayer, makeDefaultScenes, openImmersivePlayer, transitionStageFromBrowsingToPlayback, transitionStageFromPlaybackToBrowsing, transitionPlaybackStages, transitionStage, commitStage.
  • Files: RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift, RealityKitImmersivePlayback/Models/AppModel.swift, RealityKitImmersivePlayback/Models/VideoModel.swift, RealityKitImmersivePlayback/Models/PlayerModel.swift, RealityKitImmersivePlayback/Views/ContentView.swift, RealityKitImmersivePlayback/Views/ImmersiveControlsView.swift.

Architecture takeaways

  • RealityKitImmersivePlaybackApp is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches SwiftUI, RealityKit, AVFoundation 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

Source file Relevant symbols
RealityKitImmersivePlayback/RealityKitImmersivePlaybackApp.swift Cited implementation, RealityKitImmersivePlaybackApp, SwiftUI state property wrapper
RealityKitImmersivePlayback/Extensions/VideoPlayerComponent+Extensions.swift Cited implementation, Feature implementation
RealityKitImmersivePlayback/Models/AppModel.swift Cited implementation, @MainActor, @Observable, AppModel, ImmersiveSpaceState, WindowState, PlaybackScene, Stage
RealityKitImmersivePlayback/Models/PlayerModel.swift Task closure isolated to MainActor, Task, await suspension point, NotificationCenter, PlayerModel
RealityKitImmersivePlayback/Extensions/VideoModel+Library.swift SwiftUI, Foundation, Feature implementation
RealityKitImmersivePlayback/Extensions/Entity+Extensions.swift RealityKit, Feature implementation
RealityKitImmersivePlayback/Extensions/AVPlayer+Extensions.swift AVFoundation, Feature implementation
RealityKitImmersivePlayback/Models/VideoModel.swift VideoModel, ContentType, Mode
RealityKitImmersivePlayback/Views/ContentView.swift ContentView
RealityKitImmersivePlayback/Views/ImmersiveControlsView.swift ImmersiveControlsView
RealityKitImmersivePlayback/Views/LoadingIndicator.swift LoadingIndicator, LoadingIndicatorOverlay, LoadingIndicatorSpatialOverlay, LoadingIndicatorSceneOverlayModifier
RealityKitImmersivePlayback/Views/TransportView.swift TransportView
RealityKitImmersivePlayback/Views/VideoPlayerView.swift VideoPlayerView
RealityKitImmersivePlayback/Scenes/PlayerImmersiveSpace.swift PlayerImmersiveSpace, ProgressivePlayerImmersiveSpace, SpatialPlayerImmersiveSpace
RealityKitImmersivePlayback/Models/PlaybackReadiness.swift PlaybackReadiness
RealityKitImmersivePlayback/Models/VideoModes.swift VideoModes