Recording and Streaming Your macOS App
At a glance
| Item | Summary |
|---|---|
| Purpose | Share screen recordings, or broadcast live audio and video of your app, by adding ReplayKit to your macOS apps and games. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → ViewController → ReplayKit APIs. |
| Main patterns | Delegate or data-source callbacks |
| Project style | 2 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | Cocoa, Photos, ReplayKit; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ReplayKitSample/
│ ├── AppDelegate.swift
│ ├── ViewController.swift
│ ├── Base.lproj/
│ │ └── Main.storyboard
│ ├── Info.plist
│ └── ReplayKitSample.entitlements
├── Configuration/
│ └── SampleCode.xcconfig
└── ReplayKitSample.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 6 project/configuration file(s) and 2 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["ReplayKit APIs"]
N1 --> N2
N2 --> N3
Reference code
ReplayKitSample/AppDelegate.swift:10 — architecture anchor
@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
@IBOutlet var window: NSWindow!
}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 ReplayKit.
Ownership and state
classDiagram
AppDelegate o-- NSWindow : window
ViewController o-- NSButton : recordButton
ViewController o-- NSButton : captureButton
ViewController o-- NSButton : broadcastButton
Ownership evidence
ReplayKitSample/AppDelegate.swift:13 — stored dependency or nearest verified ownership anchor
@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
@IBOutlet var window: NSWindow!
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
NSWindow (window) |
stores or receives | App/module collaborators |
ViewController |
NSButton (recordButton) |
stores or receives | App/module collaborators |
ViewController |
NSButton (captureButton) |
stores or receives | App/module collaborators |
ViewController |
NSButton (broadcastButton) |
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 |
|---|---|---|---|
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | ReplayKitSample/ViewController.swift:43 |
@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
ReplayKitSample/ViewController.swift:43 — representative execution boundary
DispatchQueue.main.async {
// Set the buttons' enabled states.
self.recordButton.isEnabled = RPScreenRecorder.shared().isAvailable
self.captureButton.isEnabled = RPScreenRecorder.shared().isAvailable
self.broadcastButton.isEnabled = RPScreenRecorder.shared().isAvailable
self.clipButton.isEnabled = RPScreenRecorder.shared().isAvailable
}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 |
|---|---|---|---|
| Source import | Cocoa |
The cited file imports this module; runtime use and architectural role are not inferred. | ReplayKitSample/AppDelegate.swift:8 |
| Source import | Photos |
The cited file imports this module; runtime use and architectural role are not inferred. | ReplayKitSample/ViewController.swift:10 |
| Source import | ReplayKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ReplayKitSample/ViewController.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
ReplayKitSample/AppDelegate.swift:11 — representative type boundary
@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
@IBOutlet var window: NSWindow!
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | NSObject, NSApplicationDelegate |
ViewController |
View lifecycle, callbacks, and feature coordination | NSViewController |
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 |
|---|---|---|---|
isActive (ReplayKitSample/ViewController.swift:28) |
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. |
replayPreviewViewController (ReplayKitSample/ViewController.swift:29) |
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. |
activityController (ReplayKitSample/ViewController.swift:30) |
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. |
broadcastControl (ReplayKitSample/ViewController.swift:31) |
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
ReplayKitSample/ViewController.swift:28 — representative boundary
class ViewController: NSViewController,
RPScreenRecorderDelegate,
RPPreviewViewControllerDelegate,
RPBroadcastControllerDelegate,
RPBroadcastActivityControllerDelegate {
// ...
}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 |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | ViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Delegate or data-source callbacks | ReplayKitSample/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: ViewController; Delegate: AppDelegate.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
viewDidLoad,cameraButtonTapped,microphoneButtonTapped,setupCameraView,tearDownCameraView,recordButtonTapped,startRecording,stopRecording. - Files:
ReplayKitSample/AppDelegate.swift,ReplayKitSample/ViewController.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches Cocoa, Photos, ReplayKit 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 |
|---|---|
ReplayKitSample/AppDelegate.swift |
Cited implementation, AppDelegate, Cocoa |
ReplayKitSample/ViewController.swift |
Cited implementation, DispatchQueue.main.async, Photos, ReplayKit, ViewController |