Skip to main content
Version: 0.27.0

Function: useCamera()

useCamera(): object

Defined in: packages/mobile-client/src/overrides/hooks.ts:28

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

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​

ParameterType
deviceIdstring

Returns​

Promise<undefined | DeviceError>

setCameraTrackMiddleware()​

setCameraTrackMiddleware: (middleware) => Promise<void>

Sets the camera middleware

Parameters​

ParameterType
middlewareTrackMiddleware

Returns​

Promise<void>

startCamera()​

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

Starts the camera

Parameters​

ParameterType
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>