Type alias CameraAPI<TrackMetadata>

CameraAPI<TrackMetadata>: {
    addTrack: ((trackMetadata?, simulcastConfig?, maxBandwidth?) => Promise<string>);
    broadcast: Track<TrackMetadata> | null;
    deviceInfo: MediaDeviceInfo | null;
    devices: MediaDeviceInfo[] | null;
    enabled: boolean;
    error: DeviceError | null;
    mediaStatus: MediaStatus | null;
    muteTrack: ((newTrackMetadata?) => Promise<void>);
    removeTrack: (() => Promise<void>);
    replaceTrack: ((newTrackMetadata?) => Promise<void>);
    setEnable: ((value) => void);
    start: ((deviceId?) => void);
    status: DevicesStatus | null;
    stop: (() => void);
    stream: MediaStream | null;
    track: MediaStreamTrack | null;
    unmuteTrack: ((newTrackMetadata?) => Promise<void>);
    updateTrackMetadata: ((newTrackMetadata) => void);
}

Type Parameters

  • TrackMetadata

Type declaration

  • addTrack: ((trackMetadata?, simulcastConfig?, maxBandwidth?) => Promise<string>)
  • broadcast: Track<TrackMetadata> | null
  • deviceInfo: MediaDeviceInfo | null
  • devices: MediaDeviceInfo[] | null
  • enabled: boolean
  • error: DeviceError | null
  • mediaStatus: MediaStatus | null
  • muteTrack: ((newTrackMetadata?) => Promise<void>)
  • removeTrack: (() => Promise<void>)
  • replaceTrack: ((newTrackMetadata?) => Promise<void>)
  • setEnable: ((value) => void)
      • (value): void
      • Parameters

        • value: boolean

        Returns void

  • start: ((deviceId?) => void)
      • (deviceId?): void
      • Parameters

        • Optional deviceId: string

        Returns void

  • status: DevicesStatus | null
  • stop: (() => void)
      • (): void
      • Returns void

  • stream: MediaStream | null
  • track: MediaStreamTrack | null
  • unmuteTrack: ((newTrackMetadata?) => Promise<void>)
  • updateTrackMetadata: ((newTrackMetadata) => void)
      • (newTrackMetadata): void
      • Parameters

        Returns void