Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseMediaControlsResult

    Return type for the useMediaControls hook

    interface UseMediaControlsResult {
        isAudioMuted: boolean;
        isOutputMuted: boolean;
        isScreenSharing: boolean;
        isVideoMuted: boolean;
        toggleAudio: () => Promise<void>;
        toggleOutput: () => Promise<void>;
        toggleScreenShare: () => Promise<void>;
        toggleVideo: () => Promise<void>;
    }
    Index

    Properties

    isAudioMuted isOutputMuted isScreenSharing isVideoMuted toggleAudio toggleOutput toggleScreenShare toggleVideo

    Properties

    isAudioMuted: boolean
    isOutputMuted: boolean
    isScreenSharing: boolean
    isVideoMuted: boolean
    toggleAudio: () => Promise<void>
    toggleOutput: () => Promise<void>

    Toggle the local listener's speaker/output mute. When the room owner has muted this user's output, the client rejects an unmute and the muted state is preserved — the same precedence the audio/video remote-mute follow.

    toggleScreenShare: () => Promise<void>
    toggleVideo: () => Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties