package polly
import "github.com/aws/aws-sdk-go-v2/service/polly"
Package polly provides the API client, operations, and parameter types for Amazon Polly.
Amazon Polly is a web service that makes it easy to synthesize speech from text. The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) DeleteLexicon(ctx context.Context, params *DeleteLexiconInput, optFns ...func(*Options)) (*DeleteLexiconOutput, error)
- func (c *Client) DescribeVoices(ctx context.Context, params *DescribeVoicesInput, optFns ...func(*Options)) (*DescribeVoicesOutput, error)
- func (c *Client) GetLexicon(ctx context.Context, params *GetLexiconInput, optFns ...func(*Options)) (*GetLexiconOutput, error)
- func (c *Client) GetSpeechSynthesisTask(ctx context.Context, params *GetSpeechSynthesisTaskInput, optFns ...func(*Options)) (*GetSpeechSynthesisTaskOutput, error)
- func (c *Client) ListLexicons(ctx context.Context, params *ListLexiconsInput, optFns ...func(*Options)) (*ListLexiconsOutput, error)
- func (c *Client) ListSpeechSynthesisTasks(ctx context.Context, params *ListSpeechSynthesisTasksInput, optFns ...func(*Options)) (*ListSpeechSynthesisTasksOutput, error)
- func (c *Client) PutLexicon(ctx context.Context, params *PutLexiconInput, optFns ...func(*Options)) (*PutLexiconOutput, error)
- func (c *Client) StartSpeechSynthesisTask(ctx context.Context, params *StartSpeechSynthesisTaskInput, optFns ...func(*Options)) (*StartSpeechSynthesisTaskOutput, error)
- func (c *Client) SynthesizeSpeech(ctx context.Context, params *SynthesizeSpeechInput, optFns ...func(*Options)) (*SynthesizeSpeechOutput, error)
- type DeleteLexiconInput
- type DeleteLexiconOutput
- type DescribeVoicesInput
- type DescribeVoicesOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetLexiconInput
- type GetLexiconOutput
- type GetSpeechSynthesisTaskInput
- type GetSpeechSynthesisTaskOutput
- type HTTPClient
- type HTTPSignerV4
- type ListLexiconsInput
- type ListLexiconsOutput
- type ListSpeechSynthesisTasksAPIClient
- type ListSpeechSynthesisTasksInput
- type ListSpeechSynthesisTasksOutput
- type ListSpeechSynthesisTasksPaginator
- func NewListSpeechSynthesisTasksPaginator(client ListSpeechSynthesisTasksAPIClient, params *ListSpeechSynthesisTasksInput, optFns ...func(*ListSpeechSynthesisTasksPaginatorOptions)) *ListSpeechSynthesisTasksPaginator
- func (p *ListSpeechSynthesisTasksPaginator) HasMorePages() bool
- func (p *ListSpeechSynthesisTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSpeechSynthesisTasksOutput, error)
- type ListSpeechSynthesisTasksPaginatorOptions
- type Options
- type PutLexiconInput
- type PutLexiconOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type StartSpeechSynthesisTaskInput
- type StartSpeechSynthesisTaskOutput
- type SynthesizeSpeechInput
- type SynthesizeSpeechOutput
Constants ¶
const ServiceAPIVersion = "2016-06-10"
const ServiceID = "Polly"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Polly.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) DeleteLexicon ¶
func (c *Client) DeleteLexicon(ctx context.Context, params *DeleteLexiconInput, optFns ...func(*Options)) (*DeleteLexiconOutput, error)
Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).
func (*Client) DescribeVoices ¶
func (c *Client) DescribeVoices(ctx context.Context, params *DescribeVoicesInput, optFns ...func(*Options)) (*DescribeVoicesOutput, error)
Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name. When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices. For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from. You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices. This operation requires permissions to perform the polly:DescribeVoices action.
func (*Client) GetLexicon ¶
func (c *Client) GetLexicon(ctx context.Context, params *GetLexiconInput, optFns ...func(*Options)) (*GetLexiconOutput, error)
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).
func (*Client) GetSpeechSynthesisTask ¶
func (c *Client) GetSpeechSynthesisTask(ctx context.Context, params *GetSpeechSynthesisTaskInput, optFns ...func(*Options)) (*GetSpeechSynthesisTaskOutput, error)
Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.
func (*Client) ListLexicons ¶
func (c *Client) ListLexicons(ctx context.Context, params *ListLexiconsInput, optFns ...func(*Options)) (*ListLexiconsOutput, error)
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).
func (*Client) ListSpeechSynthesisTasks ¶
func (c *Client) ListSpeechSynthesisTasks(ctx context.Context, params *ListSpeechSynthesisTasksInput, optFns ...func(*Options)) (*ListSpeechSynthesisTasksOutput, error)
Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.
func (*Client) PutLexicon ¶
func (c *Client) PutLexicon(ctx context.Context, params *PutLexiconInput, optFns ...func(*Options)) (*PutLexiconOutput, error)
Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).
func (*Client) StartSpeechSynthesisTask ¶
func (c *Client) StartSpeechSynthesisTask(ctx context.Context, params *StartSpeechSynthesisTaskInput, optFns ...func(*Options)) (*StartSpeechSynthesisTaskOutput, error)
Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.
func (*Client) SynthesizeSpeech ¶
func (c *Client) SynthesizeSpeech(ctx context.Context, params *SynthesizeSpeechInput, optFns ...func(*Options)) (*SynthesizeSpeechOutput, error)
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works (https://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html).
type DeleteLexiconInput ¶
type DeleteLexiconInput struct { // The name of the lexicon to delete. Must be an existing lexicon in the region. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteLexiconOutput ¶
type DeleteLexiconOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeVoicesInput ¶
type DescribeVoicesInput struct { // Specifies the engine (standard or neural) used by Amazon Polly when processing // input text for speech synthesis. Engine types.Engine // Boolean value indicating whether to return any bilingual voices that use the // specified language as an additional language. For instance, if you request all // languages that use US English (es-US), and there is an Italian voice that speaks // both Italian (it-IT) and US English, that voice will be included if you specify // yes but not if you specify no. IncludeAdditionalLanguageCodes bool // The language identification tag (ISO 639 code for the language name-ISO 3166 // country code) for filtering the list of voices returned. If you don't specify // this optional parameter, all available voices are returned. LanguageCode types.LanguageCode // An opaque pagination token returned from the previous DescribeVoices operation. // If present, this indicates where to continue the listing. NextToken *string // contains filtered or unexported fields }
type DescribeVoicesOutput ¶
type DescribeVoicesOutput struct { // The pagination token to use in the next request to continue the listing of // voices. NextToken is returned only if the response is truncated. NextToken *string // A list of voices with their properties. Voices []types.Voice // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetLexiconInput ¶
type GetLexiconInput struct { // Name of the lexicon. // // This member is required. Name *string // contains filtered or unexported fields }
type GetLexiconOutput ¶
type GetLexiconOutput struct { // Lexicon object that provides name and the string content of the lexicon. Lexicon *types.Lexicon // Metadata of the lexicon, including phonetic alphabetic used, language code, // lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in // bytes. LexiconAttributes *types.LexiconAttributes // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSpeechSynthesisTaskInput ¶
type GetSpeechSynthesisTaskInput struct { // The Amazon Polly generated identifier for a speech synthesis task. // // This member is required. TaskId *string // contains filtered or unexported fields }
type GetSpeechSynthesisTaskOutput ¶
type GetSpeechSynthesisTaskOutput struct { // SynthesisTask object that provides information from the requested task, // including output format, creation time, task status, and so on. SynthesisTask *types.SynthesisTask // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type ListLexiconsInput ¶
type ListLexiconsInput struct { // An opaque pagination token returned from previous ListLexicons operation. If // present, indicates where to continue the list of lexicons. NextToken *string // contains filtered or unexported fields }
type ListLexiconsOutput ¶
type ListLexiconsOutput struct { // A list of lexicon names and attributes. Lexicons []types.LexiconDescription // The pagination token to use in the next request to continue the listing of // lexicons. NextToken is returned only if the response is truncated. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSpeechSynthesisTasksAPIClient ¶
type ListSpeechSynthesisTasksAPIClient interface { ListSpeechSynthesisTasks(context.Context, *ListSpeechSynthesisTasksInput, ...func(*Options)) (*ListSpeechSynthesisTasksOutput, error) }
ListSpeechSynthesisTasksAPIClient is a client that implements the ListSpeechSynthesisTasks operation.
type ListSpeechSynthesisTasksInput ¶
type ListSpeechSynthesisTasksInput struct { // Maximum number of speech synthesis tasks returned in a List operation. MaxResults *int32 // The pagination token to use in the next request to continue the listing of // speech synthesis tasks. NextToken *string // Status of the speech synthesis tasks returned in a List operation Status types.TaskStatus // contains filtered or unexported fields }
type ListSpeechSynthesisTasksOutput ¶
type ListSpeechSynthesisTasksOutput struct { // An opaque pagination token returned from the previous List operation in this // request. If present, this indicates where to continue the listing. NextToken *string // List of SynthesisTask objects that provides information from the specified task // in the list request, including output format, creation time, task status, and so // on. SynthesisTasks []types.SynthesisTask // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSpeechSynthesisTasksPaginator ¶
type ListSpeechSynthesisTasksPaginator struct {
// contains filtered or unexported fields
}
ListSpeechSynthesisTasksPaginator is a paginator for ListSpeechSynthesisTasks
func NewListSpeechSynthesisTasksPaginator ¶
func NewListSpeechSynthesisTasksPaginator(client ListSpeechSynthesisTasksAPIClient, params *ListSpeechSynthesisTasksInput, optFns ...func(*ListSpeechSynthesisTasksPaginatorOptions)) *ListSpeechSynthesisTasksPaginator
NewListSpeechSynthesisTasksPaginator returns a new ListSpeechSynthesisTasksPaginator
func (*ListSpeechSynthesisTasksPaginator) HasMorePages ¶
func (p *ListSpeechSynthesisTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSpeechSynthesisTasksPaginator) NextPage ¶
func (p *ListSpeechSynthesisTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSpeechSynthesisTasksOutput, error)
NextPage retrieves the next ListSpeechSynthesisTasks page.
type ListSpeechSynthesisTasksPaginatorOptions ¶
type ListSpeechSynthesisTasksPaginatorOptions struct { // Maximum number of speech synthesis tasks returned in a List operation. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListSpeechSynthesisTasksPaginatorOptions is the paginator options for ListSpeechSynthesisTasks
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PutLexiconInput ¶
type PutLexiconInput struct { // Content of the PLS lexicon as string data. // // This member is required. Content *string // Name of the lexicon. The name must follow the regular express format // [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up // to 20 characters long. // // This member is required. Name *string // contains filtered or unexported fields }
type PutLexiconOutput ¶
type PutLexiconOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartSpeechSynthesisTaskInput ¶
type StartSpeechSynthesisTaskInput struct { // The format in which the returned output will be encoded. For audio stream, this // will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. // // This member is required. OutputFormat types.OutputFormat // Amazon S3 bucket name to which the output file will be saved. // // This member is required. OutputS3BucketName *string // The input text to synthesize. If you specify ssml as the TextType, follow the // SSML format for the input text. // // This member is required. Text *string // Voice ID to use for the synthesis. // // This member is required. VoiceId types.VoiceId // Specifies the engine (standard or neural) for Amazon Polly to use when // processing input text for speech synthesis. Using a voice that is not supported // for the engine selected will result in an error. Engine types.Engine // Optional language code for the Speech Synthesis request. This is only necessary // if using a bilingual voice, such as Aditi, which can be used for either Indian // English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language // code is specified, Amazon Polly uses the default language of the bilingual // voice. The default language for any voice is the one returned by the // DescribeVoices // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation // for the LanguageCode parameter. For example, if no language code is specified, // Aditi will use Indian English rather than Hindi. LanguageCode types.LanguageCode // List of one or more pronunciation lexicon names you want the service to apply // during synthesis. Lexicons are applied only if the language of the lexicon is // the same as the language of the voice. LexiconNames []string // The Amazon S3 key prefix for the output speech file. OutputS3KeyPrefix *string // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are // "8000", "16000", "22050", and "24000". The default value for standard voices is // "22050". The default value for neural voices is "24000". Valid values for pcm // are "8000" and "16000" The default value is "16000". SampleRate *string // ARN for the SNS topic optionally used for providing status notification for a // speech synthesis task. SnsTopicArn *string // The type of speech marks returned for the input text. SpeechMarkTypes []types.SpeechMarkType // Specifies whether the input text is plain text or SSML. The default value is // plain text. TextType types.TextType // contains filtered or unexported fields }
type StartSpeechSynthesisTaskOutput ¶
type StartSpeechSynthesisTaskOutput struct { // SynthesisTask object that provides information and attributes about a newly // submitted speech synthesis task. SynthesisTask *types.SynthesisTask // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SynthesizeSpeechInput ¶
type SynthesizeSpeechInput struct { // The format in which the returned output will be encoded. For audio stream, this // will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. When pcm // is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), // little-endian format. // // This member is required. OutputFormat types.OutputFormat // Input text to synthesize. If you specify ssml as the TextType, follow the SSML // format for the input text. // // This member is required. Text *string // Voice ID to use for the synthesis. You can get a list of available voice IDs by // calling the DescribeVoices // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation. // // This member is required. VoiceId types.VoiceId // Specifies the engine (standard or neural) for Amazon Polly to use when // processing input text for speech synthesis. For information on Amazon Polly // voices and which voices are available in standard-only, NTTS-only, and both // standard and NTTS formats, see Available Voices // (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html). NTTS-only voices // When using NTTS-only voices such as Kevin (en-US), this parameter is required // and must be set to neural. If the engine is not specified, or is set to // standard, this will result in an error. Type: String Valid Values: standard | // neural Required: Yes Standard voices For standard voices, this is not required; // the engine parameter defaults to standard. If the engine is not specified, or is // set to standard and an NTTS-only voice is selected, this will result in an // error. Engine types.Engine // Optional language code for the Synthesize Speech request. This is only necessary // if using a bilingual voice, such as Aditi, which can be used for either Indian // English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language // code is specified, Amazon Polly uses the default language of the bilingual // voice. The default language for any voice is the one returned by the // DescribeVoices // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation // for the LanguageCode parameter. For example, if no language code is specified, // Aditi will use Indian English rather than Hindi. LanguageCode types.LanguageCode // List of one or more pronunciation lexicon names you want the service to apply // during synthesis. Lexicons are applied only if the language of the lexicon is // the same as the language of the voice. For information about storing lexicons, // see PutLexicon // (https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html). LexiconNames []string // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are // "8000", "16000", "22050", and "24000". The default value for standard voices is // "22050". The default value for neural voices is "24000". Valid values for pcm // are "8000" and "16000" The default value is "16000". SampleRate *string // The type of speech marks returned for the input text. SpeechMarkTypes []types.SpeechMarkType // Specifies whether the input text is plain text or SSML. The default value is // plain text. For more information, see Using SSML // (https://docs.aws.amazon.com/polly/latest/dg/ssml.html). TextType types.TextType // contains filtered or unexported fields }
type SynthesizeSpeechOutput ¶
type SynthesizeSpeechOutput struct { // Stream containing the synthesized speech. AudioStream io.ReadCloser // Specifies the type audio stream. This should reflect the OutputFormat parameter // in your request. // // * If you request mp3 as the OutputFormat, the ContentType // returned is audio/mpeg. // // * If you request ogg_vorbis as the OutputFormat, the // ContentType returned is audio/ogg. // // * If you request pcm as the OutputFormat, // the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), // little-endian format. // // * If you request json as the OutputFormat, the // ContentType returned is application/x-json-stream. ContentType *string // Number of characters synthesized. RequestCharacters int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
api_client.go api_op_DeleteLexicon.go api_op_DescribeVoices.go api_op_GetLexicon.go api_op_GetSpeechSynthesisTask.go api_op_ListLexicons.go api_op_ListSpeechSynthesisTasks.go api_op_PutLexicon.go api_op_StartSpeechSynthesisTask.go api_op_SynthesizeSpeech.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.16.1
- Published
- Jun 29, 2022
- Platform
- js/wasm
- Imports
- 32 packages
- Last checked
- now –
Tools for package owners.