Function useCamera

  • useCamera(): {
        activeCamera: null
        | DeviceItem;
        cameraDeviceError: null | DeviceError;
        cameraDevices: DeviceItem[];
        cameraStream: null | MediaStream;
        currentCameraMiddleware: TrackMiddleware;
        isCameraOn: boolean;
        selectCamera: (deviceId?: string) => Promise<void>;
        setCameraTrackMiddleware: (middleware: TrackMiddleware) => Promise<void>;
        toggleCamera: () => Promise<void>;
    }

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

    Returns {
        activeCamera: null | DeviceItem;
        cameraDeviceError: null | DeviceError;
        cameraDevices: DeviceItem[];
        cameraStream: null | MediaStream;
        currentCameraMiddleware: TrackMiddleware;
        isCameraOn: boolean;
        selectCamera: (deviceId?: string) => Promise<void>;
        setCameraTrackMiddleware: (middleware: TrackMiddleware) => Promise<void>;
        toggleCamera: () => Promise<void>;
    }

    • activeCamera: null | DeviceItem

      Indicates which camera is now turned on and streaming

    • cameraDeviceError: null | DeviceError

      Possible error thrown while setting up the camera

    • cameraDevices: DeviceItem[]

      List of available camera devices

    • cameraStream: null | MediaStream

      The MediaStream object containing the current stream

    • currentCameraMiddleware: TrackMiddleware

      The currently set camera middleware function

    • isCameraOn: boolean

      Indicates whether the microphone is streaming video

    • selectCamera: (deviceId?: string) => Promise<void>

      Selects the camera device

    • setCameraTrackMiddleware: (middleware: TrackMiddleware) => Promise<void>

      Sets the camera middleware

    • toggleCamera: () => Promise<void>

      Toggles current camera on/off

Settings

Member Visibility