Type alias MicrophoneAPI<TrackMetadata>

Type declaration

• addTrack: ((trackMetadata?, maxBandwidth?) => Promise<string>)

  • • (trackMetadata?, maxBandwidth?): Promise<string>

    • Parameters

      • Optional trackMetadata: TrackMetadata
      • Optional maxBandwidth: TrackBandwidthLimit

      Returns Promise<string>

• broadcast: Track<TrackMetadata> | null

• deviceInfo: MediaDeviceInfo | null

• devices: MediaDeviceInfo[] | null

• enabled: boolean

• error: DeviceError | null

• mediaStatus: MediaStatus | null

• muteTrack: ((newTrackMetadata?) => Promise<void>)

  • • (newTrackMetadata?): Promise<void>

    • Parameters

      • Optional newTrackMetadata: TrackMetadata

      Returns Promise<void>

• removeTrack: (() => Promise<void>)

  • • (): Promise<void>

    • Returns Promise<void>

• replaceTrack: ((newTrackMetadata?) => Promise<void>)

  • • (newTrackMetadata?): Promise<void>

    • Parameters

      • Optional newTrackMetadata: TrackMetadata

      Returns Promise<void>

• setEnable: ((value) => void)

  • • (value): void

    • Parameters

      • value: boolean

      Returns void

• start: ((deviceId?) => void)

  • • (deviceId?): void

    • Parameters

      • Optional deviceId: string

      Returns void

• status: DevicesStatus | null

• stop: (() => void)

  • • (): void

    • Returns void

• stream: MediaStream | null

• track: MediaStreamTrack | null

• unmuteTrack: ((newTrackMetadata?) => Promise<void>)

  • • (newTrackMetadata?): Promise<void>

    • Parameters

      • Optional newTrackMetadata: TrackMetadata

      Returns Promise<void>

• updateTrackMetadata: ((newTrackMetadata) => void)

  • • (newTrackMetadata): void

    • Parameters

      • newTrackMetadata: TrackMetadata

      Returns void