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

    Interface UseRemoteCameraReturn

    Return value of the useRemoteCamera hook

    interface UseRemoteCameraReturn {
        disconnect: () => void;
        error: string | null;
        ghostUserId: string | null;
        isExpired: boolean;
        qrUrl: string | null;
        startPairing: () => Promise<void>;
        status: "error" | "idle" | "waiting" | "connected";
    }
    Index

    Properties

    disconnect error ghostUserId isExpired qrUrl startPairing status

    Properties

    disconnect: () => void

    Disconnect the remote camera (resets to idle)

    error: string | null

    Error message if pairing failed

    ghostUserId: string | null

    The ghost userId for the remote camera

    isExpired: boolean

    Whether the current token has expired

    qrUrl: string | null

    The URL to display as a QR code

    startPairing: () => Promise<void>

    Initiate pairing — generates a join token and builds the QR URL

    status: "error" | "idle" | "waiting" | "connected"

    Current pairing status

    Settings

    Member Visibility

    On This Page

    Properties