Member Junction
    Preparing search index...

    Interface RealtimeCaptureState

    One capture.

    interface RealtimeCaptureState {
        Checking?: boolean;
        DeviceID?: string;
        Devices?: MediaDevice[];
        Failure?: RealtimeCaptureFailure;
        Message?: string;
        PanelLabel?: string;
        Status: "off" | "starting" | "on" | "failed";
        Stream?: MediaStream;
        Surface?: CapturedDisplaySurface;
    }
    Index

    Properties

    Checking? DeviceID? Devices? Failure? Message? PanelLabel? Status Stream? Surface?

    Properties

    Checking?: boolean

    The camera is open for the user to check, and the agent sees nothing until RealtimeCaptures.ConfirmCamera. Set only on a starting camera.

    DeviceID?: string

    The camera in use, while the camera is open (being checked or on).

    Devices?: MediaDevice[]

    The cameras the browser lists, while the camera is open: what RealtimeCaptures.SwitchCamera can move it to. A browser gives their names only once the user has allowed the camera.

    Failure?: RealtimeCaptureFailure

    Why the last start failed, while failed.

    Message?: string

    What to tell the user about the failure.

    PanelLabel?: string

    The shared panel's name, while a share of one panel of the page is on and the host named it (DisplayCaptureOptions.PanelLabel). The agent sees the share as " (shared panel)".

    Status: "off" | "starting" | "on" | "failed"
    Stream?: MediaStream

    The live stream while on, or while the user checks the camera: the camera (show it mirrored) or the shared surface (show it as is).

    Surface?: CapturedDisplaySurface

    What a screen share shows, while on.

    Settings

    Member Visibility

    On This Page

    Properties