Documentation ¶
Overview ¶
Package texttospeech provides access to the Cloud Text-to-Speech API.
This package is DEPRECATED. Use package cloud.google.com/go/texttospeech/apiv1 instead.
For product documentation, see: https://cloud.google.com/text-to-speech/
Library status ¶
These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.
Creating a client ¶
Usage example:
import "google.golang.org/api/texttospeech/v1" ... ctx := context.Background() texttospeechService, err := texttospeech.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:
texttospeechService, err := texttospeech.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) texttospeechService, err := texttospeech.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See google.golang.org/api/option.ClientOption for details on options.
Index ¶
- Constants
- type AudioConfig
- type CancelOperationRequest
- type CustomVoiceParams
- type Empty
- type GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata
- type ListOperationsResponse
- type ListVoicesResponse
- type Operation
- type OperationsCancelCall
- type OperationsDeleteCall
- type OperationsService
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type ProjectsLocationsOperationsService
- type ProjectsLocationsService
- type ProjectsLocationsSynthesizeLongAudioCall
- func (c *ProjectsLocationsSynthesizeLongAudioCall) Context(ctx context.Context) *ProjectsLocationsSynthesizeLongAudioCall
- func (c *ProjectsLocationsSynthesizeLongAudioCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsSynthesizeLongAudioCall) Fields(s ...googleapi.Field) *ProjectsLocationsSynthesizeLongAudioCall
- func (c *ProjectsLocationsSynthesizeLongAudioCall) Header() http.Header
- type ProjectsService
- type Service
- type Status
- type SynthesisInput
- type SynthesizeLongAudioMetadata
- type SynthesizeLongAudioRequest
- type SynthesizeSpeechRequest
- type SynthesizeSpeechResponse
- type TextService
- type TextSynthesizeCall
- func (c *TextSynthesizeCall) Context(ctx context.Context) *TextSynthesizeCall
- func (c *TextSynthesizeCall) Do(opts ...googleapi.CallOption) (*SynthesizeSpeechResponse, error)
- func (c *TextSynthesizeCall) Fields(s ...googleapi.Field) *TextSynthesizeCall
- func (c *TextSynthesizeCall) Header() http.Header
- type Voice
- type VoiceSelectionParams
- type VoicesListCall
- func (c *VoicesListCall) Context(ctx context.Context) *VoicesListCall
- func (c *VoicesListCall) Do(opts ...googleapi.CallOption) (*ListVoicesResponse, error)
- func (c *VoicesListCall) Fields(s ...googleapi.Field) *VoicesListCall
- func (c *VoicesListCall) Header() http.Header
- func (c *VoicesListCall) IfNoneMatch(entityTag string) *VoicesListCall
- func (c *VoicesListCall) LanguageCode(languageCode string) *VoicesListCall
- type VoicesService
Constants ¶
const ( // See, edit, configure, and delete your Google Cloud data and see the // email address for your Google Account. CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AudioConfig ¶
type AudioConfig struct { // AudioEncoding: Required. The format of the audio byte stream. // // Possible values: // "AUDIO_ENCODING_UNSPECIFIED" - Not specified. Will return result // google.rpc.Code.INVALID_ARGUMENT. // "LINEAR16" - Uncompressed 16-bit signed little-endian samples // (Linear PCM). Audio content returned as LINEAR16 also contains a WAV // header. // "MP3" - MP3 audio at 32kbps. // "OGG_OPUS" - Opus encoded audio wrapped in an ogg container. The // result will be a file which can be played natively on Android, and in // browsers (at least Chrome and Firefox). The quality of the encoding // is considerably higher than MP3 while using approximately the same // bitrate. // "MULAW" - 8-bit samples that compand 14-bit audio samples using // G.711 PCMU/mu-law. Audio content returned as MULAW also contains a // WAV header. // "ALAW" - 8-bit samples that compand 14-bit audio samples using // G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV // header. AudioEncoding string `json:"audioEncoding,omitempty"` // EffectsProfileId: Optional. Input only. An identifier which selects // 'audio effects' profiles that are applied on (post synthesized) text // to speech. Effects are applied on top of each other in the order they // are given. See audio profiles // (https://cloud.google.com/text-to-speech/docs/audio-profiles) for // current supported profile ids. EffectsProfileId []string `json:"effectsProfileId,omitempty"` // Pitch: Optional. Input only. Speaking pitch, in the range [-20.0, // 20.0]. 20 means increase 20 semitones from the original pitch. -20 // means decrease 20 semitones from the original pitch. Pitch float64 `json:"pitch,omitempty"` // SampleRateHertz: Optional. The synthesis sample rate (in hertz) for // this audio. When this is specified in SynthesizeSpeechRequest, if // this is different from the voice's natural sample rate, then the // synthesizer will honor this request by converting to the desired // sample rate (which might result in worse audio quality), unless the // specified sample rate is not supported for the encoding chosen, in // which case it will fail the request and return // google.rpc.Code.INVALID_ARGUMENT. SampleRateHertz int64 `json:"sampleRateHertz,omitempty"` // SpeakingRate: Optional. Input only. Speaking rate/speed, in the range // [0.25, 4.0]. 1.0 is the normal native speed supported by the specific // voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), // defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 // will return an error. SpeakingRate float64 `json:"speakingRate,omitempty"` // VolumeGainDb: Optional. Input only. Volume gain (in dB) of the normal // native volume supported by the specific voice, in the range [-96.0, // 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal // native signal amplitude. A value of -6.0 (dB) will play at // approximately half the amplitude of the normal native signal // amplitude. A value of +6.0 (dB) will play at approximately twice the // amplitude of the normal native signal amplitude. Strongly recommend // not to exceed +10 (dB) as there's usually no effective increase in // loudness for any value greater than that. VolumeGainDb float64 `json:"volumeGainDb,omitempty"` // ForceSendFields is a list of field names (e.g. "AudioEncoding") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AudioEncoding") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AudioConfig: Description of audio data to be synthesized.
func (*AudioConfig) MarshalJSON ¶
func (s *AudioConfig) MarshalJSON() ([]byte, error)
func (*AudioConfig) UnmarshalJSON ¶
func (s *AudioConfig) UnmarshalJSON(data []byte) error
type CancelOperationRequest ¶
type CancelOperationRequest struct { }
CancelOperationRequest: The request message for Operations.CancelOperation.
type CustomVoiceParams ¶
type CustomVoiceParams struct { // Model: Required. The name of the AutoML model that synthesizes the // custom voice. Model string `json:"model,omitempty"` // ReportedUsage: Optional. Deprecated. The usage of the synthesized // audio to be reported. // // Possible values: // "REPORTED_USAGE_UNSPECIFIED" - Request with reported usage // unspecified will be rejected. // "REALTIME" - For scenarios where the synthesized audio is not // downloadable and can only be used once. For example, real-time // request in IVR system. // "OFFLINE" - For scenarios where the synthesized audio is // downloadable and can be reused. For example, the synthesized audio is // downloaded, stored in customer service system and played repeatedly. ReportedUsage string `json:"reportedUsage,omitempty"` // ForceSendFields is a list of field names (e.g. "Model") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Model") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CustomVoiceParams: Description of the custom voice to be synthesized.
func (*CustomVoiceParams) MarshalJSON ¶
func (s *CustomVoiceParams) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata ¶
type GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata struct { // ProgressPercentage: The progress of the most recent processing update // in percentage, ie. 70.0%. ProgressPercentage float64 `json:"progressPercentage,omitempty"` // StartTime: Time when the request was received. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "ProgressPercentage") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ProgressPercentage") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata: Metadata for response returned by the `SynthesizeLongAudio` method.
func (*GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata) MarshalJSON ¶
func (s *GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata) MarshalJSON() ([]byte, error)
func (*GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata) UnmarshalJSON ¶
func (s *GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata) UnmarshalJSON(data []byte) error
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type ListVoicesResponse ¶
type ListVoicesResponse struct { // Voices: The list of voices. Voices []*Voice `json:"voices,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Voices") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Voices") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListVoicesResponse: The message returned to the client by the `ListVoices` method.
func (*ListVoicesResponse) MarshalJSON ¶
func (s *ListVoicesResponse) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. If `true`, the operation is completed, and either `error` // or `response` is available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. It // typically contains progress information and common metadata such as // create time. Some services might not provide such metadata. Any // method that returns a long-running operation should document the // metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that originally returns it. If you use the default HTTP // mapping, the `name` should be a resource name ending with // `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal, successful response of the operation. If the // original method returns no data on success, such as `Delete`, the // response is `google.protobuf.Empty`. If the original method is // standard `Get`/`Create`/`Update`, the response should be the // resource. For other methods, the response should have the type // `XxxResponse`, where `Xxx` is the original method name. For example, // if the original method name is `TakeSnapshot()`, the inferred // response type is `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationsCancelCall ¶
type OperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*OperationsCancelCall) Context ¶
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsCancelCall) Do ¶
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "texttospeech.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsCancelCall) Fields ¶
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsCancelCall) Header ¶
func (c *OperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsDeleteCall ¶
type OperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*OperationsDeleteCall) Context ¶
func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsDeleteCall) Do ¶
func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "texttospeech.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsDeleteCall) Fields ¶
func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsDeleteCall) Header ¶
func (c *OperationsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Cancel ¶
func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
- name: The name of the operation resource to be cancelled.
func (*OperationsService) Delete ¶
func (r *OperationsService) Delete(name string) *OperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- name: The name of the operation resource to be deleted.
type ProjectsLocationsOperationsGetCall ¶
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsGetCall) Context ¶
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsGetCall) Do ¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "texttospeech.projects.locations.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsGetCall) Fields ¶
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsGetCall) Header ¶
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsLocationsOperationsListCall ¶
type ProjectsLocationsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsListCall) Context ¶
func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsOperationsListCall) Do ¶
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "texttospeech.projects.locations.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsListCall) Fields ¶
func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsOperationsListCall) Filter ¶
func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsOperationsListCall) Header ¶
func (c *ProjectsLocationsOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsOperationsListCall) PageSize ¶
func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsOperationsListCall) PageToken ¶
func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsOperationsListCall) Pages ¶
func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsOperationsService ¶
type ProjectsLocationsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService ¶
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService) Get ¶
func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (*ProjectsLocationsOperationsService) List ¶
func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
- name: The name of the operation's parent resource.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { Operations *ProjectsLocationsOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (*ProjectsLocationsService) SynthesizeLongAudio ¶
func (r *ProjectsLocationsService) SynthesizeLongAudio(parent string, synthesizelongaudiorequest *SynthesizeLongAudioRequest) *ProjectsLocationsSynthesizeLongAudioCall
SynthesizeLongAudio: Synthesizes long form text asynchronously.
- parent: The resource states of the request in the form of `projects/*/locations/*`.
type ProjectsLocationsSynthesizeLongAudioCall ¶
type ProjectsLocationsSynthesizeLongAudioCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsSynthesizeLongAudioCall) Context ¶
func (c *ProjectsLocationsSynthesizeLongAudioCall) Context(ctx context.Context) *ProjectsLocationsSynthesizeLongAudioCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsSynthesizeLongAudioCall) Do ¶
func (c *ProjectsLocationsSynthesizeLongAudioCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "texttospeech.projects.locations.synthesizeLongAudio" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsSynthesizeLongAudioCall) Fields ¶
func (c *ProjectsLocationsSynthesizeLongAudioCall) Fields(s ...googleapi.Field) *ProjectsLocationsSynthesizeLongAudioCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsSynthesizeLongAudioCall) Header ¶
func (c *ProjectsLocationsSynthesizeLongAudioCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsService ¶
type ProjectsService struct { Locations *ProjectsLocationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Operations *OperationsService Projects *ProjectsService Text *TextService Voices *VoicesService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any user-facing error message should be localized and sent // in the google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*Status) MarshalJSON ¶
type SynthesisInput ¶
type SynthesisInput struct { // Ssml: The SSML document to be synthesized. The SSML document must be // valid and well-formed. Otherwise the RPC will fail and return // google.rpc.Code.INVALID_ARGUMENT. For more information, see SSML // (https://cloud.google.com/text-to-speech/docs/ssml). Ssml string `json:"ssml,omitempty"` // Text: The raw text to be synthesized. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Ssml") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Ssml") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SynthesisInput: Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes.
func (*SynthesisInput) MarshalJSON ¶
func (s *SynthesisInput) MarshalJSON() ([]byte, error)
type SynthesizeLongAudioMetadata ¶
type SynthesizeLongAudioMetadata struct { // ProgressPercentage: The progress of the most recent processing update // in percentage, ie. 70.0%. ProgressPercentage float64 `json:"progressPercentage,omitempty"` // StartTime: Time when the request was received. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "ProgressPercentage") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ProgressPercentage") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
SynthesizeLongAudioMetadata: Metadata for response returned by the `SynthesizeLongAudio` method.
func (*SynthesizeLongAudioMetadata) MarshalJSON ¶
func (s *SynthesizeLongAudioMetadata) MarshalJSON() ([]byte, error)
func (*SynthesizeLongAudioMetadata) UnmarshalJSON ¶
func (s *SynthesizeLongAudioMetadata) UnmarshalJSON(data []byte) error
type SynthesizeLongAudioRequest ¶
type SynthesizeLongAudioRequest struct { // AudioConfig: Required. The configuration of the synthesized audio. AudioConfig *AudioConfig `json:"audioConfig,omitempty"` // Input: Required. The Synthesizer requires either plain text or SSML // as input. While Long Audio is in preview, SSML is temporarily // unsupported. Input *SynthesisInput `json:"input,omitempty"` // OutputGcsUri: Required. Specifies a Cloud Storage URI for the // synthesis results. Must be specified in the format: // `gs://bucket_name/object_name`, and the bucket must already exist. OutputGcsUri string `json:"outputGcsUri,omitempty"` // Voice: Required. The desired voice of the synthesized audio. Voice *VoiceSelectionParams `json:"voice,omitempty"` // ForceSendFields is a list of field names (e.g. "AudioConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AudioConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SynthesizeLongAudioRequest: The top-level message sent by the client for the `SynthesizeLongAudio` method.
func (*SynthesizeLongAudioRequest) MarshalJSON ¶
func (s *SynthesizeLongAudioRequest) MarshalJSON() ([]byte, error)
type SynthesizeSpeechRequest ¶
type SynthesizeSpeechRequest struct { // AudioConfig: Required. The configuration of the synthesized audio. AudioConfig *AudioConfig `json:"audioConfig,omitempty"` // Input: Required. The Synthesizer requires either plain text or SSML // as input. Input *SynthesisInput `json:"input,omitempty"` // Voice: Required. The desired voice of the synthesized audio. Voice *VoiceSelectionParams `json:"voice,omitempty"` // ForceSendFields is a list of field names (e.g. "AudioConfig") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AudioConfig") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SynthesizeSpeechRequest: The top-level message sent by the client for the `SynthesizeSpeech` method.
func (*SynthesizeSpeechRequest) MarshalJSON ¶
func (s *SynthesizeSpeechRequest) MarshalJSON() ([]byte, error)
type SynthesizeSpeechResponse ¶
type SynthesizeSpeechResponse struct { // AudioContent: The audio data bytes encoded as specified in the // request, including the header for encodings that are wrapped in // containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the // WAV header. Note: as with all bytes fields, protobuffers use a pure // binary representation, whereas JSON representations use base64. AudioContent string `json:"audioContent,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AudioContent") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AudioContent") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SynthesizeSpeechResponse: The message returned to the client by the `SynthesizeSpeech` method.
func (*SynthesizeSpeechResponse) MarshalJSON ¶
func (s *SynthesizeSpeechResponse) MarshalJSON() ([]byte, error)
type TextService ¶
type TextService struct {
// contains filtered or unexported fields
}
func NewTextService ¶
func NewTextService(s *Service) *TextService
func (*TextService) Synthesize ¶
func (r *TextService) Synthesize(synthesizespeechrequest *SynthesizeSpeechRequest) *TextSynthesizeCall
Synthesize: Synthesizes speech synchronously: receive results after all text input has been processed.
type TextSynthesizeCall ¶
type TextSynthesizeCall struct {
// contains filtered or unexported fields
}
func (*TextSynthesizeCall) Context ¶
func (c *TextSynthesizeCall) Context(ctx context.Context) *TextSynthesizeCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TextSynthesizeCall) Do ¶
func (c *TextSynthesizeCall) Do(opts ...googleapi.CallOption) (*SynthesizeSpeechResponse, error)
Do executes the "texttospeech.text.synthesize" call. Exactly one of *SynthesizeSpeechResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SynthesizeSpeechResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*TextSynthesizeCall) Fields ¶
func (c *TextSynthesizeCall) Fields(s ...googleapi.Field) *TextSynthesizeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TextSynthesizeCall) Header ¶
func (c *TextSynthesizeCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type Voice ¶
type Voice struct { // LanguageCodes: The languages that this voice supports, expressed as // BCP-47 (https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags // (e.g. "en-US", "es-419", "cmn-tw"). LanguageCodes []string `json:"languageCodes,omitempty"` // Name: The name of this voice. Each distinct voice has a unique name. Name string `json:"name,omitempty"` // NaturalSampleRateHertz: The natural sample rate (in hertz) for this // voice. NaturalSampleRateHertz int64 `json:"naturalSampleRateHertz,omitempty"` // SsmlGender: The gender of this voice. // // Possible values: // "SSML_VOICE_GENDER_UNSPECIFIED" - An unspecified gender. In // VoiceSelectionParams, this means that the client doesn't care which // gender the selected voice will have. In the Voice field of // ListVoicesResponse, this may mean that the voice doesn't fit any of // the other categories in this enum, or that the gender of the voice // isn't known. // "MALE" - A male voice. // "FEMALE" - A female voice. // "NEUTRAL" - A gender-neutral voice. This voice is not yet // supported. SsmlGender string `json:"ssmlGender,omitempty"` // ForceSendFields is a list of field names (e.g. "LanguageCodes") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "LanguageCodes") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Voice: Description of a voice supported by the TTS service.
func (*Voice) MarshalJSON ¶
type VoiceSelectionParams ¶
type VoiceSelectionParams struct { // CustomVoice: The configuration for a custom voice. If // [CustomVoiceParams.model] is set, the service will choose the custom // voice matching the specified configuration. CustomVoice *CustomVoiceParams `json:"customVoice,omitempty"` // LanguageCode: Required. The language (and potentially 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". 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)". LanguageCode string `json:"languageCode,omitempty"` // Name: The name of the voice. If not set, the service will choose a // voice based on the other parameters such as language_code and gender. Name string `json:"name,omitempty"` // SsmlGender: The preferred gender of the voice. 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. // // Possible values: // "SSML_VOICE_GENDER_UNSPECIFIED" - An unspecified gender. In // VoiceSelectionParams, this means that the client doesn't care which // gender the selected voice will have. In the Voice field of // ListVoicesResponse, this may mean that the voice doesn't fit any of // the other categories in this enum, or that the gender of the voice // isn't known. // "MALE" - A male voice. // "FEMALE" - A female voice. // "NEUTRAL" - A gender-neutral voice. This voice is not yet // supported. SsmlGender string `json:"ssmlGender,omitempty"` // ForceSendFields is a list of field names (e.g. "CustomVoice") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CustomVoice") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
VoiceSelectionParams: Description of which voice to use for a synthesis request.
func (*VoiceSelectionParams) MarshalJSON ¶
func (s *VoiceSelectionParams) MarshalJSON() ([]byte, error)
type VoicesListCall ¶
type VoicesListCall struct {
// contains filtered or unexported fields
}
func (*VoicesListCall) Context ¶
func (c *VoicesListCall) Context(ctx context.Context) *VoicesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*VoicesListCall) Do ¶
func (c *VoicesListCall) Do(opts ...googleapi.CallOption) (*ListVoicesResponse, error)
Do executes the "texttospeech.voices.list" call. Exactly one of *ListVoicesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListVoicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*VoicesListCall) Fields ¶
func (c *VoicesListCall) Fields(s ...googleapi.Field) *VoicesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*VoicesListCall) Header ¶
func (c *VoicesListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*VoicesListCall) IfNoneMatch ¶
func (c *VoicesListCall) IfNoneMatch(entityTag string) *VoicesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*VoicesListCall) LanguageCode ¶
func (c *VoicesListCall) LanguageCode(languageCode string) *VoicesListCall
LanguageCode sets the optional parameter "languageCode": 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. For example, if you specify "en-NZ", all "en-NZ" voices will be returned. If you specify "no", both "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices will be returned.
type VoicesService ¶
type VoicesService struct {
// contains filtered or unexported fields
}
func NewVoicesService ¶
func NewVoicesService(s *Service) *VoicesService
func (*VoicesService) List ¶
func (r *VoicesService) List() *VoicesListCall
List: Returns a list of Voice supported for synthesis.