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

    Interface UseAdditionalCamerasReturn

    Return value of the useAdditionalCameras hook

    interface UseAdditionalCamerasReturn {
        addCamera: (deviceId: string, label?: string) => Promise<void>;
        cameras: AdditionalCamera[];
        getLabel: (userId: string) => string | null;
        ghostUserIds: Set<string>;
        isGhostCamera: (userId: string) => boolean;
        removeAll: () => Promise<void>;
        removeCamera: (id: string) => Promise<void>;
    }
    Index

    Properties

    addCamera cameras getLabel ghostUserIds isGhostCamera removeAll removeCamera

    Properties

    addCamera: (deviceId: string, label?: string) => Promise<void>

    Add a new camera by device ID with an optional label

    cameras: AdditionalCamera[]

    List of all additional cameras (connecting, active, or errored)

    getLabel: (userId: string) => string | null

    Get the display label for a ghost camera userId

    ghostUserIds: Set<string>

    Set of ghost camera userIds currently active

    isGhostCamera: (userId: string) => boolean

    Check if a userId is a ghost camera

    removeAll: () => Promise<void>

    Remove all additional cameras

    removeCamera: (id: string) => Promise<void>

    Remove a specific camera by its instance ID

    Settings

    Member Visibility

    On This Page

    Properties