Creating a custom speech synthesizer
At a glance
| Item | Summary |
|---|---|
| Purpose | Use your custom voices to synthesize speech by building a speech synthesis provider. |
| App architecture | A Swift sample with the source-visible chain CustomSpeechSynthesizerExampleApp → ContentView → AVFoundation / SwiftUI APIs. |
| Main patterns | Factory |
| Project style | 4 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | No structured execution marker indexed; callback threading requires source review. |
| State/event model | Source-visible mechanisms: SwiftUI state property wrapper. |
| Key frameworks/packages | AVFoundation, SwiftUI, CoreAudioKit; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── CustomSpeechSynthesizerExample/
│ ├── CustomSpeechSynthesizerExampleApp.swift
│ ├── ContentView.swift
│ └── CustomSpeechSynthesizerExample.entitlements
├── CustomSpeechSynthesizerExampleExtension/
│ ├── AudioUnitFactory.swift
│ ├── CustomSpeechSynthesizerExampleAudioUnit.swift
│ ├── CustomSpeechSynthesizerExampleExtension.entitlements
│ └── Info.plist
├── Configuration/
│ └── SampleCode.xcconfig
└── CustomSpeechSynthesizerExample.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 4 source declaration(s).
Overall architecture
flowchart LR
N1["CustomSpeechSynthesizerExampleApp"]
N2["ContentView"]
N3["AVFoundation / SwiftUI APIs"]
N1 --> N2
N2 --> N3
Reference code
CustomSpeechSynthesizerExample/CustomSpeechSynthesizerExampleApp.swift:10 — architecture anchor
@main
struct CustomSpeechSynthesizerExampleApp: App {
var body: some Scene {
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 AVFAudio.
Ownership and state
classDiagram
ContentView *-- UserDefaults : groupDefaults
ContentView *-- Array : voices
ContentView *-- String : voiceName
AudioUnitFactory o-- AUAudioUnit : audioUnit
Ownership evidence
CustomSpeechSynthesizerExample/ContentView.swift:15 — stored dependency or nearest verified ownership anchor
struct ContentView: View {
// ...
let groupDefaults = UserDefaults(suiteName: "group.com.example.apple.samplecode.CustomSpeechSynthesizerExample")
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
ContentView |
UserDefaults (groupDefaults) |
creates and retains | Initialized by the owner; the binding is immutable |
ContentView |
Array (voices) |
owns wrapper-managed state | App/module collaborators |
ContentView |
String (voiceName) |
owns wrapper-managed state | App/module collaborators |
AudioUnitFactory |
AUAudioUnit (audioUnit) |
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.
No source-visible execution, scheduling, or synchronization boundary was found in the indexed source.
@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.
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. | CustomSpeechSynthesizerExample/ContentView.swift:17 |
| Source import | AVFoundation |
The cited file imports this module; runtime use and architectural role are not inferred. | CustomSpeechSynthesizerExample/ContentView.swift:8 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | CustomSpeechSynthesizerExample/ContentView.swift:9 |
| Source import | CoreAudioKit |
The cited file imports this module; runtime use and architectural role are not inferred. | CustomSpeechSynthesizerExampleExtension/AudioUnitFactory.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
CustomSpeechSynthesizerExample/CustomSpeechSynthesizerExampleApp.swift:11 — representative type boundary
@main
struct CustomSpeechSynthesizerExampleApp: App {
// ...
ContentView()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
CustomSpeechSynthesizerExampleApp |
Application entry and top-level composition | App |
ContentView |
User-interface presentation and input forwarding | View |
AudioUnitFactory |
Constructs a selected implementation | NSObject, AUAudioUnitFactory |
CustomSpeechSynthesizerExampleAudioUnit |
Owns feature behavior and collaborator lifecycle | AVSpeechSynthesisProviderAudioUnit |
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 |
|---|---|---|---|
saveVoicesToGroupDefaults (CustomSpeechSynthesizerExample/ContentView.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. |
beginRequest (CustomSpeechSynthesizerExampleExtension/AudioUnitFactory.swift:14) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
createAudioUnit (CustomSpeechSynthesizerExampleExtension/AudioUnitFactory.swift:19) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
groupDefaults (CustomSpeechSynthesizerExampleExtension/CustomSpeechSynthesizerExampleAudioUnit.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. |
Reference code
CustomSpeechSynthesizerExample/ContentView.swift:55 — representative boundary
private func saveVoicesToGroupDefaults() {
// ...
groupDefaults?.set(voices, forKey: "voices")
// ...
}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 | CustomSpeechSynthesizerExampleApp |
The source’s App suffix makes this role explicit. |
| Constructs a selected implementation | AudioUnitFactory |
The source’s Factory suffix makes this role explicit. |
| User-interface presentation and input forwarding | ContentView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Factory | CustomSpeechSynthesizerExampleExtension/AudioUnitFactory.swift:10 |
A factory-named type owns implementation construction. |
Naming conventions
- Types: App: CustomSpeechSynthesizerExampleApp; Factory: AudioUnitFactory; View: ContentView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
saveVoicesToGroupDefaults,beginRequest,createAudioUnit,allocateRenderResources,synthesizeSpeechRequest,cancelSpeechRequest,getAudioBufferForSSML. - Files:
CustomSpeechSynthesizerExample/CustomSpeechSynthesizerExampleApp.swift,CustomSpeechSynthesizerExample/ContentView.swift,CustomSpeechSynthesizerExampleExtension/AudioUnitFactory.swift,CustomSpeechSynthesizerExampleExtension/CustomSpeechSynthesizerExampleAudioUnit.swift.
Architecture takeaways
CustomSpeechSynthesizerExampleAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches AVFoundation, SwiftUI, CoreAudioKit 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 |
|---|---|
CustomSpeechSynthesizerExample/CustomSpeechSynthesizerExampleApp.swift |
Cited implementation, CustomSpeechSynthesizerExampleApp |
CustomSpeechSynthesizerExample/ContentView.swift |
Cited implementation, SwiftUI state property wrapper, AVFoundation, SwiftUI, ContentView, ContentView_Previews |
CustomSpeechSynthesizerExampleExtension/AudioUnitFactory.swift |
Cited implementation, AudioUnitFactory, CoreAudioKit |
CustomSpeechSynthesizerExampleExtension/CustomSpeechSynthesizerExampleAudioUnit.swift |
Cited implementation, CustomSpeechSynthesizerExampleAudioUnit |