Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Polly.Types.Voice

Description

Synopsis

data Voice = Voice' {
- languageCode :: Maybe LanguageCode
- languageName :: Maybe Text
- gender :: Maybe Gender
- name :: Maybe Text
- id :: Maybe VoiceId
- additionalLanguageCodes :: Maybe [LanguageCode]
- supportedEngines :: Maybe [Engine]
}
newVoice :: Voice
voice_languageCode :: Lens' Voice (Maybe LanguageCode)
voice_languageName :: Lens' Voice (Maybe Text)
voice_gender :: Lens' Voice (Maybe Gender)
voice_name :: Lens' Voice (Maybe Text)
voice_id :: Lens' Voice (Maybe VoiceId)
voice_additionalLanguageCodes :: Lens' Voice (Maybe [LanguageCode])
voice_supportedEngines :: Lens' Voice (Maybe [Engine])

Documentation

data Voice Source #

Description of the voice.

See: newVoice smart constructor.

Constructors

Voice'

Fields

languageCode :: Maybe LanguageCode
Language code of the voice.
languageName :: Maybe Text
Human readable name of the language in English.
gender :: Maybe Gender
Gender of the voice.
name :: Maybe Text
Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
id :: Maybe VoiceId
Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
additionalLanguageCodes :: Maybe [LanguageCode]
Additional codes for languages available for the specified voice in addition to its default language.
For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
supportedEngines :: Maybe [Engine]
Specifies which engines (standard or neural) that are supported by a given voice.

Instances

Instances details

Eq Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Methods (==) :: Voice -> Voice -> Bool # (/=) :: Voice -> Voice -> Bool #
Read Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Methods readsPrec :: Int -> ReadS Voice # readList :: ReadS [Voice] # readPrec :: ReadPrec Voice # readListPrec :: ReadPrec [Voice] #
Show Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Methods showsPrec :: Int -> Voice -> ShowS # show :: Voice -> String # showList :: [Voice] -> ShowS #
Generic Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Associated Types type Rep Voice :: Type -> Type # Methods from :: Voice -> Rep Voice x # to :: Rep Voice x -> Voice #
NFData Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Methods rnf :: Voice -> () #
Hashable Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Methods hashWithSalt :: Int -> Voice -> Int # hash :: Voice -> Int #
FromJSON Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice Methods parseJSON :: Value -> Parser Voice # parseJSONList :: Value -> Parser [Voice] #
type Rep Voice Source #
Instance details Defined in Amazonka.Polly.Types.Voice type Rep Voice = D1 ('MetaData "Voice" "Amazonka.Polly.Types.Voice" "libZSservicesZSamazonka-pollyZSamazonka-polly" 'False) (C1 ('MetaCons "Voice'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: (S1 ('MetaSel ('Just "languageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Gender)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceId))) :: (S1 ('MetaSel ('Just "additionalLanguageCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LanguageCode])) :: S1 ('MetaSel ('Just "supportedEngines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Engine]))))))

newVoice :: Voice Source #

Create a value of Voice with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:Voice', voice_languageCode - Language code of the voice.

$sel:languageName:Voice', voice_languageName - Human readable name of the language in English.

$sel:gender:Voice', voice_gender - Gender of the voice.

$sel:name:Voice', voice_name - Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

$sel:id:Voice', voice_id - Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

$sel:additionalLanguageCodes:Voice', voice_additionalLanguageCodes - Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

$sel:supportedEngines:Voice', voice_supportedEngines - Specifies which engines (standard or neural) that are supported by a given voice.

voice_languageCode :: Lens' Voice (Maybe LanguageCode) Source #

Language code of the voice.

voice_languageName :: Lens' Voice (Maybe Text) Source #

Human readable name of the language in English.

voice_gender :: Lens' Voice (Maybe Gender) Source #

Gender of the voice.

voice_name :: Lens' Voice (Maybe Text) Source #

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

voice_id :: Lens' Voice (Maybe VoiceId) Source #

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

voice_additionalLanguageCodes :: Lens' Voice (Maybe [LanguageCode]) Source #

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

voice_supportedEngines :: Lens' Voice (Maybe [Engine]) Source #

Specifies which engines (standard or neural) that are supported by a given voice.