Struct google_api_proto::google::cloud::texttospeech::v1::VoiceSelectionParams

pub struct VoiceSelectionParams {
    pub language_code: String,
    pub name: String,
    pub ssml_gender: i32,
    pub custom_voice: Option<CustomVoiceParams>,
}

Description of which voice to use for a synthesis request.

Fields

language_code: 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 both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.

ssml_gender: i32

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.

custom_voice: Option<CustomVoiceParams>

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

Implementations

impl VoiceSelectionParams

pub fn ssml_gender(&self) -> SsmlVoiceGender

Returns the enum value of ssml_gender, or the default if the field is set to an invalid enum value.

pub fn set_ssml_gender(&mut self, value: SsmlVoiceGender)

Sets ssml_gender to the provided enum value.

Trait Implementations

impl Clone for VoiceSelectionParams

fn clone(&self) -> VoiceSelectionParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VoiceSelectionParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VoiceSelectionParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for VoiceSelectionParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for VoiceSelectionParams

fn eq(&self, other: &VoiceSelectionParams) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VoiceSelectionParams