Class TextToSpeechClient (2.7.1)

TextToSpeechClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`TextToSpeechTransport`	The transport used by the client instance.

Methods

TextToSpeechClient

TextToSpeechClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates 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`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be 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.

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

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

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
`TextToSpeechClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`TextToSpeechClient`	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
`TextToSpeechClient`	The constructed client.

list_voices

list_voices(request: Optional[Union[google.cloud.texttospeech_v1beta1.types.cloud_tts.ListVoicesRequest, dict]] = None, *, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_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`	`Union[google.cloud.texttospeech_v1beta1.types.ListVoicesRequest, dict]` 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 not specified, the API will return all supported voices. 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-NZ" 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-hk" 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
`google.cloud.texttospeech_v1beta1.types.ListVoicesResponse`	The message returned to the client by the ListVoices method.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

synthesize_speech

synthesize_speech(request: Optional[Union[google.cloud.texttospeech_v1beta1.types.cloud_tts.SynthesizeSpeechRequest, dict]] = 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: Union[google.api_core.retry.Retry, object] = <_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`	`Union[google.cloud.texttospeech_v1beta1.types.SynthesizeSpeechRequest, dict]` The request object. The top-level message sent by the client for the `SynthesizeSpeech` method.
`input`	`google.cloud.texttospeech_v1beta1.types.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`	`google.cloud.texttospeech_v1beta1.types.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`	`google.cloud.texttospeech_v1beta1.types.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
`google.cloud.texttospeech_v1beta1.types.SynthesizeSpeechResponse`	The message returned to the client by the SynthesizeSpeech method.