Network.AWS.Polly.SynthesizeSpeech

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:

• ssSpeechMarkTypes - The type of speech marks returned for the input text.
• 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 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.
• 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

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

(==) :: SynthesizeSpeech -> SynthesizeSpeech -> Bool

(/=) :: SynthesizeSpeech -> SynthesizeSpeech -> Bool

Data SynthesizeSpeech

Defined in Network.AWS.Polly.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

Show SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

showsPrec :: Int -> SynthesizeSpeech -> ShowS

show :: SynthesizeSpeech -> String

showList :: [SynthesizeSpeech] -> ShowS

Generic SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Associated Types

type Rep SynthesizeSpeech :: Type -> Type

Methods

from :: SynthesizeSpeech -> Rep SynthesizeSpeech x

to :: Rep SynthesizeSpeech x -> SynthesizeSpeech

Hashable SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

hashWithSalt :: Int -> SynthesizeSpeech -> Int

hash :: SynthesizeSpeech -> Int

ToJSON SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

toJSON :: SynthesizeSpeech -> Value

toEncoding :: SynthesizeSpeech -> Encoding

toJSONList :: [SynthesizeSpeech] -> Value

toEncodingList :: [SynthesizeSpeech] -> Encoding

AWSRequest SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Associated Types

type Rs SynthesizeSpeech :: Type

Methods

request :: SynthesizeSpeech -> Request SynthesizeSpeech

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SynthesizeSpeech -> ClientResponse -> m (Response SynthesizeSpeech)

ToHeaders SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

toHeaders :: SynthesizeSpeech -> [Header]

ToPath SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

toPath :: SynthesizeSpeech -> ByteString

ToQuery SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

toQuery :: SynthesizeSpeech -> QueryString

NFData SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

rnf :: SynthesizeSpeech -> ()

type Rep SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

type Rep SynthesizeSpeech = D1 (MetaData "SynthesizeSpeech" "Network.AWS.Polly.SynthesizeSpeech" "amazonka-polly-1.6.1-F2G7y4pa5Zy7tjUQirknXR" False) (C1 (MetaCons "SynthesizeSpeech'" PrefixI True) ((S1 (MetaSel (Just "_ssSpeechMarkTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SpeechMarkType])) :*: (S1 (MetaSel (Just "_ssSampleRate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ssTextType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TextType)))) :*: ((S1 (MetaSel (Just "_ssLexiconNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Sensitive Text])) :*: S1 (MetaSel (Just "_ssOutputFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OutputFormat)) :*: (S1 (MetaSel (Just "_ssText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ssVoiceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VoiceId)))))

type Rs SynthesizeSpeech

Defined in Network.AWS.Polly.SynthesizeSpeech

type Rs SynthesizeSpeech = SynthesizeSpeechResponse

Request Lenses

ssSpeechMarkTypes :: Lens' SynthesizeSpeech [SpeechMarkType]

The type of speech marks returned for the input text.

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 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.

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 audiopcm in a signed 16-bit, 1 channel (mono), little-endian format. * If you request json as the OutputFormat , the ContentType returned is audiojson.
• ssrsResponseStatus - -- | The response status code.
• ssrsAudioStream - Stream containing the synthesized speech.

data SynthesizeSpeechResponse

See: synthesizeSpeechResponse smart constructor.

Instances

Show SynthesizeSpeechResponse

Defined in Network.AWS.Polly.SynthesizeSpeech

Methods

showsPrec :: Int -> SynthesizeSpeechResponse -> ShowS

show :: SynthesizeSpeechResponse -> String

showList :: [SynthesizeSpeechResponse] -> ShowS

Generic SynthesizeSpeechResponse

Defined in Network.AWS.Polly.SynthesizeSpeech

Associated Types

type Rep SynthesizeSpeechResponse :: Type -> Type

Methods

from :: SynthesizeSpeechResponse -> Rep SynthesizeSpeechResponse x

to :: Rep SynthesizeSpeechResponse x -> SynthesizeSpeechResponse

type Rep SynthesizeSpeechResponse

Defined in Network.AWS.Polly.SynthesizeSpeech

type Rep SynthesizeSpeechResponse = D1 (MetaData "SynthesizeSpeechResponse" "Network.AWS.Polly.SynthesizeSpeech" "amazonka-polly-1.6.1-F2G7y4pa5Zy7tjUQirknXR" False) (C1 (MetaCons "SynthesizeSpeechResponse'" PrefixI True) ((S1 (MetaSel (Just "_ssrsRequestCharacters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_ssrsContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_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 audiopcm in a signed 16-bit, 1 channel (mono), little-endian format. * If you request json as the OutputFormat , the ContentType returned is audiojson.

ssrsResponseStatus :: Lens' SynthesizeSpeechResponse Int

• - | The response status code.

ssrsAudioStream :: Lens' SynthesizeSpeechResponse RsBody

Stream containing the synthesized speech.