org.rewedigital.dialog.ssml

Class SsmlBuilder

org.rewedigital.dialog.ssml.SsmlBuilder

public class SsmlBuilder

Helper class for construction of SSML https//www.w3.org/TR/speech-synthesis11/ based responses. This Helper only contain the supported SSML tags for Amazon Alexa and the Google Assistant.

See Also:

https//www.w3.org/TR/speech-synthesis11/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SsmlBuilder.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static SsmlBuilder.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
SsmlBuilder(java.lang.String text) Helper class for construction of SSML https//www.w3.org/TR/speech-synthesis11/ based responses. This Helper only contain the supported SSML tags for Amazon Alexa and the Google Assistant.
SsmlBuilder() Helper class for construction of SSML https//www.w3.org/TR/speech-synthesis11/ based responses. This Helper only contain the supported SSML tags for Amazon Alexa and the Google Assistant.

Method Summary

Modifier and Type	Method and Description
SsmlBuilder	appendAlexaSpeechcon(java.lang.String speechcon) This will add a tag with the given speechcon for Alexa. https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons
SsmlBuilder	appendAlexaSpeechconRandom(java.lang.String... speechcons) This will add a tag with a randomly chosen speechcon for Alexa. https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons
SsmlBuilder	appendAmazonEffect(java.lang.String text, AmazonEffect amazonEffect) This will add the <> https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#amazon-effect tag with the enum AmazonEffect to a given string.
SsmlBuilder	appendAudio(java.lang.String url) This will add the https//www.w3.org/TR/speech-synthesis11/#S3.3.1 tag with the given URL.
SsmlBuilder	appendBreak(Strength strength, java.lang.Integer timeInMs) This will add the https//www.w3.org/TR/speech-synthesis11/#S3.2.3 tag to the SSML string. You can either choose to set a enum Strength, a time in milliseconds or the default for the break.
SsmlBuilder	appendEmphasis(Emphasis emphasis, java.lang.String text) This will add the https//www.w3.org/TR/speech-synthesis11/#S3.2.2 tag with the attribute enum Emphasis to a given string.
SsmlBuilder	appendRandomOf(java.lang.String... text) This will randomly append one of the given strings to this class SsmlBuilder
SsmlBuilder	appendRandomSpeechOf(java.lang.String... text)
SsmlBuilder	appendSayAs(InterpretAs interpretAs, java.lang.String text) This will add the https//www.w3.org/TR/speech-synthesis11/#S3.1.9 tag with the attribute enum InterpretAs to a given string.
SsmlBuilder	appendSlowText(java.lang.String text) This will add the tag https//www.w3.org/TR/speech-synthesis11/#S3.2.3 to the given string.
SsmlBuilder	appendSpeech(java.lang.String text)
SsmlBuilder	appendSubAlias(java.lang.String text, java.lang.String alias) This will add a https//www.w3.org/TR/speech-synthesis11/#S3.1.11 tag with the given text and alias.
SsmlBuilder	appendText(java.lang.String text) This will add more text to the class SsmlBuilder
SsmlBuilder	appendText(SsmlBuilder text) This will add an other class SsmlBuilder to this one.
java.lang.String	asDisplayText() Returns the containing string without any SSML tags.
java.lang.String	asSsmlString() Returns the containing string with a start and end tag.
SsmlBuilder	plus(java.lang.String text) This will add more text to the class SsmlBuilder
SsmlBuilder	plus(SsmlBuilder text) This will add an other class SsmlBuilder to this one.
java.lang.String	toString() Returns the containing string.

Field Detail

Companion

public static SsmlBuilder.Companion Companion

Constructor Detail

SsmlBuilder

public SsmlBuilder(@NotNull
                   java.lang.String text)

Helper class for construction of SSML https//www.w3.org/TR/speech-synthesis11/ based responses. This Helper only contain the supported SSML tags for Amazon Alexa and the Google Assistant.

See Also:

https//www.w3.org/TR/speech-synthesis11/

SsmlBuilder

public SsmlBuilder()

Helper class for construction of SSML https//www.w3.org/TR/speech-synthesis11/ based responses. This Helper only contain the supported SSML tags for Amazon Alexa and the Google Assistant.

See Also:

https//www.w3.org/TR/speech-synthesis11/

Method Detail

appendBreak

@NotNull
public SsmlBuilder appendBreak(@Nullable
                                         Strength strength,
                                         @Nullable
                                         java.lang.Integer timeInMs)

This will add the https//www.w3.org/TR/speech-synthesis11/#S3.2.3 tag to the SSML string. You can either choose to set a enum Strength, a time in milliseconds or the default for the break.

See Also:

https//www.w3.org/TR/speech-synthesis11/#S3.2.3, enum Strength

appendSlowText

@NotNull
public SsmlBuilder appendSlowText(@NotNull
                                            java.lang.String text)

This will add the tag https//www.w3.org/TR/speech-synthesis11/#S3.2.3 to the given string.

See Also:

https//www.w3.org/TR/speech-synthesis11/#S3.2.3

appendAudio

@NotNull
public SsmlBuilder appendAudio(@NotNull
                                         java.lang.String url)

This will add the https//www.w3.org/TR/speech-synthesis11/#S3.3.1 tag with the given URL.

See Also:

https//www.w3.org/TR/speech-synthesis11/#S3.3.1

appendSayAs

@NotNull
public SsmlBuilder appendSayAs(@NotNull
                                         InterpretAs interpretAs,
                                         @NotNull
                                         java.lang.String text)

This will add the https//www.w3.org/TR/speech-synthesis11/#S3.1.9 tag with the attribute enum InterpretAs to a given string.

See Also:

https//www.w3.org/TR/speech-synthesis11/#S3.1.9, enum InterpretAs

appendEmphasis

@NotNull
public SsmlBuilder appendEmphasis(@NotNull
                                            Emphasis emphasis,
                                            @NotNull
                                            java.lang.String text)

This will add the https//www.w3.org/TR/speech-synthesis11/#S3.2.2 tag with the attribute enum Emphasis to a given string.

See Also:

https//www.w3.org/TR/speech-synthesis11/#S3.2.2, enum Emphasis

appendAmazonEffect

@NotNull
public SsmlBuilder appendAmazonEffect(@NotNull
                                                java.lang.String text,
                                                @NotNull
                                                AmazonEffect amazonEffect)

This will add the <> https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#amazon-effect tag with the enum AmazonEffect to a given string.

See Also:

https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#amazon-effect, enum AmazonEffect

appendAlexaSpeechcon

@NotNull
public SsmlBuilder appendAlexaSpeechcon(@NotNull
                                                  java.lang.String speechcon)

This will add a tag with the given speechcon for Alexa. https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons

See Also:

https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons

appendAlexaSpeechconRandom

@NotNull
public SsmlBuilder appendAlexaSpeechconRandom(@NotNull
                                                        java.lang.String... speechcons)

This will add a tag with a randomly chosen speechcon for Alexa. https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons

See Also:

https//developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons

appendText

@NotNull
public SsmlBuilder appendText(@NotNull
                                        java.lang.String text)

This will add more text to the class SsmlBuilder

See Also:

class SsmlBuilder

appendText

@NotNull
public SsmlBuilder appendText(@NotNull
                                        SsmlBuilder text)

This will add an other class SsmlBuilder to this one.

See Also:

class SsmlBuilder

plus

@NotNull
public SsmlBuilder plus(@NotNull
                                  java.lang.String text)

This will add more text to the class SsmlBuilder

See Also:

class SsmlBuilder

plus

@NotNull
public SsmlBuilder plus(@NotNull
                                  SsmlBuilder text)

This will add an other class SsmlBuilder to this one.

See Also:

class SsmlBuilder

appendRandomOf

@NotNull
public SsmlBuilder appendRandomOf(@NotNull
                                            java.lang.String... text)

This will randomly append one of the given strings to this class SsmlBuilder

See Also:

class SsmlBuilder

appendSubAlias

@NotNull
public SsmlBuilder appendSubAlias(@NotNull
                                            java.lang.String text,
                                            @NotNull
                                            java.lang.String alias)

This will add a https//www.w3.org/TR/speech-synthesis11/#S3.1.11 tag with the given text and alias.

See Also:

https//www.w3.org/TR/speech-synthesis11/#S3.1.11

appendSpeech

@NotNull
public SsmlBuilder appendSpeech(@NotNull
                                          java.lang.String text)

appendRandomSpeechOf

@NotNull
public SsmlBuilder appendRandomSpeechOf(@NotNull
                                                  java.lang.String... text)

asDisplayText

@NotNull
public java.lang.String asDisplayText()

Returns the containing string without any SSML tags.

toString

@NotNull
public java.lang.String toString()

Returns the containing string.

asSsmlString

@NotNull
public java.lang.String asSsmlString()

Returns the containing string with a start and end tag.