Class TextToSpeechClient (2.0.0)

TextToSpeechClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-texttospeech/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Service that implements Google Cloud Text-to-Speech API.

Methods

TextToSpeechClient

TextToSpeechClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-texttospeech/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the text to speech client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .TextToSpeechTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. (2) If `transport` argument is None, `client_options` can be used to create a mutual TLS transport. If `client_cert_source` is provided, mutual TLS transport will be created with the given `api_endpoint` or the default mTLS endpoint, and the client SSL credentials obtained from `client_cert_source`.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

list_voices

list_voices(request: Optional[google.cloud.texttospeech_v1beta1.types.cloud_tts.ListVoicesRequest] = None, *, language_code: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a list of Voice supported for synthesis.

Parameters
Name	Description
`request`	`.cloud_tts.ListVoicesRequest` The request object. The top-level message sent by the client for the `ListVoices` method.
`language_code`	`str` Optional. Recommended. `BCP-47 https://www.rfc-editor.org/rfc/bcp/bcp47.txt`__ language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-" voices; when specifying "no", you will get supported "no-" (Norwegian) and "nb-" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-" voices; specifying "zh-hk" will also get supported "yue-*" voices. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.cloud_tts.ListVoicesResponse`	The message returned to the client by the `ListVoices` method.

synthesize_speech

synthesize_speech(request: Optional[google.cloud.texttospeech_v1beta1.types.cloud_tts.SynthesizeSpeechRequest] = None, *, input: Optional[google.cloud.texttospeech_v1beta1.types.cloud_tts.SynthesisInput] = None, voice: Optional[google.cloud.texttospeech_v1beta1.types.cloud_tts.VoiceSelectionParams] = None, audio_config: Optional[google.cloud.texttospeech_v1beta1.types.cloud_tts.AudioConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Synthesizes speech synchronously: receive results after all text input has been processed.

Parameters
Name	Description
`request`	`.cloud_tts.SynthesizeSpeechRequest` The request object. The top-level message sent by the client for the `SynthesizeSpeech` method.
`input`	`.cloud_tts.SynthesisInput` Required. The Synthesizer requires either plain text or SSML as input. This corresponds to the `input` field on the `request` instance; if `request` is provided, this should not be set.
`voice`	`.cloud_tts.VoiceSelectionParams` Required. The desired voice of the synthesized audio. This corresponds to the `voice` field on the `request` instance; if `request` is provided, this should not be set.
`audio_config`	`.cloud_tts.AudioConfig` Required. The configuration of the synthesized audio. This corresponds to the `audio_config` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.cloud_tts.SynthesizeSpeechResponse`	The message returned to the client by the `SynthesizeSpeech` method.