Interfaces
- ISpeechStreamListener — The
ISpeechStreamListenerinterface defines callback methods that clients should implement to receive notifications about speech stream events. - ISpeechStream — The
ISpeechStreaminterface provides methods to access and manage a synthesized speech audio stream, including its configuration and state. - AudioPlaybackSettings — The
AudioPlaybackSettingsinterface struct offers methods to configure audio playback for synthesized speech, including stream playback, audio focus, and audio attributes. - IOperatingMode
- ILocale —
ILocaleis an interface that represents the locale for Text-to-Speech synthesis. - IVoiceProvider — Interface representing the provider of a particular voice.
- IVoiceCapabilities — Interface representing technical features of the voice.
- IVoice — Interface representing characteristics of a synthetic TTS voice.
- IVoiceCapabilitiesQuery —
IVoiceCapabilitiesQueryBuilderis an interface that provides methods to create a query for filtering voices based on certain capabilities. - IVoiceCapabilitiesQueryBuilder — Interface for building custom voice capabilities.
- IVoiceAvailabilityListener —
IVoiceAvailabilityListeneris an interface for receiving notifications about changes in the availability of voicess. - IVoiceManager — Interface for managing available TTS voices.
- IInputFormatType
- UtteranceInput —
UtteranceInputis an interface struct that manages input to the text-to-speech engine. - SpeechAttributes —
SpeechAttributesis an interface struct that allows access to properties of synthesized speech. - IUtterance —
IUtteranceis an interface representing a single unit of speech synthesis. - IUtteranceBuilder2 —
IUtteranceBuilder2is a correct interface that allows building a concrete instance ofIUtterance. - IUtteranceBuilder —
IUtteranceBuilderis a deprecated interface that allows building a concrete instance of IUtterance. UseIUtteranceBuilder2instead of this one. - ISpeakProfile —
ISpeakProfileis an interface that represents a profile for preconfigured speech parameters for common use cases. - ISpeakProfileChangeListener —
ISpeakProfileChangeListeneris an interface for receiving notifications about changes to speak profiles within theProfileManager. - IProfileManager —
IProfileManageris an interface that allows management of speak profiles. - IUtteranceContext —
IUtteranceContextis an interface for managing a speech synthesis request. - IUtteranceProgressListener — Interface providing events for a single utterance request.
- IAsyncClient — Interface representing the TTS client that interfaces with the system TTS service.
- ITtsAsyncClientService2 — Interface encapsulating methods for managing TTS client service.
- ITtsAsyncClientService — Deprecated interface encapsulating methods for managing TTS client service. Use
ITtsAsyncClientService2instead of this one.
Structs
- OperatingMode —
OperatingModeis a sealed struct that outlines the different operational modes a voice can have. - VoiceId —
VoiceIdis a struct that holds the identifiers of a Voice. This id is unique across the system. - InputFormatType —
InputFormatTypeis an enum that encapsulates different text inputs formats. - SpeakProfileId —
SpeakProfileIdis a struct that holds the identifiers of a Speak Profile. A Speak Profile represents a predefined configuration for speech synthesis that is optimized for a particular use case scenario. Each profile identifier uniquely identifies a different scenario.
Enumerations
- StreamState —
StreamStateenumerates the possible states of a speech stream, defining a set of consistent state descriptions for the lifecycle of the stream. - Gender —
Genderis an enum that defines possible gender values for a voice. - Quality —
Qualityis an enum that defines possible quality levels for a voice. - UtteranceCompletedReason — Enum defining possible reasons for the completion of the utterance.
Exceptions
- ProfileNotAvailableError — Exception indicating an issue with a specific profile availability.
- AudioStreamNotInitializedError — Exception indicating the audio stream in not ready yet.
- UtterancetNotCompletedError — Exception indiating the related utterance is not finished yet.
- SpeechSynthesisError — Exception indicating an error during the speech generation process.
- SpeechPlaybackError — Exception indicating an error during the audio playback.
- ProviderNotAvailableError — Exception indicating an issue with the availability of the speech provider.
- VoiceNotAvailableError — Exception indicating an issue with a specific voice availability.
- InvalidInputError — Exception indicating an issue with the provided input for speech generation.
- ClientDisconnectedError — Exception indicating the termination of the client during the speech generation process.

