Class Speaker

Hierarchy

Speaker

Index

Properties

Constructors

constructor

Methods

Properties

maxSpeakerDuration

maxSpeakerDuration: number = ...

rabbit

rabbit: <internal>.Rabbit

Constructors

constructor

new Speaker(io: Io): Speaker

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

Methods

speak

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

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

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

changeVolume

changeVolume(change: number): Promise<<internal>.RabbitMessage<unknown>>

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

Parameters
- change: number
Returns Promise<<internal>.RabbitMessage<unknown>>

increaseVolume

increaseVolume(change?: number): Promise<<internal>.RabbitMessage<unknown>>

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

Parameters
- change: number = 20
Returns Promise<<internal>.RabbitMessage<unknown>>

reduceVolume

reduceVolume(change?: number): Promise<<internal>.RabbitMessage<unknown>>

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

Parameters
- change: number = 20
Returns Promise<<internal>.RabbitMessage<unknown>>

stop

stop(): Promise<<internal>.RabbitMessage<unknown>>

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

Returns Promise<<internal>.RabbitMessage<unknown>>
Resolves to content "done".

beginSpeak

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

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

endSpeak

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

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

onBeginSpeak

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

- Defined in packages/io-celio-speaker/src/index.ts:101
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-celio-speaker/src/index.ts:115
Subscribe to end-speak events.

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

Generated using TypeDoc