<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/cloud/texttospeech/v1/cloud_tts.proto
namespace Google\Cloud\TextToSpeech\V1;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
/**
* Description of which voice to use for a synthesis request.
*
* Generated from protobuf message <code>google.cloud.texttospeech.v1.VoiceSelectionParams</code>
*/
class VoiceSelectionParams extends \Google\Protobuf\Internal\Message
{
/**
* The language (and optionally also the region) of the voice expressed as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
* "en-US". Required. 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)".
*
* Generated from protobuf field <code>string language_code = 1;</code>
*/
private $language_code = '';
/**
* The name of the voice. Optional; if not set, the service will choose a
* voice based on the other parameters such as language_code and gender.
*
* Generated from protobuf field <code>string name = 2;</code>
*/
private $name = '';
/**
* The preferred gender of the voice. Optional; 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.
*
* Generated from protobuf field <code>.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;</code>
*/
private $ssml_gender = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $language_code
* The language (and optionally also the region) of the voice expressed as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
* "en-US". Required. 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)".
* @type string $name
* The name of the voice. Optional; if not set, the service will choose a
* voice based on the other parameters such as language_code and gender.
* @type int $ssml_gender
* The preferred gender of the voice. Optional; 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.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Texttospeech\V1\CloudTts::initOnce();
parent::__construct($data);
}
/**
* The language (and optionally also the region) of the voice expressed as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
* "en-US". Required. 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)".
*
* Generated from protobuf field <code>string language_code = 1;</code>
* @return string
*/
public function getLanguageCode()
{
return $this->language_code;
}
/**
* The language (and optionally also the region) of the voice expressed as a
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
* "en-US". Required. 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)".
*
* Generated from protobuf field <code>string language_code = 1;</code>
* @param string $var
* @return $this
*/
public function setLanguageCode($var)
{
GPBUtil::checkString($var, True);
$this->language_code = $var;
return $this;
}
/**
* The name of the voice. Optional; if not set, the service will choose a
* voice based on the other parameters such as language_code and gender.
*
* Generated from protobuf field <code>string name = 2;</code>
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The name of the voice. Optional; if not set, the service will choose a
* voice based on the other parameters such as language_code and gender.
*
* Generated from protobuf field <code>string name = 2;</code>
* @param string $var
* @return $this
*/
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
}
/**
* The preferred gender of the voice. Optional; 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.
*
* Generated from protobuf field <code>.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;</code>
* @return int
*/
public function getSsmlGender()
{
return $this->ssml_gender;
}
/**
* The preferred gender of the voice. Optional; 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.
*
* Generated from protobuf field <code>.google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;</code>
* @param int $var
* @return $this
*/
public function setSsmlGender($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\TextToSpeech\V1\SsmlVoiceGender::class);
$this->ssml_gender = $var;
return $this;
}
}