@fishjam-cloud/react-native-client - v0.19.0
    Preparing search index...

    Function useCamera

    • This hook can toggle camera on/off and provides current camera state.

      Returns {
          cameras: readonly Camera[];
          currentCamera: null | Camera;
          isCameraOn: boolean;
          isInitialized: boolean;
          prepareCamera: (config?: Readonly<CameraConfig>) => Promise<boolean>;
          simulcastConfig: SimulcastConfig;
          switchCamera: (cameraId: CameraId) => Promise<void>;
          toggleCamera: () => Promise<void>;
      }

      • cameras: readonly Camera[]

        Property that lists cameras available on device.

        A promise that resolves to the list of available cameras.

      • currentCamera: null | Camera

        Which camera is now used for streaming (or will be used as default when camera will be enabled)

      • isCameraOn: boolean

        Informs if user camera is streaming video

      • isInitialized: boolean

        A value indicating if camera was already initialized (if prepareCamera was called).

      • prepareCamera: (config?: Readonly<CameraConfig>) => Promise<boolean>

        Prepares camera and starts local video track

      • simulcastConfig: SimulcastConfig

        Simulcast configuration

      • switchCamera: (cameraId: CameraId) => Promise<void>

        Switches to the specified camera. List of available devices can be retrieved from cameras variable

      • toggleCamera: () => Promise<void>

        Enable/disable current camera