Managing Audio with SiriKit
At a glance
| Item | Summary |
|---|---|
| Purpose | Control audio playback and handle requests to add media using SiriKit Media Intents. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → AppleMusicAPIController → IntentHandler → Intents APIs. |
| Main patterns | View-controller organization, Delegate or data-source callbacks |
| Project style | 7 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue.global.async, DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: NotificationCenter. |
| Key frameworks/packages | MediaPlayer, Foundation, os, UIKit, Intents; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ControlAudio/
│ ├── ControlAudio/
│ │ ├── AppDelegate.swift
│ │ ├── SceneDelegate.swift
│ │ ├── ViewController.swift
│ │ ├── AppIntentVocabulary.plist
│ │ └── Base.lproj/
│ │ └── LaunchScreen.storyboard
│ ├── ControlAudioShared/
│ │ ├── AppleMusicAPIController.swift
│ │ ├── AppleMusicAPIStructures.swift
│ │ └── MediaPlayerUtilities.swift
│ ├── ControlAudioExtension/
│ │ └── IntentHandler.swift
│ └── ControlAudio.xcodeproj/
│ ├── .xcodesamplecode.plist
│ └── project.pbxproj
└── Configuration/
└── SampleCode.xcconfig
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 10 project/configuration file(s) and 47 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["AppleMusicAPIController"]
N3["IntentHandler"]
N4["Intents APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
ControlAudio/ControlAudio/AppDelegate.swift:13 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}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 Intents.
Ownership and state
classDiagram
AppDelegate o-- UIWindow : window
AppDelegate o-- AppleMusicAPIController : appleMusicAPIController
AppleMusicAPIController *-- String : storefront
AppleMusicAPIController *-- String : userToken
Ownership evidence
ControlAudio/ControlAudio/AppDelegate.swift:16 — stored dependency or nearest verified ownership anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
AppDelegate |
AppleMusicAPIController (appleMusicAPIController) |
stores or receives | App/module collaborators |
AppleMusicAPIController |
String (storefront) |
owns value state | Owning lexical scope |
AppleMusicAPIController |
String (userToken) |
owns value state | 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 |
|---|---|---|---|
| Queue scheduling | DispatchQueue.global.async |
The source addresses a global dispatch queue; no stable thread identity is implied. | ControlAudio/ControlAudio/AppDelegate.swift:30 |
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | ControlAudio/ControlAudio/AppDelegate.swift:44 |
@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
ControlAudio/ControlAudio/AppDelegate.swift:30 — representative execution boundary
DispatchQueue.global(qos: .userInitiated).async {
let context = INMediaUserContext()
// ...
}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 | NotificationCenter |
NotificationCenter distributes named process-local events. | ControlAudio/ControlAudio/ViewController.swift:27 |
| Source import | MediaPlayer |
The cited file imports this module; runtime use and architectural role are not inferred. | ControlAudio/ControlAudio/AppDelegate.swift:10 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | ControlAudio/ControlAudioShared/AppleMusicAPIController.swift:8 |
| Source import | os |
The cited file imports this module; runtime use and architectural role are not inferred. | ControlAudio/ControlAudio/AppDelegate.swift:7 |
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ControlAudio/ControlAudio/AppDelegate.swift:8 |
| Source import | Intents |
The cited file imports this module; runtime use and architectural role are not inferred. | ControlAudio/ControlAudio/AppDelegate.swift:9 |
| Source import | CoreSpotlight |
The cited file imports this module; runtime use and architectural role are not inferred. | ControlAudio/ControlAudio/AppDelegate.swift:11 |
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
ControlAudio/ControlAudio/AppDelegate.swift:14 — representative type boundary
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
AppleMusicAPIController |
View lifecycle, callbacks, and feature coordination | Concrete collaborators/imported frameworks |
SceneDelegate |
Receives callback-driven events | UIResponder, UIWindowSceneDelegate |
ViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
IntentHandler |
Handles callbacks or feature events | INExtension, INPlayMediaIntentHandling, INAddMediaIntentHandling |
SearchType |
Defines a closed set of feature states or choices | String |
DateDecoder |
Owns feature behavior and collaborator lifecycle | Concrete collaborators/imported frameworks |
Storefront |
Represents a feature value or composable behavior | Codable |
StorefrontAttributes |
Represents a feature value or composable behavior | Codable |
StorefrontResponse |
Represents the result of an operation | Codable |
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 |
|---|---|---|---|
playPauseButton (ControlAudio/ControlAudio/ViewController.swift:12) |
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. |
skipBackwardsButton (ControlAudio/ControlAudio/ViewController.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. |
skipForwardsButton (ControlAudio/ControlAudio/ViewController.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. |
songName (ControlAudio/ControlAudio/ViewController.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
ControlAudio/ControlAudio/ViewController.swift:12 — representative boundary
class ViewController: UIViewController {
// ...
@IBOutlet private weak var playPauseButton: UIButton?
// ...
}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 | AppleMusicAPIController, ViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate, SceneDelegate |
The source’s Delegate suffix makes this role explicit. |
| Handles callbacks or feature events | IntentHandler |
The source’s Handler suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | ControlAudio/ControlAudioShared/AppleMusicAPIController.swift:11 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Delegate or data-source callbacks | ControlAudio/ControlAudio/AppDelegate.swift:14 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: AppleMusicAPIController, ViewController; Delegate: AppDelegate, SceneDelegate; Handler: IntentHandler.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
application,handlePlayMediaIntent,domainForType,fetchUIImageForIdentifier,sharedDefaults,retrieveSavedUserToken,saveUserToken,prepareForRequests. - Files:
ControlAudio/ControlAudio/AppDelegate.swift,ControlAudio/ControlAudioShared/AppleMusicAPIController.swift,ControlAudio/ControlAudio/SceneDelegate.swift,ControlAudio/ControlAudio/ViewController.swift,ControlAudio/ControlAudioExtension/IntentHandler.swift,ControlAudio/ControlAudioShared/MediaPlayerUtilities.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches MediaPlayer, UIKit, Intents, CoreSpotlight 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 |
|---|---|
ControlAudio/ControlAudio/AppDelegate.swift |
Cited implementation, AppDelegate, DispatchQueue.global.async, DispatchQueue.main.async, MediaPlayer, os, UIKit, Intents, CoreSpotlight |
ControlAudio/ControlAudio/ViewController.swift |
Cited implementation, NotificationCenter, ViewController |
ControlAudio/ControlAudioShared/AppleMusicAPIController.swift |
AppleMusicAPIController, Foundation, SearchType, DateDecoder |
ControlAudio/ControlAudioShared/AppleMusicAPIStructures.swift |
Storefront, CodingKeys, StorefrontAttributes, StorefrontResponse, Artist, ArtistAttributes, ArtistRelationship, ArtistRelationships, ArtistResponse, Album, AlbumAttributes, AlbumRelationship, AlbumRelationships, AlbumResponse, TrackRelationship, Artwork, EditorialNotes, PlayParameters, Genre, GenreAttributes, GenreRelationship, GenreResponse, Song, SongAttributes, SongRelationships, SongResponse, Station, StationAttributes, StationRelationship, StationResponse, Preview, Playlist, PlaylistAttributes, PlaylistRelationship, PlaylistRelationships, PlaylistResponse, Error, ErrorSource, SearchResponse, SearchResults |
ControlAudio/ControlAudio/SceneDelegate.swift |
SceneDelegate |
ControlAudio/ControlAudioExtension/IntentHandler.swift |
IntentHandler |
ControlAudio/ControlAudioShared/MediaPlayerUtilities.swift |
MediaPlayerUtilities, func |