Hierarchy

  • WebCam

Constructors

  • Returns WebCam

Properties

config: WebCamConfig

current webcam configuration

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 height(): number
  • webcam current height

    Returns number

  • get label(): string
  • get webcam label

    Returns string

  • get paused(): boolean
  • is webcam paused

    Returns boolean

  • get settings(): undefined | MediaTrackSettings
  • get webcam settings

    Returns undefined | MediaTrackSettings

  • get track(): undefined | MediaStreamTrack
  • get active webcam stream track

    Returns undefined | MediaStreamTrack

  • get width(): number
  • webcam current width

    Returns number

Methods

  • pause webcam video method

    Returns void

  • play webcam video method

    Returns Promise<void>

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

    Parameters

    Returns Promise<void>

  • stop method stops active webcam stream track and disconnects webcam

    Returns void