Function: useCamera()

useCamera(): object

Defined in: packages/react-client/src/hooks/devices/useCamera.ts:8

This hook can toggle camera on/off, change camera, provides current camera and other.

Returns

object

activeCamera

activeCamera: null | DeviceItem = deviceApi.activeDevice

Indicates which camera is now turned on and streaming

cameraDeviceError

cameraDeviceError: null | DeviceError = deviceApi.deviceError

Possible error thrown while setting up the camera

cameraDevices

cameraDevices: DeviceItem[] = deviceApi.devices

List of available camera devices

cameraStream

cameraStream: null | MediaStream = deviceApi.mediaStream

The MediaStream object containing the current stream

currentCameraMiddleware

currentCameraMiddleware: TrackMiddleware = deviceApi.currentMiddleware

The currently set camera middleware function

isCameraOn

isCameraOn: boolean = !!deviceApi.mediaStream

Indicates whether the microphone is streaming video

selectCamera()

selectCamera: (deviceId?) => Promise<void> = videoTrackManager.selectDevice

Selects the camera device

Parameters

Parameter	Type
deviceId?	string

Returns

Promise<void>

setCameraTrackMiddleware()

setCameraTrackMiddleware: (middleware) => Promise<void> = videoTrackManager.setTrackMiddleware

Sets the camera middleware

Parameters

Parameter	Type
middleware	TrackMiddleware

Returns

Promise<void>

toggleCamera()

toggleCamera: () => Promise<void> = videoTrackManager.toggleDevice

Toggles current camera on/off

Returns

Promise<void>