VoiceSelectionParams

Description of which voice to use for a synthesis request.

JSON representation 
{
  "languageCode": string,
  "name": string,
  "ssmlGender": enum (SsmlVoiceGender),
  "customVoice": {
    object (CustomVoiceParams)
  }
}
Fields
languageCode

string

Required. The language (and potentially also the region) of the voice expressed as a BCP-47 language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
name

string

The name of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and gender.
ssmlGender

enum (SsmlVoiceGender)

The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
customVoice

object (CustomVoiceParams)

The configuration for a custom voice. If [CustomVoiceParams.model] is set, the service will choose the custom voice matching the specified configuration.

CustomVoiceParams

Description of the custom voice to be synthesized.

JSON representation 
{
  "model": string,
  "reportedUsage": enum (ReportedUsage)
}
Fields
model

string

Required. The name of the AutoML model that synthesizes the custom voice.
reportedUsage

enum (ReportedUsage)

Optional. The usage of the synthesized audio to be reported.

ReportedUsage

The usage of the synthesized audio. You must report your honest and correct usage of the service as it's regulated by contract and will cause significant difference in billing.

Enums
REPORTED_USAGE_UNSPECIFIED Request with reported usage unspecified will be rejected.
REALTIME For scenarios where the synthesized audio is not downloadable and can only be used once. For example, real-time request in IVR system.
OFFLINE For scenarios where the synthesized audio is downloadable and can be reused. For example, the synthesized audio is downloaded, stored in customer service system and played repeatedly.