Class Speaker

Hierarchy

Speaker

Index

Properties

rabbit

Constructors

constructor

Methods

Properties

Private rabbit

rabbit: <internal>.Rabbit

Constructors

constructor

new Speaker(io: Io): Speaker

- Defined in packages/io-speaker/src/index.ts:16
Parameters
- io: Io
Returns Speaker

Methods

speak

speak(text: string, options?: { duration?: number; environment?: string; voice?: string }): Promise<<internal>.RabbitMessage<unknown>>

- Defined in packages/io-speaker/src/index.ts:35
Speak text.

Parameters
- text: string
  
  The text to speak out. You can also use SSML. See Watson TTS website.
- options: { duration?: number; environment?: string; voice?: string } = {}
  - Optional duration?: number
  - Optional environment?: string
  - Optional voice?: string
Returns Promise<<internal>.RabbitMessage<unknown>>
Resolves to "succeeded" or "interrupted".

clearCache

clearCache(): void

- Defined in packages/io-speaker/src/index.ts:57
Clear the speaker-worker cache

Returns void

changeVolume

changeVolume(change: number): void

- Defined in packages/io-speaker/src/index.ts:67
Change the speaker volume by some percentage.

Parameters
- change: number
Returns void

increaseVolume

increaseVolume(change?: number): void

- Defined in packages/io-speaker/src/index.ts:79
Increase speaker volume by some percentage.

Parameters
- change: number = 20
Returns void

reduceVolume

reduceVolume(change?: number): void

- Defined in packages/io-speaker/src/index.ts:87
Reduce speaker volume by some percentage.

Parameters
- change: number = 20
Returns void

stop

stop(options?: { environment?: string }): Promise<<internal>.RabbitMessage<unknown>>

- Defined in packages/io-speaker/src/index.ts:95
Stop the speaker.

Parameters
- Optional options: { environment?: string }
  - Optional environment?: string
Returns Promise<<internal>.RabbitMessage<unknown>>
Resolves to content "done".

beginSpeak

beginSpeak(msg: <internal>.Record<string, unknown>): void

- Defined in packages/io-speaker/src/index.ts:102
Parameters
- msg: <internal>.Record<string, unknown>
Returns void

endSpeak

endSpeak(msg: <internal>.Record<string, unknown>): void

- Defined in packages/io-speaker/src/index.ts:108
Parameters
- msg: <internal>.Record<string, unknown>
Returns void

onBeginSpeak

onBeginSpeak(handler: <internal>.SpeakSubscriptionCallback): void

- Defined in packages/io-speaker/src/index.ts:118
Subscribe to begin-speak events.

Parameters
- handler: <internal>.SpeakSubscriptionCallback
  
  The callback for handling the speaking events.
Returns void

onEndSpeak

onEndSpeak(handler: <internal>.SpeakSubscriptionCallback): void

- Defined in packages/io-speaker/src/index.ts:132
Subscribe to end-speak events.

Parameters
- handler: <internal>.SpeakSubscriptionCallback
  
  The callback for handling the speaking events.
Returns void

Generated using TypeDoc