Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for managing local audio capture.

Hierarchy

  • LocalAudioTrack

Index

Methods

getCurrentVolume

  • getCurrentVolume(): number
  • Returns the current volume of the local input device.

    Returns number

mute

  • mute(): Promise<void | Error>
  • Mutes microphone if audio was started, and microphone is not already muted.

    Returns Promise<void | Error>

start

  • start(): Promise<void | Error>
  • Starts local audio capture with microphone muted.

    Returns Promise<void | Error>

stop

  • stop(): Promise<void | Error>
  • Stops local audio capture.

    Returns Promise<void | Error>

testMicrophone

  • Test the microphone, usually used to test the microphone before a meeting.

    Parameters

    Returns undefined | TestMicrophoneReturn

testSpeaker

  • Test the speaker, usually used to test the speaker before a meeting.

    Parameters

    Returns undefined | TestSpeakerReturn

unmute

  • unmute(): Promise<void | Error>
  • Unmutes microphone if audio was started, and microphone is not already unmuted.

    Returns Promise<void | Error>