Class WillowClient

The main class for interacting with library. An event emitter that establishes and maintains connection.

Hierarchy

TypedEventEmitter<WillowClientEvents, this>
- WillowClient

Index

Constructors

Properties

config dc lastStop pc recording stream

Accessors

connected sender track

Constructors

constructor

new WillowClient(config): WillowClient
Parameters
- config: WillowClientConfig
Returns WillowClient
Overrides (EventEmitter as new () => TypedEmitter<WillowClientEvents>).constructor
- Defined in src/index.ts:46

Properties

config

config: WillowClientConfig

dc

dc: RTCDataChannel

`Private` lastStop

lastStop: number = 0

pc

pc: RTCPeerConnection

recording

recording: boolean = false

stream

stream: MediaStream

Accessors

connected

get connected(): boolean
Indicates if the client is currently connected.

Returns boolean
- Defined in src/index.ts:74

sender

get sender(): RTCRtpSender
Returns RTCRtpSender
- Defined in src/index.ts:69

track

get track(): MediaStreamTrack
Returns MediaStreamTrack
- Defined in src/index.ts:65

Methods

addListener

addListener<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).addListener
- Defined in node_modules/typed-emitter/index.d.ts:22

disconnect

disconnect(): Promise<void>
Forces the WebRTC connection closed

Returns Promise<void>
- Defined in src/index.ts:111

emit

emit<E>(event, ...args): boolean
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- Rest ...args: Parameters<WillowClientEvents[E]>
Returns boolean
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).emit
- Defined in node_modules/typed-emitter/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).eventNames
- Defined in node_modules/typed-emitter/index.d.ts:34

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:39

init

init(): Promise<void>
After the client is constructed call this to initalize and connect to ASR server.

Returns Promise<void>
- Defined in src/index.ts:134

listenerCount

listenerCount<E>(event): number
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:37

listeners

listeners<E>(event): WillowClientEvents[E][]
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
Returns WillowClientEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).listeners
- Defined in node_modules/typed-emitter/index.d.ts:36

mute

mute(mute): Promise<void>
Mutes the current client. Generally you want to call stop() instead.
Parameters
- mute: boolean
Returns Promise<void>
- Defined in src/index.ts:79

`Private` negotiate

negotiate(attempts?, attemptBackoff?): Promise<void>
Parameters
- attempts: number = 1
- attemptBackoff: number = 5000
Returns Promise<void>
- Defined in src/index.ts:182

off

off<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).off
- Defined in node_modules/typed-emitter/index.d.ts:28

on

on<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).on
- Defined in node_modules/typed-emitter/index.d.ts:23

once

once<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).once
- Defined in node_modules/typed-emitter/index.d.ts:24

prependListener

prependListener<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).prependListener
- Defined in node_modules/typed-emitter/index.d.ts:25

prependOnceListener

prependOnceListener<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:26

rawListeners

rawListeners<E>(event): WillowClientEvents[E][]
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
Returns WillowClientEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:35

removeAllListeners

removeAllListeners<E>(event?): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- Optional event: E
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:29

removeListener

removeListener<E>(event, listener): WillowClient
Type Parameters
- E extends keyof WillowClientEvents
Parameters
- event: E
- listener: WillowClientEvents[E]
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).removeListener
- Defined in node_modules/typed-emitter/index.d.ts:30

sendMessage

sendMessage(message): Promise<void>
Used internally. Can also be called if you want to send custom message to server on data channel.
Parameters
- message: DataChannelMessage<any>
Returns Promise<void>
- Defined in src/index.ts:93

setMaxListeners

setMaxListeners(maxListeners): WillowClient
Parameters
- maxListeners: number
Returns WillowClient
Inherited from (EventEmitter as new () => TypedEmitter<WillowClientEvents>).setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40

start

start(): Promise<void>
Starts sending recorded voice to the server. Call stop() to trigger inference.

Returns Promise<void>
- Defined in src/index.ts:85

stop

stop(): Promise<void>
Stops recording and triggers inference which will be emmited via "onInfer" event.

Returns Promise<void>
- Defined in src/index.ts:99

Generated using TypeDoc