Interface IVoiceManager
interface IVoiceManager
Extends com.amazon.apmf.IStandard
Interface for managing available TTS voices.
This interface encapsulates operations on the voice collection used
in the TTS system. It allows for retrieving voices that meet provided
criteria regarding their capabilities. Understanding the properties
of available voices can be crucial for quality speech synthesis.
Methods
getVoiceId()
Fetches a particular voice using its identifier.IVoice*getVoiceId(VoiceId*voiceId)
Parameters
voiceId
VoiceId* — Required
The identifier of the voice to be retrieved.
Returns
IVoice*
An instance of IVoice that matches the provided identifier.
Throws
VoiceNotAvailableError— if the voice with corresponding voiceId is currently not available.
getVoiceIds()
Retrieves all available voice identifiers.VoiceId[]getVoiceIds()
Returns
VoiceId[]
A collection of VoiceId instances, with each instance
uniquely identifying a different voice.
getAllVoices()
Fetches all available voices.IVoice*[]getAllVoices()
Returns
IVoice*[]
An array of all available voices.
getVoicesByCapabilities()
Fetches all available voices that fulfill certain criteria. This function retrieves an array of IVoice objects that have certain capabilities. It uses the provided IVoiceCapabilities instance for filtering the collection of available voices. The returned voices are the ones that meet the criteria defined by the input parameter.IVoice*[]getVoicesByCapabilities(IVoiceCapabilitiesQuery*capabilitiesQuery)
Parameters
capabilitiesQuery
IVoiceCapabilitiesQuery* — Required
A IVoiceCapabilitiesQuery object representing
the query for filtering voices.
Returns
IVoice*[]
An array of voices representing voices that meet the query criteria.
addVoiceAvailabilityListener()
Registers a listener to receive notifications about voices availability changes.com.amazon.apmf.ISubscription*addVoiceAvailabilityListener(IVoiceAvailabilityListener*listener)
Parameters
listener
IVoiceAvailabilityListener* — Required
The IVoiceAvailabilityListener to register.
Returns
com.amazon.apmf.ISubscription*
The ISubscription instance to be used to unsubscribe to the listener.
