@fishjam-cloud/react-client/dist/hooks/devices/useMicrophone.js

React client library for Fishjam

import { useContext, useMemo } from "react";
import { MicrophoneContext } from "../../contexts/microphone";
/**
 * Manage microphone
 * @category Devices
 */
export function useMicrophone() {
    const microphoneCtx = useContext(MicrophoneContext);
    if (!microphoneCtx)
        throw Error("useMicrophone must be used within FishjamProvider");
    const { audioTrackManager, microphoneManager } = microphoneCtx;
    const microphoneStream = useMemo(() => {
        const track = audioTrackManager.deviceTrack;
        if (!track)
            return null;
        return new MediaStream([track]);
    }, [audioTrackManager.deviceTrack]);
    return {
        /** Toggles current microphone on/off */
        toggleMicrophone: audioTrackManager.toggleDevice,
        /** Mutes/unmutes the microphone */
        toggleMicrophoneMute: audioTrackManager.toggleMute,
        /** Stops the microphone */
        stopMicrophone: audioTrackManager.stopDevice,
        /** Starts the microphone */
        startMicrophone: audioTrackManager.startDevice,
        /** Selects the microphone device */
        selectMicrophone: audioTrackManager.selectDevice,
        /**
         * @deprecated Use `currentMicrophone` and `isMicrophoneOn` instead
         * Indicates which microphone is now turned on and streaming audio
         */
        activeMicrophone: microphoneManager.activeDevice,
        /**
         * Indicates which microphone is now selected
         */
        currentMicrophone: microphoneManager.selectedDevice,
        /**
         * Indicates whether the microphone is streaming audio
         */
        isMicrophoneOn: !!microphoneStream,
        /**
         * Indicates whether the microphone is muted
         */
        isMicrophoneMuted: !microphoneManager.deviceEnabled,
        /**
         * The MediaStream object containing the current audio stream
         */
        microphoneStream,
        /**
         * The currently set microphone middleware function
         */
        currentMicrophoneMiddleware: audioTrackManager.currentMiddleware,
        /**
         * Sets the microphone middleware
         */
        setMicrophoneTrackMiddleware: audioTrackManager.setTrackMiddleware,
        /**
         * List of available microphone devices
         */
        microphoneDevices: microphoneManager.deviceList,
        /**
         * Possible error thrown while setting up the microphone
         */
        microphoneDeviceError: microphoneManager.deviceError,
    };
}