io.micronaut.aws.alexa.ssml

Class Ssml

java.lang.Object

io.micronaut.aws.alexa.ssml.Ssml

public class Ssml
extends java.lang.Object

Speech Synthesis Markup Language builder.

Since:

2.0.0

Author:

sdelamo

See Also:

SSML.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME
static java.lang.String	CLOSE_OPENING_TAG
static java.lang.String	CLOSE_TAG
static java.lang.String	FORMAT
static java.lang.String	INTERPRET_AS
static java.lang.String	OPEN_CLOSE_TAG
static java.lang.String	OPEN_TAG
static java.lang.String	PITCH
static java.lang.String	RATE
static java.lang.String	SRC
static java.lang.String	TAG_AMAZON_DOMAIN
static java.lang.String	TAG_AMAZON_EFFECT
static java.lang.String	TAG_AMAZON_EMOTION
static java.lang.String	TAG_AUDIO
static java.lang.String	TAG_BREAK
static java.lang.String	TAG_EMPHASIS
static java.lang.String	TAG_LANG
static java.lang.String	TAG_P
static java.lang.String	TAG_PHONEME
static java.lang.String	TAG_PROSODY
static java.lang.String	TAG_S
static java.lang.String	TAG_SAY_AS
static java.lang.String	TAG_SPEAK
static java.lang.String	TAG_SUB
static java.lang.String	TAG_VOICE
static java.lang.String	TAG_W
static java.lang.String	VOLUME
static java.lang.String	XML_LANG

Constructor Summary

Constructors

Constructor and Description
Ssml() Constructor.
Ssml(java.lang.String text)

Method Summary

Modifier and Type	Method and Description
Ssml	audio(java.lang.String src) The audio tag lets you provide the URL for an MP3 file that the Alexa service can play while rendering a response.
Ssml	breakWithMilliseconds(java.lang.Integer milliseconds)
Ssml	breakWithSeconds(java.lang.Integer seconds)
Ssml	breakWithStrength(BreakStrength strength)
java.lang.String	build()
Ssml	domain(AmazonDomain domain, java.lang.String text) Applies different speaking styles to the speech.
Ssml	effect(AmazonEffect effect, java.lang.String text) Applies Amazon-specific effect to the speech.
Ssml	emotion(AmazonEmotion emotion, AmazonEmotionIntensity intensity, java.lang.String text)
Ssml	emphasis(java.lang.String text, EmphasisLevel emphasisLevel)
Ssml	lang(java.lang.String text, SupportedLang lang)
Ssml	p(java.lang.String text)
Ssml	paragraph(java.lang.String text)
Ssml	prosody(java.lang.String text, ProsodyRate rate, ProsodyPitch pitch, ProsodyVolume volume)
Ssml	s(java.lang.String text)
Ssml	sayAs(java.lang.String text, InterpretAs interpretAs, InterpretAsDateFormat interpretAsDateFormat)
Ssml	sentence(java.lang.String text)
Ssml	speak(java.lang.String text)
Ssml	sub(java.lang.String text, java.lang.String alias)
Ssml	text(java.lang.String text)
Ssml	voice(java.lang.String text, Voice voice)
Ssml	w(java.lang.String text, WordRole role)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

See Also:

Constant Field Values

OPEN_TAG

public static final java.lang.String OPEN_TAG

See Also:

Constant Field Values

CLOSE_TAG

public static final java.lang.String CLOSE_TAG

See Also:

Constant Field Values

OPEN_CLOSE_TAG

public static final java.lang.String OPEN_CLOSE_TAG

See Also:

Constant Field Values

CLOSE_OPENING_TAG

public static final java.lang.String CLOSE_OPENING_TAG

See Also:

Constant Field Values

INTERPRET_AS

public static final java.lang.String INTERPRET_AS

See Also:

Constant Field Values

FORMAT

public static final java.lang.String FORMAT

See Also:

Constant Field Values

TAG_AMAZON_DOMAIN

public static final java.lang.String TAG_AMAZON_DOMAIN

See Also:

Constant Field Values

TAG_AMAZON_EFFECT

public static final java.lang.String TAG_AMAZON_EFFECT

See Also:

Constant Field Values

TAG_AMAZON_EMOTION

public static final java.lang.String TAG_AMAZON_EMOTION

See Also:

Constant Field Values

TAG_AUDIO

public static final java.lang.String TAG_AUDIO

See Also:

Constant Field Values

TAG_BREAK

public static final java.lang.String TAG_BREAK

See Also:

Constant Field Values

TAG_EMPHASIS

public static final java.lang.String TAG_EMPHASIS

See Also:

Constant Field Values

TAG_LANG

public static final java.lang.String TAG_LANG

See Also:

Constant Field Values

TAG_P

public static final java.lang.String TAG_P

See Also:

Constant Field Values

TAG_PHONEME

public static final java.lang.String TAG_PHONEME

See Also:

Constant Field Values

TAG_PROSODY

public static final java.lang.String TAG_PROSODY

See Also:

Constant Field Values

TAG_S

public static final java.lang.String TAG_S

See Also:

Constant Field Values

TAG_SAY_AS

public static final java.lang.String TAG_SAY_AS

See Also:

Constant Field Values

TAG_SPEAK

public static final java.lang.String TAG_SPEAK

See Also:

Constant Field Values

TAG_SUB

public static final java.lang.String TAG_SUB

See Also:

Constant Field Values

TAG_VOICE

public static final java.lang.String TAG_VOICE

See Also:

Constant Field Values

TAG_W

public static final java.lang.String TAG_W

See Also:

Constant Field Values

XML_LANG

public static final java.lang.String XML_LANG

See Also:

Constant Field Values

RATE

