Install in Dash
SpeechError Enumeration Reference
SpeechError
public enum SpeechError : LocalizedErrorA error type returned when encountering errors in the speech engine.
-
An error occurred when requesting speech assets from a server API.
Declaration
Swift
case apiError(instruction: SpokenInstruction, options: SpeechOptions, underlying: Error?)Parameters
instructionthe instruction that failed.
optionsthe SpeechOptions that were used to make the API request.
underlyingthe underlying
Errorreturned by the API. -
The speech engine did not fail with the error itself, but did not provide actual data to vocalize.
Declaration
Swift
case noData(instruction: SpokenInstruction, options: SpeechOptions)Parameters
instructionthe instruction that failed.
optionsthe SpeechOptions that were used to make the API request.
-
The speech engine was unable to perform an action on the system audio service.
Declaration
Swift
case unableToControlAudio(instruction: SpokenInstruction?, action: SpeechFailureAction, underlying: Error?)Parameters
instructionThe instruction that failed.
actiona
SpeechFailureActionthat describes the action attemptedunderlyingthe
Errorthat was optrionally returned by the audio service. -
The speech engine was unable to initalize an audio player.
Declaration
Swift
case unableToInitializePlayer(playerType: AVAudioPlayer.Type, instruction: SpokenInstruction, synthesizer: Any?, underlying: Error)Parameters
playerTypethe type of
AVAudioPlayerthat failed to initalize.instructionThe instruction that failed.
synthesizerThe speech engine that attempted the initalization.
underlyingthe
Errorthat was returned by the system audio service. -
There was no
Localeprovided during processing instruction.Declaration
Swift
case undefinedSpeechLocale(instruction: SpokenInstruction)Parameters
instructionThe instruction that failed.
-
The speech engine does not support provided locale
Declaration
Swift
case unsupportedLocale(locale: Locale)Parameters
localeOffending locale
View Source on GitHub