Type Alias: UseMicrophoneResult
UseMicrophoneResult:
object
Type declaration
activeMicrophone
activeMicrophone:
DeviceItem|null
Indicates which microphone is now turned on and streaming audio
currentMicrophoneMiddleware
currentMicrophoneMiddleware:
TrackMiddleware
The currently set microphone middleware function
isMicrophoneMuted
isMicrophoneMuted:
boolean
Indicates whether the microphone is muted
isMicrophoneOn
isMicrophoneOn:
boolean
Indicates whether the microphone is streaming audio
microphoneDeviceError
microphoneDeviceError:
DeviceError|null
Possible error thrown while setting up the microphone
microphoneDevices
microphoneDevices:
DeviceItem[]
List of available microphone devices
microphoneStream
microphoneStream:
MediaStream|null
The MediaStream object containing the current audio stream
selectMicrophone()
selectMicrophone: (
deviceId) =>void
Selects the microphone device
Parameters
| Parameter | Type |
|---|---|
deviceId | string |
Returns
void
setMicrophoneTrackMiddleware()
setMicrophoneTrackMiddleware: (
middleware) =>Promise<void>
Sets the microphone middleware
Parameters
| Parameter | Type |
|---|---|
middleware | TrackMiddleware | null |
Returns
Promise<void>
toggleMicrophone()
toggleMicrophone: () =>
void
Toggles current microphone on/off
Returns
void
toggleMicrophoneMute()
toggleMicrophoneMute: () =>
void
Mutes/unmutes the microphone
Returns
void