SpeechError Enumeration Reference


                    
                    
                    apiError(instruction:options:underlying:)

An error occurred when requesting speech assets from a server API.

Swift

case apiError(instruction: SpokenInstruction, options: SpeechOptions, underlying: Error?)

`instruction`	the instruction that failed.
`options`	the SpeechOptions that were used to make the API request.
`underlying`	the underlying `Error` returned by the API.


                    
                    
                    noData(instruction:options:)

The speech engine did not fail with the error itself, but did not provide actual data to vocalize.

Swift

case noData(instruction: SpokenInstruction, options: SpeechOptions)

`instruction`	the instruction that failed.
`options`	the SpeechOptions that were used to make the API request.


                    
                    
                    unableToControlAudio(instruction:action:underlying:)

The speech engine was unable to perform an action on the system audio service.

Swift

case unableToControlAudio(instruction: SpokenInstruction?, action: SpeechFailureAction, underlying: Error?)

`instruction`	The instruction that failed.
`action`	a `SpeechFailureAction` that describes the action attempted
`underlying`	the `Error` that was optrionally returned by the audio service.


                    
                    
                    unableToInitializePlayer(playerType:instruction:synthesizer:underlying:)

The speech engine was unable to initalize an audio player.

Swift

case unableToInitializePlayer(playerType: AVAudioPlayer.Type, instruction: SpokenInstruction, synthesizer: Any?, underlying: Error)

`playerType`	the type of `AVAudioPlayer` that failed to initalize.
`instruction`	The instruction that failed.
`synthesizer`	The speech engine that attempted the initalization.
`underlying`	the `Error` that was returned by the system audio service.


                    
                    
                    undefinedSpeechLocale(instruction:)

There was no Locale provided during processing instruction.

Swift

case undefinedSpeechLocale(instruction: SpokenInstruction)


                                  instruction

The instruction that failed.


                    
                    
                    unsupportedLocale(locale:)

The speech engine does not support provided locale

Swift

case unsupportedLocale(locale: Locale)


                                  locale

Offending locale