public static final java.lang.String RATE

See Also:

Constant Field Values

PITCH

public static final java.lang.String PITCH

See Also:

Constant Field Values

VOLUME

public static final java.lang.String VOLUME

See Also:

Constant Field Values

SRC

public static final java.lang.String SRC

See Also:

Constant Field Values

Constructor Detail

Ssml

public Ssml()

Constructor.

Ssml

public Ssml(java.lang.String text)

Parameters:

text - plain text

Method Detail

domain

public Ssml domain(@NonNull
                   AmazonDomain domain,
                   @NonNull
                   java.lang.String text)

Applies different speaking styles to the speech. The styles are curated text-to-speech voices that employ different variations of intonation, emphasis, pausing and other techniques to match the speech to the type of content. For example, the news style makes Alexa's voice sound like what you might expect to hear in a TV or radio newscast, and was built primarily for customers to listen to news articles and other news-based content.

Parameters:

domain - Name of the speaking style to apply to the speech

text - Text to be wrapped inside the amazon:domain tag

Returns:

An SsmlBuilder with an amazon:domain tag.

audio

public Ssml audio(@NonNull
                  java.lang.String src)

The audio tag lets you provide the URL for an MP3 file that the Alexa service can play while rendering a response.

Parameters:

src - Specifies the URL for the MP3 file

Returns:

SSML Builder

effect

public Ssml effect(@NonNull
                   AmazonEffect effect,
                   @NonNull
                   java.lang.String text)

Applies Amazon-specific effect to the speech.

Parameters:

effect - Effect

text - text to apply the effect to

Returns:

Text wrapped in amazon:effect tag

text

public Ssml text(@NonNull
                 java.lang.String text)

Parameters:

text - plain text

Returns:

Return builder

emotion

public Ssml emotion(@NonNull
                    AmazonEmotion emotion,
                    @NonNull
                    AmazonEmotionIntensity intensity,
                    @NonNull
                    java.lang.String text)

Parameters:

emotion - The name of the emotion to apply to the speech

intensity - The intensity or strength of teh emotion to express.

text - plain text to apply emotion to

Returns:

SSML builder

lang

public Ssml lang(@Nonnull
                 java.lang.String text,
                 @NonNull
                 SupportedLang lang)

Parameters:

text - text to speak tagged as a particular lang

lang - specify the language model and rules to speak the tagged content

Returns:

SSML Builder

paragraph

public Ssml paragraph(@Nonnull
                      java.lang.String text)

Parameters:

text - text to be wrapped in a paragraph

Returns:

SSML builder

prosody

public Ssml prosody(@Nonnull
                    java.lang.String text,
                    @Nullable
                    ProsodyRate rate,
                    @Nullable
                    ProsodyPitch pitch,
                    @Nullable
                    ProsodyVolume volume)

Parameters:

text - text to be wrapped in the prosody tag

rate - Rate of Speech

pitch - Tone (pitch) of the speech

volume - Volume of the Speech

Returns:

SSML Builder

sentence

public Ssml sentence(@Nonnull
                     java.lang.String text)

Parameters:

text - Text to be wrapped in a sentence tag (s)

Returns:

SSML builder

speak

public Ssml speak(@Nonnull
                  java.lang.String text)

Parameters:

text - Text to be wrapped in speak tag

Returns:

SSML Builder

s

public Ssml s(@Nonnull
              java.lang.String text)

Parameters:

text - Text to be wrapped in a sentence tag (s)

Returns:

SSML builder

p

public Ssml p(@Nonnull
              java.lang.String text)

Parameters:

text - Text to be wrapped in a paragraph tag

Returns:

SSML builder

sayAs

public Ssml sayAs(@Nonnull
                  java.lang.String text,
                  @NonNull
                  InterpretAs interpretAs,
                  @Nullable
                  InterpretAsDateFormat interpretAsDateFormat)

Parameters:

text - text to be wrapped in a say as tag

interpretAs - Indicate alexa how to interpret text

interpretAsDateFormat - Format to be used when interpret-as is set to date.

Returns:

SSML Builder

w

public Ssml w(@Nonnull
              java.lang.String text,
              @NonNull
              WordRole role)

Parameters:

text - Text to be wrapped

role - Specify role of the word

Returns:

SSML builder

See Also:

SSML w

emphasis

public Ssml emphasis(@Nonnull
                     java.lang.String text,
                     @Nullable
                     EmphasisLevel emphasisLevel)

Parameters:

text - Text to be emphasized

emphasisLevel - Emphasis level

Returns:

SSML builder

breakWithSeconds

public Ssml breakWithSeconds(@NonNull
                             java.lang.Integer seconds)

Parameters:

seconds - duration of break in seconds

Returns:

SSML Builder

See Also:

SSML Break.

voice

public Ssml voice(@NonNull
                  java.lang.String text,
                  @NonNull
                  Voice voice)

Parameters:

text - text to be spoken in a particular voice

voice - Amazon Polly voice to speak the text with

Returns:

SSML Builder

sub

public Ssml sub(@NonNull
                java.lang.String text,
                @NonNull
                java.lang.String alias)

Parameters:

text - text to be pronouced differently

alias - pronunciation to substitute

Returns:

SSML

breakWithMilliseconds

public Ssml breakWithMilliseconds(@NonNull
                                  java.lang.Integer milliseconds)

Parameters:

milliseconds - duration of break in milliseconds

Returns:

SSML Builder

See Also:

SSML Break

breakWithStrength

public Ssml breakWithStrength(@NonNull
                              BreakStrength strength)

Parameters:

strength - Break strength

Returns:

SSML Builder

See Also:

SSML Break

build

public java.lang.String build()

Returns:

SSML as String