1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package types
4
5import (
6	"time"
7)
8
9// Provides lexicon name and lexicon content in string format. For more
10// information, see Pronunciation Lexicon Specification (PLS) Version 1.0
11// (https://www.w3.org/TR/pronunciation-lexicon/).
12type Lexicon struct {
13
14	// Lexicon content in string format. The content of a lexicon must be in PLS
15	// format.
16	Content *string
17
18	// Name of the lexicon.
19	Name *string
20}
21
22// Contains metadata describing the lexicon such as the number of lexemes, language
23// code, and so on. For more information, see Managing Lexicons
24// (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).
25type LexiconAttributes struct {
26
27	// Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
28	Alphabet *string
29
30	// Language code that the lexicon applies to. A lexicon with a language code such
31	// as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS,
32	// and so on.
33	LanguageCode LanguageCode
34
35	// Date lexicon was last modified (a timestamp value).
36	LastModified *time.Time
37
38	// Number of lexemes in the lexicon.
39	LexemesCount int32
40
41	// Amazon Resource Name (ARN) of the lexicon.
42	LexiconArn *string
43
44	// Total size of the lexicon, in characters.
45	Size int32
46}
47
48// Describes the content of the lexicon.
49type LexiconDescription struct {
50
51	// Provides lexicon metadata.
52	Attributes *LexiconAttributes
53
54	// Name of the lexicon.
55	Name *string
56}
57
58// SynthesisTask object that provides information about a speech synthesis task.
59type SynthesisTask struct {
60
61	// Timestamp for the time the synthesis task was started.
62	CreationTime *time.Time
63
64	// Specifies the engine (standard or neural) for Amazon Polly to use when
65	// processing input text for speech synthesis. Using a voice that is not supported
66	// for the engine selected will result in an error.
67	Engine Engine
68
69	// Optional language code for a synthesis task. This is only necessary if using a
70	// bilingual voice, such as Aditi, which can be used for either Indian English
71	// (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is
72	// specified, Amazon Polly will use the default language of the bilingual voice.
73	// The default language for any voice is the one returned by the DescribeVoices
74	// (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation
75	// for the LanguageCode parameter. For example, if no language code is specified,
76	// Aditi will use Indian English rather than Hindi.
77	LanguageCode LanguageCode
78
79	// List of one or more pronunciation lexicon names you want the service to apply
80	// during synthesis. Lexicons are applied only if the language of the lexicon is
81	// the same as the language of the voice.
82	LexiconNames []string
83
84	// The format in which the returned output will be encoded. For audio stream, this
85	// will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
86	OutputFormat OutputFormat
87
88	// Pathway for the output speech file.
89	OutputUri *string
90
91	// Number of billable characters synthesized.
92	RequestCharacters int32
93
94	// The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are
95	// "8000", "16000", "22050", and "24000". The default value for standard voices is
96	// "22050". The default value for neural voices is "24000". Valid values for pcm
97	// are "8000" and "16000" The default value is "16000".
98	SampleRate *string
99
100	// ARN for the SNS topic optionally used for providing status notification for a
101	// speech synthesis task.
102	SnsTopicArn *string
103
104	// The type of speech marks returned for the input text.
105	SpeechMarkTypes []SpeechMarkType
106
107	// The Amazon Polly generated identifier for a speech synthesis task.
108	TaskId *string
109
110	// Current status of the individual speech synthesis task.
111	TaskStatus TaskStatus
112
113	// Reason for the current status of a specific speech synthesis task, including
114	// errors if the task has failed.
115	TaskStatusReason *string
116
117	// Specifies whether the input text is plain text or SSML. The default value is
118	// plain text.
119	TextType TextType
120
121	// Voice ID to use for the synthesis.
122	VoiceId VoiceId
123}
124
125// Description of the voice.
126type Voice struct {
127
128	// Additional codes for languages available for the specified voice in addition to
129	// its default language. For example, the default language for Aditi is Indian
130	// English (en-IN) because it was first used for that language. Since Aditi is
131	// bilingual and fluent in both Indian English and Hindi, this parameter would show
132	// the code hi-IN.
133	AdditionalLanguageCodes []LanguageCode
134
135	// Gender of the voice.
136	Gender Gender
137
138	// Amazon Polly assigned voice ID. This is the ID that you specify when calling the
139	// SynthesizeSpeech operation.
140	Id VoiceId
141
142	// Language code of the voice.
143	LanguageCode LanguageCode
144
145	// Human readable name of the language in English.
146	LanguageName *string
147
148	// Name of the voice (for example, Salli, Kendra, etc.). This provides a human
149	// readable voice name that you might display in your application.
150	Name *string
151
152	// Specifies which engines (standard or neural) that are supported by a given
153	// voice.
154	SupportedEngines []Engine
155}
156