Class SsmlBuilder

Hierarchy

SsmlBuilder
- AmazonSsmlBuilder

Index

Constructors

constructor

Properties

Constructors

constructor

new SsmlBuilder(): SsmlBuilder

- Defined in SsmlBuilder.ts:11
Returns SsmlBuilder

Properties

Protected stack

stack: string[]

Protected textToSpeak

textToSpeak: string[]

Methods

AddAlias

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

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

AddBreak

AddBreak(strength: BreakStrength): this

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

AddBreakMs

AddBreakMs(milliseconds: number): this

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

AddEmphasis

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

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

AddInterpretAs

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

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

AddParagraph

AddParagraph(text: string): this

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

AddPitch

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

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

AddRate

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

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

AddSayAs

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

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

AddSentence

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

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

AddSpell

AddSpell(text: string): this

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

AddSsml

AddSsml(ssml: string): this

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

AddText

AddText(text: string): this

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

AddVolume

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

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

Build

Build(): string

- Defined in SsmlBuilder.ts:196
Returns string

CloseAllEffects

CloseAllEffects(): this

- Defined in SsmlBuilder.ts:157
Returns this

CloseEffect

CloseEffect(): this

- Defined in SsmlBuilder.ts:164
Returns this

GetAlias

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

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

GetBreak

GetBreak(strength: BreakStrength): string

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

GetBreakMs

GetBreakMs(milliseconds: number): string

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

GetEmphasis

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

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

GetInterpretAs

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

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

GetParagraph

GetParagraph(text: string): string

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

GetProsody

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

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

GetProsodyStart

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

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

GetSentence

GetSentence(text: string): string

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

GetSpell

GetSpell(text: string): string

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

StartEmphasis

StartEmphasis(level: EmphasisLevel): this

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

StartPitch

StartPitch(pitch: ProsodyPitch): this

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

StartRate

StartRate(rate: ProsodyRate): this

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

StartVolume

StartVolume(volume: ProsodyVolume): this

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

escape

escape(text: string): string

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

Generated using TypeDoc