Explore more content with MusicKit
At a glance
| Item | Summary |
|---|---|
| Purpose | Track your outdoor runs with access to the Apple Music catalog, personal recommendations, and your own personal music library. |
| App architecture | A Swift sample with the source-visible chain MusicMarathonApp → ContentView → LibrarySearchViewModel → MarathonMusicPlayer → MusicKit APIs. |
| Main patterns | Model-View-ViewModel, Delegate or data-source callbacks, Coordinator, Builder, Binding-based state propagation, Publisher-backed observable state |
| Project style | 43 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: Task, await suspension point, @MainActor; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: SwiftUI state property wrapper, ObservableObject, @Published. |
| Key frameworks/packages | SwiftUI, MusicKit, Combine, MapKit, CoreLocation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
└── MusicMarathon/
├── MusicMarathonApp.swift
├── Home/
│ ├── RecentlyPlayedViewModel.swift
│ ├── WelcomeView.swift
│ └── ContentView.swift
├── Music/
│ ├── Library/
│ │ └── LibrarySearchViewModel.swift
│ ├── Search/
│ │ └── SearchViewModel.swift
│ └── Detail Views/
│ ├── AdditionalContentView.swift
│ ├── AlbumDetailView.swift
│ ├── ArtistDetailView.swift
│ ├── CuratorDetailView.swift
│ └── PlaylistDetailView.swift
└── Workout/
└── WorkoutViewModel.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 3 project/configuration file(s) and 47 source declaration(s).
Overall architecture
flowchart LR
N1["MusicMarathonApp"]
N2["ContentView"]
N3["LibrarySearchViewModel"]
N4["MarathonMusicPlayer"]
N5["MusicKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
MusicMarathon/MusicMarathonApp.swift:10 — architecture anchor
@main
struct MusicMarathonApp: App {
// ...
WindowGroup {
ContentView()
}
// ...
}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 MusicKit.
Ownership and state
classDiagram
RecentlyPlayedViewModel o-- MusicItemCollection : recentlyPlayedItems
RecentlyPlayedViewModel o-- AnyCancellable : musicAuthorizationStatusObserver
WelcomeView o-- Status : musicAuthorizationStatus
PresentationCoordinator *-- PresentationCoordinator : shared
Ownership evidence
MusicMarathon/Home/RecentlyPlayedViewModel.swift:19 — stored dependency or nearest verified ownership anchor
class RecentlyPlayedViewModel: ObservableObject {
// ...
@Published var recentlyPlayedItems: MusicItemCollection<RecentlyPlayedMusicItem> = []
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
RecentlyPlayedViewModel |
MusicItemCollection (recentlyPlayedItems) |
stores or receives | App/module collaborators |
RecentlyPlayedViewModel |
AnyCancellable (musicAuthorizationStatusObserver) |
stores or receives | Owning lexical scope |
WelcomeView |
Status (musicAuthorizationStatus) |
borrows mutable state | The upstream binding owner is authoritative |
PresentationCoordinator |
PresentationCoordinator (shared) |
creates and retains | 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 |
|---|---|---|---|
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:39 |
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:42 |
| Main isolation | @MainActor |
The cited annotation marks its attached declaration or closure as main-actor isolated. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:51 |
@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
MusicMarathon/Home/RecentlyPlayedViewModel.swift:39 — representative execution boundary
Task {
// ...
let recentlyPlayedRequest = MusicRecentlyPlayedContainerRequest()
// ...
}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. | MusicMarathon/Home/ContentView.swift:14 |
| State propagation | ObservableObject |
ObservableObject supplies an observation contract. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:14 |
| State propagation | @Published |
A published property can emit owner-controlled changes. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:19 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | MusicMarathon/Home/ContentView.swift:8 |
| Source import | MusicKit |
The cited file imports this module; runtime use and architectural role are not inferred. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:9 |
| Source import | Combine |
The cited file imports this module; runtime use and architectural role are not inferred. | MusicMarathon/Home/RecentlyPlayedViewModel.swift:8 |
| Source import | MapKit |
The cited file imports this module; runtime use and architectural role are not inferred. | MusicMarathon/Workout/Map/MapView.swift:9 |
| Source import | CoreLocation |
The cited file imports this module; runtime use and architectural role are not inferred. | MusicMarathon/Workout/Map/MapView.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
MusicMarathon/MusicMarathonApp.swift:11 — representative type boundary
@main
struct MusicMarathonApp: App {
// ...
ContentView()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
MusicMarathonApp |
Application entry and top-level composition | App |
RecentlyPlayedViewModel |
UI-facing state and feature coordination | ObservableObject |
WelcomeView |
User-interface presentation and input forwarding | View |
PresentationCoordinator |
Cross-object flow or session coordination | ObservableObject |
LibrarySearchViewModel |
UI-facing state and feature coordination | ObservableObject |
SearchViewModel |
UI-facing state and feature coordination | ObservableObject |
WorkoutViewModel |
UI-facing state and feature coordination | NSObject, ObservableObject, CLLocationManagerDelegate |
ContentView |
User-interface presentation and input forwarding | View |
AdditionalContentView |
User-interface presentation and input forwarding | Concrete collaborators/imported frameworks |
AlbumDetailView |
User-interface presentation and input forwarding | View |
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 |
|---|---|---|---|
recentlyPlayedViewModel (MusicMarathon/Home/ContentView.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. |
historyView (MusicMarathon/Home/ContentView.swift:49) |
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. |
startWorkoutView (MusicMarathon/Home/ContentView.swift:78) |
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. |
recentlyPlayedView (MusicMarathon/Home/ContentView.swift:86) |
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
MusicMarathon/Home/ContentView.swift:14 — representative boundary
struct ContentView: View {
// ...
@StateObject private var recentlyPlayedViewModel = RecentlyPlayedViewModel()
// ...
}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 | MusicMarathonApp |
The source’s App suffix makes this role explicit. |
| Incrementally constructs a framework value or graph | ShadowBuilder |
The source’s Builder suffix makes this role explicit. |
| Cross-object flow or session coordination | PresentationCoordinator |
The source’s Coordinator suffix makes this role explicit. |
| Owns media or timeline playback | MarathonMusicPlayer, MiniPlayer |
The source’s Player suffix makes this role explicit. |
| User-interface presentation and input forwarding | AdditionalContentView, AlbumDetailView, ArtistDetailView, ContentView |
The source’s View suffix makes this role explicit. |
| UI-facing state and feature coordination | LibrarySearchViewModel, RecentlyPlayedViewModel, SearchViewModel, WorkoutViewModel |
The source’s ViewModel suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Model-View-ViewModel | MusicMarathon/Music/Library/LibrarySearchViewModel.swift:13 |
Role-named view models keep UI-facing state or coordination outside view declarations. |
| Delegate or data-source callbacks | MusicMarathon/Workout/WorkoutViewModel.swift:13 |
Callback protocols invert event delivery back into the sample’s owner. |
| Coordinator | MusicMarathon/Home/WelcomeView.swift:164 |
A role-named coordinator centralizes cross-object flow. |
| Builder | MusicMarathon/Music/Helpers/ShadowBuilder.swift:11 |
A builder-named type owns incremental construction. |
| Binding-based state propagation | MusicMarathon/Home/WelcomeView.swift:22 |
A binding exposes controlled read/write access while the upstream owner remains authoritative. |
| Publisher-backed observable state | MusicMarathon/Home/RecentlyPlayedViewModel.swift:19 |
Published properties notify observers while mutation remains with the state object. |
Naming conventions
- Types: App: MusicMarathonApp; Builder: ShadowBuilder; Coordinator: PresentationCoordinator; Player: MarathonMusicPlayer, MiniPlayer; View: AdditionalContentView, AlbumDetailView, ArtistDetailView, ContentView, CuratorDetailView; ViewModel: LibrarySearchViewModel, RecentlyPlayedViewModel, SearchViewModel, WorkoutViewModel.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
beginObservingMusicAuthorizationStatus,loadRecentlyPlayedItems,updateRecentlyPlayedItems,handleButtonPressed,update,body,welcomeSheet,librarySearch. - Files:
MusicMarathon/MusicMarathonApp.swift,MusicMarathon/Home/RecentlyPlayedViewModel.swift,MusicMarathon/Home/WelcomeView.swift,MusicMarathon/Music/Library/LibrarySearchViewModel.swift,MusicMarathon/Music/Search/SearchViewModel.swift,MusicMarathon/Workout/WorkoutViewModel.swift.
Architecture takeaways
MusicMarathonAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, MusicKit, MapKit, CoreLocation 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 |
|---|---|
MusicMarathon/MusicMarathonApp.swift |
Cited implementation, MusicMarathonApp |
MusicMarathon/Home/RecentlyPlayedViewModel.swift |
Cited implementation, Task, await suspension point, @MainActor, ObservableObject, @Published, MusicKit, Combine, RecentlyPlayedViewModel |
MusicMarathon/Home/ContentView.swift |
Cited implementation, SwiftUI state property wrapper, SwiftUI, ContentView |
MusicMarathon/Music/Library/LibrarySearchViewModel.swift |
LibrarySearchViewModel |
MusicMarathon/Workout/WorkoutViewModel.swift |
Cited implementation, WorkoutViewModel |
MusicMarathon/Home/WelcomeView.swift |
PresentationCoordinator, Cited implementation, WelcomeView, SheetPresentationModifier, WelcomeView_Previews |
MusicMarathon/Music/Helpers/ShadowBuilder.swift |
ShadowBuilder |
MusicMarathon/Workout/Map/MapView.swift |
MapKit, CoreLocation, MapView |
MusicMarathon/Music/Search/SearchViewModel.swift |
SearchViewModel |
MusicMarathon/Music/Detail Views/AdditionalContentView.swift |
AdditionalContentView |
MusicMarathon/Music/Detail Views/AlbumDetailView.swift |
AlbumDetailView |
MusicMarathon/Music/Detail Views/ArtistDetailView.swift |
ArtistDetailView |
MusicMarathon/Music/Detail Views/CuratorDetailView.swift |
CuratorDetailView |
MusicMarathon/Music/Detail Views/PlaylistDetailView.swift |
PlaylistDetailView |
MusicMarathon/Music/Detail Views/RadioShowDetailView.swift |
RadioShowDetailView |
MusicMarathon/Music/Library/LibraryView.swift |
LibraryView |