Zoom Video SDK for React - v0.0.2
    Preparing search index...

    Function useAudioState

    • Hook to access and manage audio state

      This hook provides comprehensive audio state management including:

      • Audio mute status
      • Audio capture status
      • Mute/unmute functionality
      • Audio capture start/stop functionality
      • Automatic state synchronization with Zoom Video SDK

      Returns {
          isAudioMuted: boolean;
          isCapturingAudio: boolean;
          setCapture: (capture: boolean, audioOptions?: AudioOption) => Promise<void>;
          setMute: (mute: boolean) => Promise<void>;
          toggleCapture: (audioOptions?: AudioOption) => Promise<void>;
          toggleMute: () => Promise<void>;
      }

      Object containing audio state and control functions

      • isAudioMuted: boolean
      • isCapturingAudio: boolean
      • setCapture: (capture: boolean, audioOptions?: AudioOption) => Promise<void>

        Set audio capture state

      • setMute: (mute: boolean) => Promise<void>

        Set audio mute state Note: Audio must be capturing before it can be muted/unmuted

      • toggleCapture: (audioOptions?: AudioOption) => Promise<void>

        Toggle audio capture state

      • toggleMute: () => Promise<void>

        Toggle audio mute state Note: Audio must be capturing before it can be muted/unmuted

      const {
      isAudioMuted,
      isCapturingAudio,
      toggleMute,
      toggleCapture,
      setMute,
      setCapture
      } = useAudioState();

      return (
      <div>
      <button onClick={toggleMute}>
      {isAudioMuted ? 'Unmute' : 'Mute'}
      </button>
      <button onClick={() => toggleCapture({ echoCancellation: true })}>
      {isCapturingAudio ? 'Stop Audio' : 'Start Audio'}
      </button>
      </div>
      );