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

    Interface UseMediaControlsOptions

    Options for the useMediaControls hook

    interface UseMediaControlsOptions {
        client: MediaClient | null;
        contextAudioMuted: boolean;
        contextOutputMuted?: boolean;
        contextVideoMuted: boolean;
        disabled?: boolean;
        localUserId: string | null;
        onAudioMuteChange?: (muted: boolean) => void;
        onError?: (error: Error, operation: string) => void;
        onOutputMuteChange?: (muted: boolean) => void;
        onScreenShareChange?: (sharing: boolean) => void;
        onVideoMuteChange?: (muted: boolean) => void;
    }
    Index

    Properties

    client contextAudioMuted contextOutputMuted? contextVideoMuted disabled? localUserId onAudioMuteChange? onError? onOutputMuteChange? onScreenShareChange? onVideoMuteChange?

    Properties

    client: MediaClient | null

    The client instance for media operations

    contextAudioMuted: boolean

    Initial audio muted state from context

    contextOutputMuted?: boolean

    Initial output (speaker) muted state from context

    contextVideoMuted: boolean

    Initial video muted state from context

    disabled?: boolean

    Whether controls are disabled

    localUserId: string | null

    Local user ID for filtering mute events

    onAudioMuteChange?: (muted: boolean) => void

    Callbacks

    onError?: (error: Error, operation: string) => void
    onOutputMuteChange?: (muted: boolean) => void
    onScreenShareChange?: (sharing: boolean) => void
    onVideoMuteChange?: (muted: boolean) => void

    Settings

    Member Visibility

    On This Page

    Properties