Function: useCamera()
useCamera():
object
Defined in: packages/react-client/dist/hooks/devices/useCamera.d.ts:5
This hook can toggle camera on/off, change camera, provides current camera and other.
Returns
activeCamera
activeCamera:
null|DeviceItem
Deprecated
Use currentCamera and isCameraOn instead
Indicates which camera is now turned on and streaming
cameraDeviceError
cameraDeviceError:
null|DeviceError
Possible error thrown while setting up the camera
cameraDevices
cameraDevices:
DeviceItem[]
List of available camera devices
cameraStream
cameraStream:
null|MediaStream
The MediaStream object containing the current stream
currentCamera
currentCamera:
null|MediaDeviceInfo
Indicates which camera is now selected
currentCameraMiddleware
currentCameraMiddleware:
TrackMiddleware
The currently set camera middleware function
isCameraOn
isCameraOn:
boolean
Indicates whether the camera is streaming video
selectCamera()
selectCamera: (
deviceId) =>Promise<undefined|DeviceError>
Selects the camera device
Parameters
| Parameter | Type |
|---|---|
deviceId | string |
Returns
Promise<undefined | DeviceError>
setCameraTrackMiddleware()
setCameraTrackMiddleware: (
middleware) =>Promise<void>
Sets the camera middleware
Parameters
| Parameter | Type |
|---|---|
middleware | TrackMiddleware |
Returns
Promise<void>
startCamera()
startCamera: (
deviceId?) =>Promise<[MediaStreamTrack,null] | [null,DeviceError]>
Starts the camera
Parameters
| Parameter | Type |
|---|---|
deviceId? | null | string |
Returns
Promise<[MediaStreamTrack, null] | [null, DeviceError]>
stopCamera()
stopCamera: () =>
void
Stops the camera
Returns
void
toggleCamera()
toggleCamera: () =>
Promise<undefined|DeviceError>
Toggles current camera on/off
Returns
Promise<undefined | DeviceError>