ex_aws_polly v0.4.0 ExAws.Polly
Service module for AWS Polly for speech synthesis.
Link to this section Summary
Functions
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. http://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html
Returns synthesized speech binary from given text. http://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html
Link to this section Types
Link to this section Functions
describe_voices()
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. http://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html
Example
iex> ExAws.Polly.describe_voices() |> ExAws.request()
{:ok,
%{"NextToken" => nil,
"Voices" => [%{"Gender" => "Female", "Id" => "Joanna",
"LanguageCode" => "en-US", "LanguageName" => "US English",
"Name" => "Joanna"},
%{"Gender" => "Male", "Id" => "Takumi",
"LanguageCode" => "ja-JP", "LanguageName" => "Japanese",
"Name" => "Takumi"}, , %{...}, ...]}}
synthesize_speech(text, opts \\ [])
Specs
synthesize_speech(String.t(), synthesize_speech_options()) :: ExAws.Operation.RestQuery.t()
Returns synthesized speech binary from given text. http://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html
Options
:output_format
- The format in which the returned output will be encoded (mp3, ogg_vorbis, or pcm). Default is mp3.:voice_id
- Voice ID to use for the synthesis. You can get a list of available voice IDs by callingExAws.Polly.describe_voices
. Default is "Joanna".:engine
- Specifies the engine (standard
orneural
) to use when processing input text for speech synthesis.:language_code
- 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).:lexicon_names
- List of one or more pronunciation lexicon names you want the service to apply during synthesis.:sample_rate
- The audio frequency specified in Hz. Valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". Valid values for pcm are "8000" and "16000". Default is "16000".:text_type
- Specifies whether the input text is plain text or SSML. Default is plain text.
Example
iex> ExAws.Polly.synthesize_speech("hello world") |> ExAws.request()
{:ok,
%{body: <<73, 68, 51, 4, 0, 0, 0, 0, 0, 35, 84, 83, 83, 69, 0, 0, 0,
15, 0, 0, 3, 76, 97, 118, 102, 53, 55, 46, 55, 49, 46, 49, 48,
48, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 255, 243, 88, ...>>,
headers: [{"x-amzn-RequestId",
"3e7dbbf6-e912-11e7-a27d-e308ce5e5bf6"},
{"x-amzn-RequestCharacters", "5"},
{"Content-Type", "audio/mpeg"}, {"Transfer-Encoding", "chunked"},
{"Date", "Mon, 25 Dec 2017 01:23:42 GMT"}], status_code: 200}}