@vladmandic/human - v3.3.6
    Preparing search index...

    Interface WebCam

    interface WebCam {
        config: WebCamConfig;
        devices: MediaDeviceInfo[];
        element: undefined | HTMLVideoElement;
        stream: undefined | MediaStream;
        get capabilities(): undefined | MediaTrackCapabilities;
        get constraints(): undefined | MediaTrackConstraints;
        get height(): number;
        get label(): string;
        get paused(): boolean;
        get settings(): undefined | MediaTrackSettings;
        get track(): undefined | MediaStreamTrack;
        get width(): number;
        enumerate(): Promise<MediaDeviceInfo[]>;
        pause(): void;
        play(): Promise<void>;
        start(webcamConfig?: Partial<WebCamConfig>): Promise<string>;
        stop(): void;
    }
    Index

    Properties

    config devices element stream

    Accessors

    capabilities constraints height label paused settings track width

    Methods

    enumerate pause play start stop

    Properties

    config: WebCamConfig

    current webcam configuration

    devices: MediaDeviceInfo[] = []

    enumerated video devices

    element: undefined | HTMLVideoElement

    instance of dom element associated with webcam stream

    stream: undefined | MediaStream

    active webcam stream

    Accessors

    • get capabilities(): undefined | MediaTrackCapabilities

      get webcam capabilities

      Returns undefined | MediaTrackCapabilities

    • get constraints(): undefined | MediaTrackConstraints

      get webcam constraints

      Returns undefined | MediaTrackConstraints

    • get settings(): undefined | MediaTrackSettings

      get webcam settings

      Returns undefined | MediaTrackSettings

    • get track(): undefined | MediaStreamTrack

      get active webcam stream track

      Returns undefined | MediaStreamTrack

    Methods

    • Returns Promise<MediaDeviceInfo[]>

    • start method initializizes webcam stream and associates it with a dom video element

      Parameters

      Returns Promise<string>

    • stop method stops active webcam stream track and disconnects webcam

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods