Class TextToSpeechClient (1.0.2)

Version 1.0.2

• 2.21.1 (latest)
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.5
• 2.15.1
• 2.14.2
• 2.13.0
• 2.12.3
• 2.11.1
• 2.10.2
• 2.9.1
• 2.8.0
• 2.7.1
• 2.6.0
• 2.5.3
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.3
• 0.5.0

TextToSpeechClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

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

Inheritance

builtins.object > google.cloud.texttospeech_v1.gapic.text_to_speech_client.TextToSpeechClient > TextToSpeechClient

Methods

TextToSpeechClient

TextToSpeechClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters

Name	Description
channel	grpc.Channel DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials	google.auth.credentials.Credentials The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config	dict DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.

from_service_account_file

from_service_account_file(filename, *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
TextToSpeechClient	The constructed client.

from_service_account_json

from_service_account_json(filename, *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
TextToSpeechClient	The constructed client.

list_voices

list_voices(language_code=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Returns a list of Voice supported for synthesis.

.. rubric:: Example

from google.cloud import texttospeech_v1

client = texttospeech_v1.TextToSpeechClient()

response = client.list_voices()

Parameters

Name	Description
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.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

synthesize_speech

synthesize_speech(input_, voice, audio_config, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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

.. rubric:: Example

from google.cloud import texttospeech_v1

client = texttospeech_v1.TextToSpeechClient()

TODO: Initialize input_:

input_ = {}

TODO: Initialize voice:

voice = {}

TODO: Initialize audio_config:

audio_config = {}

response = client.synthesize_speech(input_, voice, audio_config)

Parameters

Name	Description
input_	Union[dict, SynthesisInput] Required. The Synthesizer requires either plain text or SSML as input. If a dict is provided, it must be of the same form as the protobuf message SynthesisInput
voice	Union[dict, VoiceSelectionParams] Required. The desired voice of the synthesized audio. If a dict is provided, it must be of the same form as the protobuf message VoiceSelectionParams
audio_config	Union[dict, AudioConfig] Required. The configuration of the synthesized audio. If a dict is provided, it must be of the same form as the protobuf message AudioConfig
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.