CameraController

constructor

• new CameraController(): CameraController

  Returns CameraController

cameraFrameRate

cameraHeight

cameraStream

cameraWidth

mediaDevices

selectedDeviceId

settingsInputIds

standardSettingsIds

videoTrackCapabilities

addEventListener

• addEventListener(
      type: string,
      callback: null | EventListenerOrEventListenerObject,
      options?: boolean | AddEventListenerOptions,
  ): void

  The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

  MDN Reference

  Parameters

  • type: string
  • callback: null | EventListenerOrEventListenerObject
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void
• addEventListener(
      type: string,
      callback: null | EventListenerOrEventListenerObject,
      options?: boolean | AddEventListenerOptions,
  ): void

  The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

  MDN Reference

  Parameters

  • type: string
  • callback: null | EventListenerOrEventListenerObject
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

dispatchEvent

• dispatchEvent(event: Event): boolean

  The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

  MDN Reference

  Parameters

  • event: Event

  Returns boolean
• dispatchEvent(event: Event): boolean

  The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

  MDN Reference

  Parameters

  • event: Event

  Returns boolean

enumerate

• enumerate(): Promise<MediaDevice[]>

  Enumerates the list of video input devices

  The label field for each MediaDevice will be empty if the permission is not equal to granted

  Returns Promise<MediaDevice[]>

getVideoTrackCapabilities

• getVideoTrackCapabilities(): VideoTrackCapabilities

  Return VideoTrackCapabilities

  Returns VideoTrackCapabilities

list

• list(): Promise<void>

  Populates the list of mediaDevices and sets selectedDeviceId

  If camera permission granted it will populate mediaDevices with the list of available cameras and sets selectedDeviceId to that of the first available camera.

  If camera permission is blocked, it will set mediaDevices to [] and selectedDeviceId to an empty string

  Returns Promise<void>

removeEventListener

• removeEventListener(
      type: string,
      callback: null | EventListenerOrEventListenerObject,
      options?: boolean | EventListenerOptions,
  ): void

  The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

  MDN Reference

  Parameters

  • type: string
  • callback: null | EventListenerOrEventListenerObject
  • Optionaloptions: boolean | EventListenerOptions

  Returns void
• removeEventListener(
      type: string,
      callback: null | EventListenerOrEventListenerObject,
      options?: boolean | EventListenerOptions,
  ): void

  The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

  MDN Reference

  Parameters

  • type: string
  • callback: null | EventListenerOrEventListenerObject
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

requestPermission

• requestPermission(): Promise<RequestPermissionResult>

  Requests camera permissions from the user.

  Returns Promise<RequestPermissionResult>

  Promise

setDeviceId

• setDeviceId(deviceId: string): void

  Change selected media device Id

  Parameters

  • deviceId: string

  Returns void

start

• start(
      frameWidth: number,
      frameHeight: number,
      facingMode?: "user" | "environment",
  ): Promise<boolean>

  Starts the camera.

  Camera selection is performed using one of the following methods:

  • If facingMode is provided, the browser selects a camera matching the requested facing direction (user or environment). When multiple cameras satisfy the requested facing mode, the browser decides which camera to open.
  • If facingMode is not provided, the currently selected camera (selectedDeviceId) is opened.

  After a camera is successfully opened, selectedDeviceId is updated to the deviceId of the active camera when available. This allows a camera selected via facingMode to be reopened later using its exact deviceId.

  Parameters

  • frameWidth: number

    Desired frame width. Must use a 16:9 aspect ratio.
  • frameHeight: number

    Desired frame height. Must use a 16:9 aspect ratio.
  • OptionalfacingMode: "user" | "environment"

    Optional camera facing direction. When provided, camera selection is performed by facing mode instead of selectedDeviceId.

  Returns Promise<boolean>

  true if the camera was opened successfully; otherwise false.

stop

• stop(): void

  Stop camera

  Returns void

updatePixelRatio

• updatePixelRatio(): void

  Returns void

Staticinit

• init(): CameraController

  Returns CameraController