Function: useCamera()

useCamera(): object

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

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

Returns

activeCamera

activeCamera: null | DeviceItem = cameraManager.activeDevice

Deprecated

Use currentCamera and isCameraOn instead Indicates which camera is now turned on and streaming

cameraDeviceError

cameraDeviceError: null | DeviceError = cameraManager.deviceError

Possible error thrown while setting up the camera

cameraDevices

cameraDevices: DeviceItem[] = cameraManager.deviceList

List of available camera devices

cameraStream

cameraStream: null | MediaStream

The MediaStream object containing the current stream

currentCamera

currentCamera: null | MediaDeviceInfo = cameraManager.selectedDevice

Indicates which camera is now selected

currentCameraMiddleware

currentCameraMiddleware: TrackMiddleware = videoTrackManager.currentMiddleware

The currently set camera middleware function

isCameraOn

isCameraOn: boolean = !!cameraStream

Indicates whether the camera is streaming video

selectCamera()

selectCamera: (deviceId) => Promise<undefined | DeviceError> = videoTrackManager.selectDevice

Selects the camera device

Parameters

Parameter	Type
deviceId	string

Returns

Promise<undefined | DeviceError>

setCameraTrackMiddleware()

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

Sets the camera middleware

Parameters

Parameter	Type
middleware	TrackMiddleware

Returns

Promise<void>

startCamera()

startCamera: (deviceId?) => Promise<[MediaStreamTrack, null] | [null, DeviceError]> = videoTrackManager.startDevice

Starts the camera

Parameters

Parameter	Type
deviceId?	null | string

Returns

Promise<[MediaStreamTrack, null] | [null, DeviceError]>

stopCamera()

stopCamera: () => void = videoTrackManager.stopDevice

Stops the camera

Returns

void

toggleCamera()

toggleCamera: () => Promise<undefined | DeviceError> = videoTrackManager.toggleDevice

Toggles current camera on/off

Returns

Promise<undefined | DeviceError>