Implementing SharePlay for immersive spaces in visionOS
At a glance
| Item | Summary |
|---|---|
| Purpose | Enable collaborative spatial experiences by using SharePlay to synchronize 3D content among participants. |
| App architecture | A Swift sample with the source-visible chain SharePlayCubeApp → CubeImmersiveView → AppModel → GroupActivities / SwiftUI APIs. |
| Main patterns | View-controller organization |
| Project style | 7 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: @MainActor, Task, await suspension point, Sendable or @Sendable; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: @Observable, SwiftUI state property wrapper. |
| Key frameworks/packages | GroupActivities, SwiftUI, Combine, CoreTransferable, Observation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── GroupActivities-SharePlayCube/
│ ├── SharePlayCubeApp.swift
│ ├── Models/
│ │ ├── AppModel.swift
│ │ ├── SessionController.swift
│ │ ├── CubeActivityMessagingTypes.swift
│ │ └── ChangeColorActivity.swift
│ ├── Views/
│ │ ├── CubeImmersiveView.swift
│ │ └── SharePlayAttachmentView.swift
│ ├── Info.plist
│ └── SharePlayCubeApp.entitlements
├── Configuration/
│ └── SampleCode.xcconfig
└── GroupActivities-SharePlayCube.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 5 project/configuration file(s) and 9 source declaration(s).
Overall architecture
flowchart LR
N1["SharePlayCubeApp"]
N2["CubeImmersiveView"]
N3["AppModel"]
N4["GroupActivities / SwiftUI APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
GroupActivities-SharePlayCube/SharePlayCubeApp.swift:11 — architecture anchor
@main
struct SharePlayCubeApp: App {
@State private var appModel = AppModel()
var body: some Scene {
ImmersiveSpace {
CubeImmersiveView()
.environment(appModel)
}
.immersionStyle(selection: .constant(.mixed), in: .mixed)
.immersiveEnvironmentBehavior(.coexist)
}
}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
classDiagram
SharePlayCubeApp *-- AppModel : appModel
AppModel o-- SessionController : sessionController
AppModel o-- CubeColor : color
SessionController o-- GroupSession : session
Ownership evidence
GroupActivities-SharePlayCube/SharePlayCubeApp.swift:13 — stored dependency or nearest verified ownership anchor
@main
struct SharePlayCubeApp: App {
@State private var appModel = AppModel()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
SharePlayCubeApp |
AppModel (appModel) |
owns wrapper-managed state | Owning lexical scope |
AppModel |
SessionController (sessionController) |
stores or receives | Owning lexical scope |
AppModel |
CubeColor (color) |
stores or receives | Owning type writes; wider scope can read |
SessionController |
GroupSession (session) |
stores or receives | Initialized by the owner; the binding is immutable |
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. | GroupActivities-SharePlayCube/Models/AppModel.swift:15 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | GroupActivities-SharePlayCube/Models/AppModel.swift:31 |
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | GroupActivities-SharePlayCube/Models/AppModel.swift:32 |
| Transfer contract | Sendable or @Sendable |
The source declares a sendability boundary; this alone does not synchronize mutable state. | GroupActivities-SharePlayCube/Models/CubeActivityMessagingTypes.swift:12 |
@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
GroupActivities-SharePlayCube/Models/AppModel.swift:15 — representative execution boundary
@MainActor
@Observable
final class AppModel {
// ...
private var sessionController: SessionController?
// ...
}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. | GroupActivities-SharePlayCube/Models/AppModel.swift:16 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | GroupActivities-SharePlayCube/SharePlayCubeApp.swift:13 |
| Source import | GroupActivities |
The cited file imports this module; runtime use and architectural role are not inferred. | GroupActivities-SharePlayCube/Models/AppModel.swift:9 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | GroupActivities-SharePlayCube/Models/AppModel.swift:10 |
| Source import | Combine |
The cited file imports this module; runtime use and architectural role are not inferred. | GroupActivities-SharePlayCube/Models/AppModel.swift:8 |
| Source import | CoreTransferable |
The cited file imports this module; runtime use and architectural role are not inferred. | GroupActivities-SharePlayCube/Models/ChangeColorActivity.swift:8 |
| Source import | Observation |
The cited file imports this module; runtime use and architectural role are not inferred. | GroupActivities-SharePlayCube/Models/SessionController.swift:9 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | GroupActivities-SharePlayCube/Views/CubeImmersiveView.swift:9 |
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
GroupActivities-SharePlayCube/SharePlayCubeApp.swift:12 — representative type boundary
@main
struct SharePlayCubeApp: App {
@State private var appModel = AppModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
SharePlayCubeApp |
Application entry and top-level composition | App |
AppModel |
Feature data or observable state | Concrete collaborators/imported frameworks |
SessionController |
View lifecycle, callbacks, and feature coordination | Concrete collaborators/imported frameworks |
CubeImmersiveView |
User-interface presentation and input forwarding | View |
SharePlayAttachmentView |
User-interface presentation and input forwarding | View |
UpdateColorMessage |
Represents a feature value or composable behavior | Codable, Sendable |
MessageUpdateCount |
Represents a feature value or composable behavior | Codable, Hashable, Comparable |
CubeColor |
Defines a closed set of feature states or choices | String, CaseIterable, Codable |
ChangeColorActivity |
Represents a feature value or composable behavior | GroupActivity, Transferable |
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 |
|---|---|---|---|
sessionController (GroupActivities-SharePlayCube/Models/AppModel.swift:19) |
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. |
color (GroupActivities-SharePlayCube/Models/AppModel.swift:27) |
private(set) |
Read access follows the declaration; writes remain in the private scope. | Inference: allow observation while reserving invariant-changing writes for the owner. |
observeGroupSessions (GroupActivities-SharePlayCube/Models/AppModel.swift:55) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: hide an implementation step that is not part of the collaboration surface. |
messenger (GroupActivities-SharePlayCube/Models/SessionController.swift:23) |
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
GroupActivities-SharePlayCube/Models/AppModel.swift:19 — representative boundary
@MainActor
@Observable
final class AppModel {
// ...
private var sessionController: SessionController?
// ...
}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 | SharePlayCubeApp |
The source’s App suffix makes this role explicit. |
| View lifecycle, callbacks, and feature coordination | SessionController |
The source’s Controller 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 | CubeImmersiveView, SharePlayAttachmentView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | GroupActivities-SharePlayCube/Models/SessionController.swift:15 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
Naming conventions
- Types: App: SharePlayCubeApp; Controller: SessionController; Model: AppModel; View: CubeImmersiveView, SharePlayAttachmentView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
endSession,setColor,observeGroupSessions,observeUpdateColorMessages,syncColorChange,observeActiveRemoteParticipants,changeColor,setUpRootEntity. - Files:
GroupActivities-SharePlayCube/SharePlayCubeApp.swift,GroupActivities-SharePlayCube/Models/AppModel.swift,GroupActivities-SharePlayCube/Models/SessionController.swift,GroupActivities-SharePlayCube/Views/CubeImmersiveView.swift,GroupActivities-SharePlayCube/Views/SharePlayAttachmentView.swift,GroupActivities-SharePlayCube/Models/ChangeColorActivity.swift.
Architecture takeaways
SharePlayCubeAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches GroupActivities, SwiftUI, CoreTransferable, RealityKit 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 |
|---|---|
GroupActivities-SharePlayCube/SharePlayCubeApp.swift |
Cited implementation, SharePlayCubeApp, SwiftUI state property wrapper |
GroupActivities-SharePlayCube/Models/AppModel.swift |
Cited implementation, @MainActor, Task, await suspension point, @Observable, GroupActivities, SwiftUI, Combine, AppModel |
GroupActivities-SharePlayCube/Models/SessionController.swift |
Cited implementation, SessionController, Observation |
GroupActivities-SharePlayCube/Models/CubeActivityMessagingTypes.swift |
Sendable or @Sendable, UpdateColorMessage, MessageUpdateCount, CubeColor |
GroupActivities-SharePlayCube/Models/ChangeColorActivity.swift |
CoreTransferable, ChangeColorActivity |
GroupActivities-SharePlayCube/Views/CubeImmersiveView.swift |
RealityKit, CubeImmersiveView |
GroupActivities-SharePlayCube/Views/SharePlayAttachmentView.swift |
SharePlayAttachmentView |