Class TextToSpeechSynthesisVoiceSelection

Namespace

Uralstech.UCloud.TextToSpeech.Synthesis

Description of which voice to use for a synthesis request.

public class TextToSpeechSynthesisVoiceSelection

Inheritance

object

TextToSpeechSynthesisVoiceSelection

Constructors

TextToSpeechSynthesisVoiceSelection()

public TextToSpeechSynthesisVoiceSelection()

TextToSpeechSynthesisVoiceSelection(string)

public TextToSpeechSynthesisVoiceSelection(string languageCode)

Parameters

languageCode string

See LanguageCode.

Fields

CustomVoiceParameters

The configuration for a custom voice.

public TextToSpeechCustomVoiceParameters CustomVoiceParameters

Field Value

TextToSpeechCustomVoiceParameters

Remarks

If Model is set, the service will choose the custom voice matching the specified configuration.

Gender

The preferred gender of the voice.

public TextToSpeechVoiceGender Gender

Field Value

TextToSpeechVoiceGender

Remarks

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.

LanguageCode

The language (and potentially also the region) of the voice expressed as a BCP-47 language tag, e.g. "en-US".

public string LanguageCode

Field Value

string

Remarks

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 TextToSpeechSynthesisInput.
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

The name of the voice.

public TextToSpeechVoiceName Name

Field Value

TextToSpeechVoiceName

Remarks

If both this and Gender are not set, the service will choose a voice based on the other parameters such as LanguageCode.