Show / Hide Table of Contents

Class VoiceSelectionParams

Description of which voice to use for a synthesis request.

Inheritance
object
VoiceSelectionParams
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Texttospeech.v1.Data
Assembly: Google.Apis.Texttospeech.v1.dll
Syntax
public class VoiceSelectionParams : IDirectResponseSchema

Properties

CustomVoice

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

Declaration
[JsonProperty("customVoice")]
public virtual CustomVoiceParams CustomVoice { get; set; }
Property Value
Type Description
CustomVoiceParams

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

LanguageCode

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)".

Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type Description
string

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

SsmlGender

The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code 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.

Declaration
[JsonProperty("ssmlGender")]
public virtual string SsmlGender { get; set; }
Property Value
Type Description
string

VoiceClone

Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.

Declaration
[JsonProperty("voiceClone")]
public virtual VoiceCloneParams VoiceClone { get; set; }
Property Value
Type Description
VoiceCloneParams

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX