Class AmazonSsmlBuilder

Hierarchy

SsmlBuilder
- AmazonSsmlBuilder

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AmazonSsmlBuilder(): AmazonSsmlBuilder

Overrides SsmlBuilder.constructor
- Defined in AmazonSsmlBuilder.ts:14
Returns AmazonSsmlBuilder

Properties

Protected stack

stack: string[]

Protected textToSpeak

textToSpeak: string[]

Methods

AddAlias

AddAlias(text: string, alias: string): this

Inherited from SsmlBuilder.AddAlias
- Defined in SsmlBuilder.ts:51
Parameters
- text: string
- alias: string
Returns this

AddAmerican

AddAmerican(text: string, voice?: AmericanVoices): this

- Defined in AmazonSsmlBuilder.ts:35
Parameters
- text: string
- Default value voice: AmericanVoices = AmericanVoices.Kendra
Returns this

AddBreak

AddBreak(strength: BreakStrength): this

Inherited from SsmlBuilder.AddBreak
- Defined in SsmlBuilder.ts:60
Parameters
- strength: BreakStrength
Returns this

AddBreakMs

AddBreakMs(milliseconds: number): this

Inherited from SsmlBuilder.AddBreakMs
- Defined in SsmlBuilder.ts:69
Parameters
- milliseconds: number
Returns this

AddEmphasis

AddEmphasis(text: string, level: EmphasisLevel): this

Inherited from SsmlBuilder.AddEmphasis
- Defined in SsmlBuilder.ts:82
Parameters
- text: string
- level: EmphasisLevel
Returns this

AddGerman

AddGerman(text: string, voice: GermanVoices): this

- Defined in AmazonSsmlBuilder.ts:54
Parameters
- text: string
- voice: GermanVoices
Returns this

AddInterpretAs

AddInterpretAs(text: string, interpretAs: InterpretAsValues): this

Inherited from SsmlBuilder.AddInterpretAs
- Defined in SsmlBuilder.ts:134
Parameters
- text: string
- interpretAs: InterpretAsValues
Returns this

AddLanguage

AddLanguage(text: string, language: LanguageEnum): this

- Defined in AmazonSsmlBuilder.ts:60
Parameters
- text: string
- language: LanguageEnum
Returns this

AddParagraph

AddParagraph(text: string): this

Inherited from SsmlBuilder.AddParagraph
- Defined in SsmlBuilder.ts:42
Parameters
- text: string
Returns this

AddPitch

AddPitch(text: string, pitch: ProsodyPitch): this

Inherited from SsmlBuilder.AddPitch
- Defined in SsmlBuilder.ts:108
Parameters
- text: string
- pitch: ProsodyPitch
Returns this

AddRate

AddRate(text: string, rate: ProsodyRate): this

Inherited from SsmlBuilder.AddRate
- Defined in SsmlBuilder.ts:97
Parameters
- text: string
- rate: ProsodyRate
Returns this

AddSayAs

AddSayAs(text: string, interpretAs: InterpretAsValues): this

Inherited from SsmlBuilder.AddSayAs
- Defined in SsmlBuilder.ts:130
Parameters
- text: string
- interpretAs: InterpretAsValues
Returns this

AddSentence

AddSentence(text: string | string[]): this

Inherited from SsmlBuilder.AddSentence
- Defined in SsmlBuilder.ts:29
Parameters
- text: string | string[]
Returns this

AddSpell

AddSpell(text: string): this

Inherited from SsmlBuilder.AddSpell
- Defined in SsmlBuilder.ts:148
Parameters
- text: string
Returns this

AddSpellAmerican

AddSpellAmerican(text: string, voice?: AmericanVoices): this

- Defined in AmazonSsmlBuilder.ts:45
Parameters
- text: string
- Default value voice: AmericanVoices = AmericanVoices.Salli
Returns this

AddSsml

AddSsml(ssml: string): this

Inherited from SsmlBuilder.AddSsml
- Defined in SsmlBuilder.ts:24
Parameters
- ssml: string
Returns this

AddText

AddText(text: string): this

Inherited from SsmlBuilder.AddText
- Defined in SsmlBuilder.ts:18
Parameters
- text: string
Returns this

AddVoice

AddVoice(text: string, voice: AllVoices): this

- Defined in AmazonSsmlBuilder.ts:71
Parameters
- text: string
- voice: AllVoices
Returns this

AddVolume

AddVolume(text: string, volume: ProsodyVolume): this

Inherited from SsmlBuilder.AddVolume
- Defined in SsmlBuilder.ts:119
Parameters
- text: string
- volume: ProsodyVolume
Returns this

AddWhisper

AddWhisper(text: string): this

- Defined in AmazonSsmlBuilder.ts:20
Parameters
- text: string
Returns this

Build

Build(): string

Inherited from SsmlBuilder.Build
- Defined in SsmlBuilder.ts:196
Returns string

CloseAllEffects

