Interface Camera

A camera whose video can be recorded.

interface Camera {
    id: string;
    name: string;
    model_id: string;
    manufacturer: string;
    availability: "available" | "notConnected" | "lidClosed" | "unknownSuspended";
    preview_url?: string;
}

Properties

id name model_id manufacturer availability preview_url?

Properties

id

id: string

An identifier that uniquely identifies the camera.

name

name: string

A localized camera name for display in the user interface.

model_id

model_id: string

The model ID of this camera.

manufacturer

manufacturer: string

The manufacturer of this camera.

availability

availability: "available" | "notConnected" | "lidClosed" | "unknownSuspended"

The current availability state of this camera.

  • available: Camera can be recorded
  • lidClosed: Camera cannot be recorded because the MacBook lid is closed (recovery: "Open MacBook lid")
  • unknownSuspended: Camera cannot be recorded because it is suspended for some unknown reason (recovery: "Unsuspend camera")
  • notConnected: Camera cannot be recorded because it is currently not connected (recovery: "Connect camera")

Optional preview_url

preview_url?: string

This URL can be used in a img tag to display a live preview of the camera feed in your user interface.

Remarks

The preview URL should be available for every camera under normal conditions. If you observe a camera without a preview URL please report it as a bug.

Settings

Member Visibility

Theme

On This Page

idnamemodel_idmanufactureravailabilitypreview_url

Generated using TypeDoc