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

Network.AWS.Polly.SynthesizeSpeech

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 .

Creating a Request

synthesizeSpeech #

Arguments

:: OutputFormat	`ssOutputFormat`
-> Text	`ssText`
-> VoiceId	`ssVoiceId`
-> SynthesizeSpeech

Creates a value of SynthesizeSpeech with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ssSampleRate - The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050". Valid values for pcm are "8000" and "16000" The default value is "16000".
ssTextType - Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML .
ssLexiconNames - 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 .
ssOutputFormat - The audio format in which the resulting stream will be encoded.
ssText - Input text to synthesize. If you specify ssml as the TextType , follow the SSML format for the input text.
ssVoiceId - Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

data SynthesizeSpeech #

See: synthesizeSpeech smart constructor.

Instances

Eq SynthesizeSpeech #
Methods (==) :: SynthesizeSpeech -> SynthesizeSpeech -> Bool # (/=) :: SynthesizeSpeech -> SynthesizeSpeech -> Bool #
Data SynthesizeSpeech #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SynthesizeSpeech -> c SynthesizeSpeech # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SynthesizeSpeech # toConstr :: SynthesizeSpeech -> Constr # dataTypeOf :: SynthesizeSpeech -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SynthesizeSpeech) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SynthesizeSpeech) # gmapT :: (forall b. Data b => b -> b) -> SynthesizeSpeech -> SynthesizeSpeech # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SynthesizeSpeech -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SynthesizeSpeech -> r # gmapQ :: (forall d. Data d => d -> u) -> SynthesizeSpeech -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SynthesizeSpeech -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SynthesizeSpeech -> m SynthesizeSpeech # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SynthesizeSpeech -> m SynthesizeSpeech # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SynthesizeSpeech -> m SynthesizeSpeech #
Read SynthesizeSpeech #
Methods readsPrec :: Int -> ReadS SynthesizeSpeech # readList :: ReadS [SynthesizeSpeech] # readPrec :: ReadPrec SynthesizeSpeech # readListPrec :: ReadPrec [SynthesizeSpeech] #
Show SynthesizeSpeech #
Methods showsPrec :: Int -> SynthesizeSpeech -> ShowS # show :: SynthesizeSpeech -> String # showList :: [SynthesizeSpeech] -> ShowS #
Generic SynthesizeSpeech #
Associated Types type Rep SynthesizeSpeech :: * -> * # Methods from :: SynthesizeSpeech -> Rep SynthesizeSpeech x # to :: Rep SynthesizeSpeech x -> SynthesizeSpeech #
Hashable SynthesizeSpeech #
Methods hashWithSalt :: Int -> SynthesizeSpeech -> Int # hash :: SynthesizeSpeech -> Int #
ToJSON SynthesizeSpeech #
Methods toJSON :: SynthesizeSpeech -> Value # toEncoding :: SynthesizeSpeech -> Encoding # toJSONList :: [SynthesizeSpeech] -> Value # toEncodingList :: [SynthesizeSpeech] -> Encoding #
NFData SynthesizeSpeech #
Methods rnf :: SynthesizeSpeech -> () #
AWSRequest SynthesizeSpeech #
Associated Types type Rs SynthesizeSpeech :: * # Methods request :: SynthesizeSpeech -> Request SynthesizeSpeech # response :: MonadResource m => Logger -> Service -> Proxy * SynthesizeSpeech -> ClientResponse -> m (Response SynthesizeSpeech) #
ToQuery SynthesizeSpeech #
Methods toQuery :: SynthesizeSpeech -> QueryString #
ToPath SynthesizeSpeech #
Methods toPath :: SynthesizeSpeech -> ByteString #
ToHeaders SynthesizeSpeech #
Methods toHeaders :: SynthesizeSpeech -> [Header] #
type Rep SynthesizeSpeech #
type Rep SynthesizeSpeech = D1 (MetaData "SynthesizeSpeech" "Network.AWS.Polly.SynthesizeSpeech" "amazonka-polly-1.4.5-3YfKeYS4XLXGLJOiC47xgO" False) (C1 (MetaCons "SynthesizeSpeech'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_ssSampleRate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_ssTextType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TextType))) (S1 (MetaSel (Just Symbol "_ssLexiconNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Sensitive Text]))))) ((::) (S1 (MetaSel (Just Symbol "_ssOutputFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OutputFormat)) ((:*:) (S1 (MetaSel (Just Symbol "_ssText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ssVoiceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VoiceId))))))
type Rs SynthesizeSpeech #
type Rs SynthesizeSpeech = SynthesizeSpeechResponse

Request Lenses

ssSampleRate :: Lens' SynthesizeSpeech (Maybe Text) #

The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050". Valid values for pcm are "8000" and "16000" The default value is "16000".

ssTextType :: Lens' SynthesizeSpeech (Maybe TextType) #

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML .

ssLexiconNames :: Lens' SynthesizeSpeech [Text] #

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 .

ssOutputFormat :: Lens' SynthesizeSpeech OutputFormat #

The audio format in which the resulting stream will be encoded.

ssText :: Lens' SynthesizeSpeech Text #

Input text to synthesize. If you specify ssml as the TextType , follow the SSML format for the input text.

ssVoiceId :: Lens' SynthesizeSpeech VoiceId #

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Destructuring the Response

synthesizeSpeechResponse #

Arguments

:: Int	`ssrsResponseStatus`
-> RsBody	`ssrsAudioStream`
-> SynthesizeSpeechResponse

Creates a value of SynthesizeSpeechResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ssrsRequestCharacters - Number of characters synthesized.
ssrsContentType - 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 audiompeg. * If you request ogg_vorbis as the OutputFormat , the ContentType returned is audioogg. * If you request pcm as the OutputFormat , the ContentType returned is audio/pcm.
ssrsResponseStatus - -- | The response status code.
ssrsAudioStream - Stream containing the synthesized speech.

data SynthesizeSpeechResponse #

See: synthesizeSpeechResponse smart constructor.

Instances

Show SynthesizeSpeechResponse #
Methods showsPrec :: Int -> SynthesizeSpeechResponse -> ShowS # show :: SynthesizeSpeechResponse -> String # showList :: [SynthesizeSpeechResponse] -> ShowS #
Generic SynthesizeSpeechResponse #
Associated Types type Rep SynthesizeSpeechResponse :: * -> * # Methods from :: SynthesizeSpeechResponse -> Rep SynthesizeSpeechResponse x # to :: Rep SynthesizeSpeechResponse x -> SynthesizeSpeechResponse #
type Rep SynthesizeSpeechResponse #
type Rep SynthesizeSpeechResponse = D1 (MetaData "SynthesizeSpeechResponse" "Network.AWS.Polly.SynthesizeSpeech" "amazonka-polly-1.4.5-3YfKeYS4XLXGLJOiC47xgO" False) (C1 (MetaCons "SynthesizeSpeechResponse'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_ssrsRequestCharacters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_ssrsContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ssrsAudioStream") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RsBody)))))

Response Lenses

ssrsRequestCharacters :: Lens' SynthesizeSpeechResponse (Maybe Int) #

Number of characters synthesized.

ssrsContentType :: Lens' SynthesizeSpeechResponse (Maybe Text) #

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 audiompeg. * If you request ogg_vorbis as the OutputFormat , the ContentType returned is audioogg. * If you request pcm as the OutputFormat , the ContentType returned is audio/pcm.

ssrsResponseStatus :: Lens' SynthesizeSpeechResponse Int #

- | The response status code.

ssrsAudioStream :: Lens' SynthesizeSpeechResponse RsBody #

Stream containing the synthesized speech.