@cisl/io-speaker

Plugin for @cisl/io for interop with speaker-worker

Usage no npm install needed!

<script type="module">
  import cislIoSpeaker from 'https://cdn.skypack.dev/@cisl/io-speaker';
</script>

README

@cisl/io-speaker

Plugin for @cisl/io for interfacing with the speaker-worker

Installation

npm install @cisl/io-speaker

Usage

const io = require('@cisl/io')();
require('@cisl/io-speaker');

io.speaker.speak('test');

import  cislio from '@cisl/io';
import '@cisl/io-speaker';

const io = cislio();
io.speaker.speak("test");

API

speak

  • speak(text: string, options: {duration?: number, voice?: string} = {}): Promise<RabbitMessage>
  • clearCache(): void
  • changeVolume(change: number): void
  • increaseVolume(change: number = 20): void
  • reduceVolume(change: number = 20): void
  • stop(): Promise<RabbitMessage>
  • beginSpeak(msg: Record<string, unknown>): void
  • endSpeak(msg: Record<string, unknown>): void
  • onBeginSpeak(handler: SpeakSubscriptionCallback): void
  • onEndSpeak(handler: SpeakSubscriptionCallback): void