Class VoiceSelectionParams (3.0.0) 

public sealed class VoiceSelectionParams : IMessage<VoiceSelectionParams>, IEquatable<VoiceSelectionParams>, IDeepCloneable<VoiceSelectionParams>, IBufferMessage, IMessage

Description of which voice to use for a synthesis request.

Inheritance

Object > VoiceSelectionParams

Namespace

Google.Cloud.TextToSpeech.V1

Assembly

Google.Cloud.TextToSpeech.V1.dll

Constructors

VoiceSelectionParams()

public VoiceSelectionParams()

VoiceSelectionParams(VoiceSelectionParams)

public VoiceSelectionParams(VoiceSelectionParams other)
Parameter
NameDescription
otherVoiceSelectionParams

Properties

CustomVoice

public CustomVoiceParams CustomVoice { get; set; }

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

Property Value
TypeDescription
CustomVoiceParams

LanguageCode

public string LanguageCode { get; set; }

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

Property Value
TypeDescription
String

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String

SsmlGender

public SsmlVoiceGender SsmlGender { get; set; }

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.

Property Value
TypeDescription
SsmlVoiceGender