Function useMicrophone

Returns {
    activeMicrophone: null | DeviceItem;
    currentMicrophone: null | MediaDeviceInfo;
    currentMicrophoneMiddleware: TrackMiddleware;
    isMicrophoneMuted: boolean;
    isMicrophoneOn: boolean;
    microphoneDeviceError: null | DeviceError;
    microphoneDevices: DeviceItem[];
    microphoneStream: null | MediaStream;
    selectMicrophone: (deviceId: string) => Promise<undefined | DeviceError>;
    setMicrophoneTrackMiddleware: (
        middleware: TrackMiddleware,
    ) => Promise<void>;
    toggleMicrophone: () => Promise<undefined | DeviceError>;
    toggleMicrophoneMute: () => Promise<void>;
}

• activeMicrophone: null | DeviceItem

  Deprecated

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

• currentMicrophone: null | MediaDeviceInfo

  Indicates which microphone is now selected

• currentMicrophoneMiddleware: TrackMiddleware

  The currently set microphone middleware function

• isMicrophoneMuted: boolean

  Indicates whether the microphone is muted

• isMicrophoneOn: boolean

  Indicates whether the microphone is streaming audio

• microphoneDeviceError: null | DeviceError

  Possible error thrown while setting up the microphone

• microphoneDevices: DeviceItem[]

  List of available microphone devices

• microphoneStream: null | MediaStream

  The MediaStream object containing the current audio stream

• selectMicrophone: (deviceId: string) => Promise<undefined | DeviceError>

  Selects the microphone device

• setMicrophoneTrackMiddleware: (middleware: TrackMiddleware) => Promise<void>

  Sets the microphone middleware

• toggleMicrophone: () => Promise<undefined | DeviceError>

  Toggles current microphone on/off

• toggleMicrophoneMute: () => Promise<void>

  Mutes/unmutes the microphone