Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WebRTC

Index

Functions

Functions

Const checkCameraPermissions

  • checkCameraPermissions(): Promise<boolean>

  • Returns Promise<boolean>

Const checkMicrophonePermissions

  • checkMicrophonePermissions(): Promise<boolean>

  • Returns Promise<boolean>

Const checkPermissions

  • checkPermissions(name?: "camera" | "microphone" | "speaker"): Promise<boolean>

  • Parameters

    • Optional name: "camera" | "microphone" | "speaker"

    Returns Promise<boolean>

Const checkSpeakerPermissions

  • checkSpeakerPermissions(): Promise<boolean>

  • Returns Promise<boolean>

Const createDeviceWatcher

  • createDeviceWatcher(options?: CreateDeviceWatcherOptions): Promise<StrictEventEmitter<EventEmitter<string | symbol, any>, DeviceWatcherEvents, DeviceWatcherEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">>

  • Parameters

    • Optional options: CreateDeviceWatcherOptions

    Returns Promise<StrictEventEmitter<EventEmitter<string | symbol, any>, DeviceWatcherEvents, DeviceWatcherEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">>

Const enumerateDevices

  • enumerateDevices(): Promise<MediaDeviceInfo[]>

  • Returns Promise<MediaDeviceInfo[]>

Const getCameraDevices

  • getCameraDevices(): Promise<MediaDeviceInfo[]>

  • Helper methods to get devices by kind

    Returns Promise<MediaDeviceInfo[]>

Const getCameraDevicesWithPermissions

  • getCameraDevicesWithPermissions(): Promise<MediaDeviceInfo[]>

  • Helper methods to get devices by kind

    Returns Promise<MediaDeviceInfo[]>

Const getDevices

  • getDevices(name?: "camera" | "microphone" | "speaker", fullList?: boolean): Promise<MediaDeviceInfo[]>

  • Parameters

    • Optional name: "camera" | "microphone" | "speaker"
    • Optional fullList: boolean

    Returns Promise<MediaDeviceInfo[]>

Const getDevicesWithPermissions

  • getDevicesWithPermissions(kind?: "camera" | "microphone" | "speaker", fullList?: boolean): Promise<MediaDeviceInfo[]>

  • Retrieve device list using the browser APIs It checks for permission to return valid deviceId and label

    Parameters

    • Optional kind: "camera" | "microphone" | "speaker"
    • Optional fullList: boolean

    Returns Promise<MediaDeviceInfo[]>

Const getDisplayMedia

  • getDisplayMedia(constraints: MediaStreamConstraints): any

  • Parameters

    • constraints: MediaStreamConstraints

    Returns any

Const getMicrophoneDevices

  • getMicrophoneDevices(): Promise<MediaDeviceInfo[]>

  • Returns Promise<MediaDeviceInfo[]>

Const getMicrophoneDevicesWithPermissions

  • getMicrophoneDevicesWithPermissions(): Promise<MediaDeviceInfo[]>

  • Returns Promise<MediaDeviceInfo[]>

Const getSpeakerDevices

  • getSpeakerDevices(): Promise<MediaDeviceInfo[]>

  • Returns Promise<MediaDeviceInfo[]>

Const getSpeakerDevicesWithPermissions

  • getSpeakerDevicesWithPermissions(): Promise<MediaDeviceInfo[]>

  • Returns Promise<MediaDeviceInfo[]>

Const getSupportedConstraints

  • getSupportedConstraints(): MediaTrackSupportedConstraints

  • Returns MediaTrackSupportedConstraints

Const getUserMedia

  • getUserMedia(constraints?: MediaStreamConstraints): Promise<MediaStream>

  • Parameters

    • Optional constraints: MediaStreamConstraints

    Returns Promise<MediaStream>

Const requestPermissions

  • requestPermissions(constraints: MediaStreamConstraints): Promise<void>

  • Parameters

    • constraints: MediaStreamConstraints

    Returns Promise<void>

Const setMediaElementSinkId

  • setMediaElementSinkId(el: HTMLMediaElement, deviceId: string): Promise<undefined>

  • Parameters

    • el: HTMLMediaElement
    • deviceId: string

    Returns Promise<undefined>

Const stopStream

  • stopStream(stream?: MediaStream): void

  • Parameters

    • Optional stream: MediaStream

    Returns void

Const stopTrack

  • stopTrack(track: MediaStreamTrack): void

  • Parameters

    • track: MediaStreamTrack

    Returns void

Const supportsMediaDevices

  • supportsMediaDevices(): boolean

  • Returns boolean

Const supportsMediaOutput

  • supportsMediaOutput(): boolean

  • Returns boolean