Cloud Text-to-Speech API v1 - Package cloud.google.com/go/texttospeech/apiv1 (v1.7.6)

Version latest

• 1.7.6 (latest)
• 1.7.5

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Package texttospeech is an auto-generated package for the Cloud Text-to-Speech API.

Synthesizes natural-sounding speech by applying powerful neural network models.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := texttospeech.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := texttospeech.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &texttospeechpb.ListVoicesRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/texttospeech/apiv1/texttospeechpb#ListVoicesRequest.
}
resp, err := c.ListVoices(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

CallOptions

type CallOptions struct {
	ListVoices       []gax.CallOption
	SynthesizeSpeech []gax.CallOption
	GetOperation     []gax.CallOption
	ListOperations   []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// The call options for this service.
	CallOptions *CallOptions
	// contains filtered or unexported fields
}

Client is a client for interacting with Cloud Text-to-Speech API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

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

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new text to speech client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

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

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewRESTClient

func NewRESTClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewRESTClient creates a new text to speech rest client.

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

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) Close

func (c *Client) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Connection (deprecated)

func (c *Client) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*Client) GetOperation

func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

GetOperation is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	texttospeech "cloud.google.com/go/texttospeech/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.GetOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
	}
	resp, err := c.GetOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListOperations

func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator

ListOperations is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	texttospeech "cloud.google.com/go/texttospeech/apiv1"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.ListOperationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
	}
	it := c.ListOperations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListVoices

func (c *Client) ListVoices(ctx context.Context, req *texttospeechpb.ListVoicesRequest, opts ...gax.CallOption) (*texttospeechpb.ListVoicesResponse, error)

ListVoices returns a list of Voice supported for synthesis.

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"

	texttospeechpb "cloud.google.com/go/texttospeech/apiv1/texttospeechpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &texttospeechpb.ListVoicesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/texttospeech/apiv1/texttospeechpb#ListVoicesRequest.
	}
	resp, err := c.ListVoices(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) SynthesizeSpeech

func (c *Client) SynthesizeSpeech(ctx context.Context, req *texttospeechpb.SynthesizeSpeechRequest, opts ...gax.CallOption) (*texttospeechpb.SynthesizeSpeechResponse, error)

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

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"

	texttospeechpb "cloud.google.com/go/texttospeech/apiv1/texttospeechpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &texttospeechpb.SynthesizeSpeechRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/texttospeech/apiv1/texttospeechpb#SynthesizeSpeechRequest.
	}
	resp, err := c.SynthesizeSpeech(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

OperationIterator

type OperationIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error)
	// contains filtered or unexported fields
}

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator) Next

func (it *OperationIterator) Next() (*longrunningpb.Operation, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*OperationIterator) PageInfo

func (it *OperationIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

SynthesizeLongAudioOperation

type SynthesizeLongAudioOperation struct {
	// contains filtered or unexported fields
}

SynthesizeLongAudioOperation manages a long-running operation from SynthesizeLongAudio.

func (*SynthesizeLongAudioOperation) Done

func (op *SynthesizeLongAudioOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*SynthesizeLongAudioOperation) Metadata

func (op *SynthesizeLongAudioOperation) Metadata() (*texttospeechpb.SynthesizeLongAudioMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*SynthesizeLongAudioOperation) Name

func (op *SynthesizeLongAudioOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*SynthesizeLongAudioOperation) Poll

func (op *SynthesizeLongAudioOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*texttospeechpb.SynthesizeLongAudioResponse, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*SynthesizeLongAudioOperation) Wait

func (op *SynthesizeLongAudioOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*texttospeechpb.SynthesizeLongAudioResponse, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

TextToSpeechLongAudioSynthesizeCallOptions

type TextToSpeechLongAudioSynthesizeCallOptions struct {
	SynthesizeLongAudio []gax.CallOption
	GetOperation        []gax.CallOption
	ListOperations      []gax.CallOption
}

TextToSpeechLongAudioSynthesizeCallOptions contains the retry settings for each method of TextToSpeechLongAudioSynthesizeClient.

TextToSpeechLongAudioSynthesizeClient

type TextToSpeechLongAudioSynthesizeClient struct {

	// The call options for this service.
	CallOptions *TextToSpeechLongAudioSynthesizeCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

TextToSpeechLongAudioSynthesizeClient is a client for interacting with Cloud Text-to-Speech API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

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

func NewTextToSpeechLongAudioSynthesizeClient

func NewTextToSpeechLongAudioSynthesizeClient(ctx context.Context, opts ...option.ClientOption) (*TextToSpeechLongAudioSynthesizeClient, error)

NewTextToSpeechLongAudioSynthesizeClient creates a new text to speech long audio synthesize client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

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

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewTextToSpeechLongAudioSynthesizeClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewTextToSpeechLongAudioSynthesizeRESTClient

func NewTextToSpeechLongAudioSynthesizeRESTClient(ctx context.Context, opts ...option.ClientOption) (*TextToSpeechLongAudioSynthesizeClient, error)

NewTextToSpeechLongAudioSynthesizeRESTClient creates a new text to speech long audio synthesize rest client.

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

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewTextToSpeechLongAudioSynthesizeRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*TextToSpeechLongAudioSynthesizeClient) Close

func (c *TextToSpeechLongAudioSynthesizeClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*TextToSpeechLongAudioSynthesizeClient) Connection (deprecated)

func (c *TextToSpeechLongAudioSynthesizeClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*TextToSpeechLongAudioSynthesizeClient) GetOperation

func (c *TextToSpeechLongAudioSynthesizeClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)

GetOperation is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	texttospeech "cloud.google.com/go/texttospeech/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewTextToSpeechLongAudioSynthesizeClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.GetOperationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
	}
	resp, err := c.GetOperation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*TextToSpeechLongAudioSynthesizeClient) ListOperations

func (c *TextToSpeechLongAudioSynthesizeClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator

ListOperations is a utility method from google.longrunning.Operations.

Example

package main

import (
	"context"

	longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
	texttospeech "cloud.google.com/go/texttospeech/apiv1"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewTextToSpeechLongAudioSynthesizeClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &longrunningpb.ListOperationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
	}
	it := c.ListOperations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*TextToSpeechLongAudioSynthesizeClient) SynthesizeLongAudio

func (c *TextToSpeechLongAudioSynthesizeClient) SynthesizeLongAudio(ctx context.Context, req *texttospeechpb.SynthesizeLongAudioRequest, opts ...gax.CallOption) (*SynthesizeLongAudioOperation, error)

SynthesizeLongAudio synthesizes long form text asynchronously.

Example

package main

import (
	"context"

	texttospeech "cloud.google.com/go/texttospeech/apiv1"

	texttospeechpb "cloud.google.com/go/texttospeech/apiv1/texttospeechpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := texttospeech.NewTextToSpeechLongAudioSynthesizeClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &texttospeechpb.SynthesizeLongAudioRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/texttospeech/apiv1/texttospeechpb#SynthesizeLongAudioRequest.
	}
	op, err := c.SynthesizeLongAudio(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*TextToSpeechLongAudioSynthesizeClient) SynthesizeLongAudioOperation

func (c *TextToSpeechLongAudioSynthesizeClient) SynthesizeLongAudioOperation(name string) *SynthesizeLongAudioOperation

SynthesizeLongAudioOperation returns a new SynthesizeLongAudioOperation from a given name. The name must be that of a previously created SynthesizeLongAudioOperation, possibly from a different process.