Sample CodevisionOSReviewed 2026-07-21View on Apple Developer

Docking a video player in an immersive scene

At a glance

Item Summary
Purpose Secure a video player in an immersive scene with a docking region you can specify.
App architecture A Swift sample with the source-visible chain DockingAppAVPlayerViewAVPlayerViewModelRealityKit APIs.
Main patterns Model-View-ViewModel, Delegate or data-source callbacks
Project style 9 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: SwiftUI state property wrapper, @Observable.
Key frameworks/packages SwiftUI, RealityKit, AVKit, Foundation, PackageDescription; these are source dependencies, not architecture labels.

Project structure

Source bundle/
├── App/
│   ├── DockingApp.swift
│   └── Info.plist
├── Models/
│   ├── AVPlayerViewModel.swift
│   └── AppModel.swift
├── Views/
│   ├── AVPlayerView.swift
│   ├── ContentView.swift
│   ├── ImmersivePickerView.swift
│   └── ImmersiveView.swift
├── Packages/
│   └── RealityKitContent/
│       ├── Sources/
│       │   └── RealityKitContent/
│       │       └── RealityKitContent.swift
│       └── Package.swift
├── Configuration/
│   └── SampleCode.xcconfig
└── DockingSample.xcodeproj/
    └── .xcodesamplecode.plist

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 8 source declaration(s).

Overall architecture

Reference code

App/DockingApp.swift:10 — architecture anchor

@main
struct DockingApp: App {
    // ...
    @State private var appModel = AppModel()
    // ...
}

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

Ownership and state

Ownership evidence

App/DockingApp.swift:13 — stored dependency or nearest verified ownership anchor

@main
struct DockingApp: App {
    // ...
    @State private var appModel = AppModel()
    // ...
}
Owner Object or state Relationship Mutation authority
DockingApp AppModel (appModel) owns wrapper-managed state Owning lexical scope
DockingApp AVPlayerViewModel (avPlayerViewModel) owns wrapper-managed state Owning lexical scope
AVPlayerViewModel Bool (isPlaying) owns value state App/module collaborators
AVPlayerViewModel AVPlayerViewController (avPlayerViewController) stores or receives Owning lexical scope

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. Models/AVPlayerViewModel.swift:10
Main isolation Task closure isolated to MainActor The cited operation explicitly enters a main-actor-isolated region. Models/AVPlayerViewModel.swift:49
Task creation Task The source creates an unstructured task; surrounding context determines inherited actor isolation. Models/AVPlayerViewModel.swift:49
Suspension boundary await suspension point The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. Views/ImmersivePickerView.swift:23

@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

Models/AVPlayerViewModel.swift:10 — representative execution boundary

@MainActor
@Observable
class AVPlayerViewModel: NSObject {
    var isPlaying: Bool = false
    // ...
}

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 SwiftUI state property wrapper A SwiftUI property wrapper supplies or observes UI state. App/DockingApp.swift:13
State propagation @Observable Observation macro publishes source-visible changes. Models/AVPlayerViewModel.swift:11
Source import SwiftUI The cited file imports this module; runtime use and architectural role are not inferred. App/DockingApp.swift:8
Source import RealityKit The cited file imports this module; runtime use and architectural role are not inferred. Views/ContentView.swift:9
Source import AVKit The cited file imports this module; runtime use and architectural role are not inferred. Models/AVPlayerViewModel.swift:8
Source import Foundation The cited file imports this module; runtime use and architectural role are not inferred. Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift:8
Source import PackageDescription The cited file imports this module; runtime use and architectural role are not inferred. Packages/RealityKitContent/Package.swift:11
Source import RealityKitContent The cited file imports this module; runtime use and architectural role are not inferred. Views/ImmersiveView.swift:10

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

App/DockingApp.swift:11 — representative type boundary

@main
struct DockingApp: App {
    // ...
    @State private var appModel = AppModel()
    // ...
}
Type Responsibility Depends on or conforms to
DockingApp Application entry and top-level composition App
AVPlayerViewModel UI-facing state and feature coordination NSObject
AppModel Feature data or observable state Concrete collaborators/imported frameworks
AVPlayerView User-interface presentation and input forwarding UIViewControllerRepresentable
ContentView User-interface presentation and input forwarding View
ImmersivePickerView User-interface presentation and input forwarding View
ImmersiveView 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
appModel (App/DockingApp.swift:13) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
avPlayerViewModel (App/DockingApp.swift:14) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
avPlayerViewController (Models/AVPlayerViewModel.swift:14) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.
avPlayer (Models/AVPlayerViewModel.swift:15) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: keep state mutation or dependency lifetime inside the owning implementation.

Reference code

App/DockingApp.swift:13 — representative boundary

@main
struct DockingApp: App {
    // ...
    @State private var appModel = AppModel()
    // ...
}

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 DockingApp The source’s App suffix makes this role explicit.
Feature data or observable state AppModel The source’s Model suffix makes this role explicit.
User-interface presentation and input forwarding AVPlayerView, ContentView, ImmersivePickerView, ImmersiveView The source’s View suffix makes this role explicit.
UI-facing state and feature coordination AVPlayerViewModel The source’s ViewModel suffix makes this role explicit.

Design patterns

Pattern Source evidence Purpose or tradeoff
Model-View-ViewModel Models/AVPlayerViewModel.swift:12 Role-named view models keep UI-facing state or coordination outside view declarations.
Delegate or data-source callbacks Models/AVPlayerViewModel.swift:45 Callback protocols invert event delivery back into the sample’s owner.

Naming conventions

  • Types: App: DockingApp; Model: AppModel; View: AVPlayerView, ContentView, ImmersivePickerView, ImmersiveView; ViewModel: AVPlayerViewModel.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: makePlayerViewController, play, reset, playerViewController, makeUIViewController, updateUIViewController.
  • Files: App/DockingApp.swift, Models/AVPlayerViewModel.swift, Models/AppModel.swift, Views/AVPlayerView.swift, Views/ContentView.swift, Views/ImmersivePickerView.swift.

Architecture takeaways

  • DockingApp is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches SwiftUI, RealityKit, AVKit, PackageDescription 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
App/DockingApp.swift Cited implementation, DockingApp, SwiftUI state property wrapper, SwiftUI
Models/AVPlayerViewModel.swift Cited implementation, AVPlayerViewModel, @MainActor, Task closure isolated to MainActor, Task, @Observable, AVKit
Views/ImmersivePickerView.swift await suspension point, ImmersivePickerView
Views/ContentView.swift RealityKit, ContentView
Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift Foundation, Feature implementation
Packages/RealityKitContent/Package.swift PackageDescription, Feature implementation
Views/ImmersiveView.swift RealityKitContent, ImmersiveView
Models/AppModel.swift AppModel, ImmersiveSpaceState
Views/AVPlayerView.swift AVPlayerView