CloseAllEffects(): this

Inherited from SsmlBuilder.CloseAllEffects
- Defined in SsmlBuilder.ts:157
Returns this

CloseEffect

CloseEffect(): this

Inherited from SsmlBuilder.CloseEffect
- Defined in SsmlBuilder.ts:164
Returns this

GetAlias

GetAlias(text: string, alias: string): string

Inherited from SsmlBuilder.GetAlias
- Defined in SsmlBuilder.ts:56
Parameters
- text: string
- alias: string
Returns string

GetAmerican

GetAmerican(text: string, voice?: AmericanVoices): string

- Defined in AmazonSsmlBuilder.ts:40
Parameters
- text: string
- Default value voice: AmericanVoices = AmericanVoices.Kendra
Returns string

GetBreak

GetBreak(strength: BreakStrength): string

Inherited from SsmlBuilder.GetBreak
- Defined in SsmlBuilder.ts:65
Parameters
- strength: BreakStrength
Returns string

GetBreakMs

GetBreakMs(milliseconds: number): string

Inherited from SsmlBuilder.GetBreakMs
- Defined in SsmlBuilder.ts:74
Parameters
- milliseconds: number
Returns string

GetEmphasis

GetEmphasis(text: string, level: EmphasisLevel): string

Inherited from SsmlBuilder.GetEmphasis
- Defined in SsmlBuilder.ts:87
Parameters
- text: string
- level: EmphasisLevel
Returns string

GetInterpretAs

GetInterpretAs(text: string, interpretAs: InterpretAsValues): string

Inherited from SsmlBuilder.GetInterpretAs
- Defined in SsmlBuilder.ts:139
Parameters
- text: string
- interpretAs: InterpretAsValues
Returns string

GetLanguage

GetLanguage(text: string, language: LanguageEnum): string

- Defined in AmazonSsmlBuilder.ts:65
Parameters
- text: string
- language: LanguageEnum
Returns string

GetParagraph

GetParagraph(text: string): string

Inherited from SsmlBuilder.GetParagraph
- Defined in SsmlBuilder.ts:47
Parameters
- text: string
Returns string

GetProsody

GetProsody(key: string, value: string, text: string): string

Inherited from SsmlBuilder.GetProsody
- Defined in SsmlBuilder.ts:143
Parameters
- key: string
- value: string
- text: string
Returns string

GetProsodyStart

GetProsodyStart(key: string, value: string): string

Inherited from SsmlBuilder.GetProsodyStart
- Defined in SsmlBuilder.ts:176
Parameters
- key: string
- value: string
Returns string

GetSentence

GetSentence(text: string): string

Inherited from SsmlBuilder.GetSentence
- Defined in SsmlBuilder.ts:38
Parameters
- text: string
Returns string

GetSpell

GetSpell(text: string): string

Inherited from SsmlBuilder.GetSpell
- Defined in SsmlBuilder.ts:153
Parameters
- text: string
Returns string

GetSpellAmerican

GetSpellAmerican(text: string, voice?: AmericanVoices): string

- Defined in AmazonSsmlBuilder.ts:50
Parameters
- text: string
- Default value voice: AmericanVoices = AmericanVoices.Salli
Returns string

GetVoice

GetVoice(text: string, voice: AllVoices): string

- Defined in AmazonSsmlBuilder.ts:76
Parameters
- text: string
- voice: AllVoices
Returns string

GetWhisper

GetWhisper(text: string): string

- Defined in AmazonSsmlBuilder.ts:25
Parameters
- text: string
Returns string

StartEmphasis

StartEmphasis(level: EmphasisLevel): this

Inherited from SsmlBuilder.StartEmphasis
- Defined in SsmlBuilder.ts:91
Parameters
- level: EmphasisLevel
Returns this

StartPitch

StartPitch(pitch: ProsodyPitch): this

Inherited from SsmlBuilder.StartPitch
- Defined in SsmlBuilder.ts:113
Parameters
- pitch: ProsodyPitch
Returns this

StartRate

StartRate(rate: ProsodyRate): this

Inherited from SsmlBuilder.StartRate
- Defined in SsmlBuilder.ts:102
Parameters
- rate: ProsodyRate
Returns this

StartVoice

StartVoice(text: string, voice: AllVoices): this

- Defined in AmazonSsmlBuilder.ts:80
Parameters
- text: string
- voice: AllVoices
Returns this

StartVolume

StartVolume(volume: ProsodyVolume): this

Inherited from SsmlBuilder.StartVolume
- Defined in SsmlBuilder.ts:124
Parameters
- volume: ProsodyVolume
Returns this

StartWhisper

StartWhisper(): this

- Defined in AmazonSsmlBuilder.ts:29
Returns this

escape

escape(text: string): string

Inherited from SsmlBuilder.escape
- Defined in SsmlBuilder.ts:185
Parameters
- text: string
Returns string

Generated using TypeDoc