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

Hierarchy

Constructors

Properties

dc: RTCDataChannel
lastStop: number = 0
pc: RTCPeerConnection
recording: boolean = false
stream: MediaStream

Accessors

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

    Returns boolean

  • get sender(): RTCRtpSender
  • Returns RTCRtpSender

  • get track(): MediaStreamTrack
  • Returns MediaStreamTrack

Methods

  • Type Parameters

    Parameters

    Returns WillowClient

  • Forces the WebRTC connection closed

    Returns Promise<void>

  • Type Parameters

    Parameters

    Returns boolean

  • Returns (string | symbol)[]

  • Returns number

  • After the client is constructed call this to initalize and connect to ASR server.

    Returns Promise<void>

  • Type Parameters

    Parameters

    • event: E

    Returns number

  • Type Parameters

    Parameters

    • event: E

    Returns WillowClientEvents[E][]

  • Mutes the current client. Generally you want to call stop() instead.

    Parameters

    • mute: boolean

    Returns Promise<void>

  • Parameters

    • attempts: number = 1
    • attemptBackoff: number = 5000

    Returns Promise<void>

  • Type Parameters

    Parameters

    Returns WillowClient

  • Type Parameters

    Parameters

    Returns WillowClient

  • Type Parameters

    Parameters

    • event: E

    Returns WillowClientEvents[E][]

  • Type Parameters

    Parameters

    • Optional event: E

    Returns WillowClient

  • Type Parameters

    Parameters

    Returns WillowClient

  • Used internally. Can also be called if you want to send custom message to server on data channel.

    Parameters

    Returns Promise<void>

  • Parameters

    • maxListeners: number

    Returns WillowClient

  • Starts sending recorded voice to the server. Call stop() to trigger inference.

    Returns Promise<void>

  • Stops recording and triggers inference which will be emmited via "onInfer" event.

    Returns Promise<void>

Generated using TypeDoc