Skip to main content
Version: Next

Function: useMicrophone()

useMicrophone(): object

Defined in: packages/react-client/src/hooks/devices/useMicrophone.ts:9

Manage microphone

Returns​

activeMicrophone​

activeMicrophone: null | DeviceItem = microphoneManager.activeDevice

Deprecated​

Use currentMicrophone and isMicrophoneOn instead Indicates which microphone is now turned on and streaming audio

currentMicrophone​

currentMicrophone: null | MediaDeviceInfo = microphoneManager.selectedDevice

Indicates which microphone is now selected

currentMicrophoneMiddleware​

currentMicrophoneMiddleware: TrackMiddleware = audioTrackManager.currentMiddleware

The currently set microphone middleware function

isMicrophoneMuted​

isMicrophoneMuted: boolean = !microphoneManager.deviceEnabled

Indicates whether the microphone is muted

isMicrophoneOn​

isMicrophoneOn: boolean = !!microphoneStream

Indicates whether the microphone is streaming audio

microphoneDeviceError​

microphoneDeviceError: null | DeviceError = microphoneManager.deviceError

Possible error thrown while setting up the microphone

microphoneDevices​

microphoneDevices: DeviceItem[] = microphoneManager.deviceList

List of available microphone devices

microphoneStream​

microphoneStream: null | MediaStream

The MediaStream object containing the current audio stream

selectMicrophone()​

selectMicrophone: (deviceId) => Promise<undefined | DeviceError> = audioTrackManager.selectDevice

Selects the microphone device

Parameters​

ParameterType
deviceIdstring

Returns​

Promise<undefined | DeviceError>

setMicrophoneTrackMiddleware()​

setMicrophoneTrackMiddleware: (middleware) => Promise<void> = audioTrackManager.setTrackMiddleware

Sets the microphone middleware

Parameters​

ParameterType
middlewareTrackMiddleware

Returns​

Promise<void>

toggleMicrophone()​

toggleMicrophone: () => Promise<undefined | DeviceError> = audioTrackManager.toggleDevice

Toggles current microphone on/off

Returns​

Promise<undefined | DeviceError>

toggleMicrophoneMute()​

toggleMicrophoneMute: () => Promise<void> = audioTrackManager.toggleMute

Mutes/unmutes the microphone

Returns​

Promise<void>