Client for Cloud Text-to-Speech API

class google.cloud.texttospeech_v1beta1.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.

Constructor.

  • Parameters

    (Union[TextToSpeechGrpcTransport (transport) – Callable[[~.Credentials, type], ~.TextToSpeechGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.

:param

instance, responsible for actually making the API calls.
The default transport uses the gRPC protocol.
This argument may also be a callable which returns a
transport instance. Callables will be sent the credentials
as the first argument and the default transport class as
the second argument.

  • Parameters

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

enums( = <module 'google.cloud.texttospeech_v1beta1.gapic.enums' from '/workspace/python-texttospeech/google/cloud/texttospeech_v1beta1/gapic/enums.py' )

classmethod from_service_account_file(filename, *args, **kwargs)

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

  • Parameters

    • filename (str) – The path to the service account private key json file.

    • args – Additional arguments to pass to the constructor.

    • kwargs – Additional arguments to pass to the constructor.

  • Returns

    The constructed client.

  • Return type

    TextToSpeechClient

classmethod from_service_account_json(filename, *args, **kwargs)

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

  • Parameters

    • filename (str) – The path to the service account private key json file.

    • args – Additional arguments to pass to the constructor.

    • kwargs – Additional arguments to pass to the constructor.

  • Returns

    The constructed client.

  • Return type

    TextToSpeechClient

list_voices(language_code=None, retry=<_MethodDefault._DEFAULT_VALUE:

Returns a list of Voice supported for synthesis.

Example

>>> from google.cloud import texttospeech_v1beta1
>>>
>>> client = texttospeech_v1beta1.TextToSpeechClient()
>>>
>>> response = client.list_voices()

  • Parameters

    • language_code (str) – Optional (but recommended) BCP-47 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 not be retried.

    • 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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]]]*) – Additional metadata that is provided to the method.

  • Returns

    A ListVoicesResponse instance.

  • Raises

    • 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(input_, voice, audio_config, retry=<_MethodDefault._DEFAULT_VALUE:

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

Example

>>> from google.cloud import texttospeech_v1beta1
>>>
>>> client = texttospeech_v1beta1.TextToSpeechClient()
>>>
>>> # TODO: Initialize `input_`:
>>> input_ = {}
>>>
>>> # TODO: Initialize `voice`:
>>> voice = {}
>>>
>>> # TODO: Initialize `audio_config`:
>>> audio_config = {}
>>>
>>> response = client.synthesize_speech(input_, voice, audio_config)

  • Parameters

    • input (Union[dict, *[SynthesisInput](types.md#google.cloud.texttospeech_v1beta1.types.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](types.md#google.cloud.texttospeech_v1beta1.types.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](types.md#google.cloud.texttospeech_v1beta1.types.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 not be retried.

    • 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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]]]*) – Additional metadata that is provided to the method.

  • Returns

    A SynthesizeSpeechResponse instance.

  • Raises

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