Interface IVoiceCapabilitiesQueryBuilder
interface IVoiceCapabilitiesQueryBuilder
Extends com.amazon.apmf.IStandard
Interface for building custom voice capabilities.
This interface allows constructing a custom IVoiceCapabilities object
by choosing compatible locales, sampling rates, speech rates and
operating modes.
A single invocation of the method taking an array as argument is
considered as all array items has to be matched whereas multiple
invocations of the same method are considered as any of the arguments
has to be matched, e.g. builder.preferredLocales({“en-US”, “de-DE”}).
preferredLocales({“en-GB”, “fr-FR”}) means that result will contain
voices supporting both “en-US” and “de-DE” locales or both “en-GB”
and “fr-FR”.
Methods
preferredLocales()
Adds the preferred locales to the query.IVoiceCapabilitiesQueryBuilder*preferredLocales(ILocale*[]locales)
Parameters
locales
ILocale*[] — Required
An array of ILocale objects representing the preferred locales.
Returns
IVoiceCapabilitiesQueryBuilder*
The updated instance of the IVoiceCapabilitiesQueryBuilder.
supportedLocales()
Adds the supported locales to the query.IVoiceCapabilitiesQueryBuilder*supportedLocales(ILocale*[]locales)
Parameters
locales
ILocale*[] — Required
An array of ILocale objects representing the supported locales.
Returns
IVoiceCapabilitiesQueryBuilder*
The updated instance of the IVoiceCapabilitiesQueryBuilder.
supportedInputFormatTypes()
Adds the supported input format types to the query.IVoiceCapabilitiesQueryBuilder*supportedInputFormatTypes(InputFormatType[]formats)
Parameters
formats
InputFormatType[] — Required
An array of InputFormatType objects representing the supported
input formats for the utterance.
Returns
IVoiceCapabilitiesQueryBuilder*
The updated instance of the IVoiceCapabilitiesQueryBuilder.
operatingMode()
Adds the operating modes to the query.IVoiceCapabilitiesQueryBuilder*operatingMode(OperatingMode[]operatingModes)
Parameters
operatingModes
OperatingMode[] — Required
An array of OperatingMode values representing
the supported operating modes.
Returns
IVoiceCapabilitiesQueryBuilder*
The updated instance of the IVoiceCapabilitiesQueryBuilder.
gender()
Sets the gender for the query.IVoiceCapabilitiesQueryBuilder*gender(Gendergender)
Parameters
gender
Gender — Required
The gender to be set in the query.
Returns
IVoiceCapabilitiesQueryBuilder*
The updated instance of the IVoiceCapabilitiesQueryBuilder.
quality()
Sets the quality for the query.IVoiceCapabilitiesQueryBuilder*quality(Qualityquality)
Parameters
quality
Quality — Required
The quality to be set in the query.
Returns
IVoiceCapabilitiesQueryBuilder*
The updated instance of the IVoiceCapabilitiesQueryBuilder.
build()
Builds the query based on the provided criteria.IVoiceCapabilitiesQuery*build()
Returns
IVoiceCapabilitiesQuery*
A IVoiceCapabilitiesQuery object encapsulating the query.
