@zoom/react-native-videosdk
    Preparing search index...

    Type Alias ZoomVideoSdkVideoHelperType

    An interface to control video and manage cameras during a video session.

    type ZoomVideoSdkVideoHelperType = {
        enableOriginalAspectRatio: (enable: boolean) => Promise<boolean>;
        getCameraList: () => Promise<ZoomVideoSdkCameraDeviceType[]>;
        getNumberOfCameras: () => Promise<number>;
        isFlashlightOn: () => Promise<boolean>;
        isMyVideoMirrored: () => Promise<boolean>;
        isOriginalAspectRatioEnabled: () => Promise<boolean>;
        isSupportFlashlight: () => Promise<boolean>;
        mirrorMyVideo: (enable: boolean) => Promise<Errors>;
        rotateMyVideo: (rotation: number) => Promise<boolean>;
        startVideo: () => Promise<Errors>;
        stopVideo: () => Promise<Errors>;
        switchCamera: (deviceId?: string) => Promise<boolean>;
        turnOnOrOffFlashlight: (enable: boolean) => Promise<boolean>;
    }

    Implemented by

    Index

    Properties

    enableOriginalAspectRatio getCameraList getNumberOfCameras isFlashlightOn isMyVideoMirrored isOriginalAspectRatioEnabled isSupportFlashlight mirrorMyVideo rotateMyVideo startVideo stopVideo switchCamera turnOnOrOffFlashlight

    Properties

    enableOriginalAspectRatio: (enable: boolean) => Promise<boolean>

    This function is used to set the aspect ratio of the video sent out.

    getCameraList: () => Promise<ZoomVideoSdkCameraDeviceType[]>

    Get the list of camera devices.

    getNumberOfCameras: () => Promise<number>

    Get the number of cameras available to share the video.

    isFlashlightOn: () => Promise<boolean>

    Return true if the flashlight is on. Otherwise, it'll return false (Only support Android platform).

    isMyVideoMirrored: () => Promise<boolean>

    Determine whether my video is mirrored.

    isOriginalAspectRatioEnabled: () => Promise<boolean>

    Determine whether current aspect ratio is the original aspect ratio of video.

    isSupportFlashlight: () => Promise<boolean>

    Return true if support to control the flashlight (Only support Android platform).

    mirrorMyVideo: (enable: boolean) => Promise<Errors>

    Call this method to mirror my video.

    rotateMyVideo: (rotation: number) => Promise<boolean>

    Call this method to rotate the video when the device is rotated.

    startVideo: () => Promise<Errors>

    Call this method to start sending local video data from the camera.

    stopVideo: () => Promise<Errors>

    Call this method to stop sending local video data from the camera.

    switchCamera: (deviceId?: string) => Promise<boolean>

    Switch to the next available camera.

    turnOnOrOffFlashlight: (enable: boolean) => Promise<boolean>

    Turn on or off the flashlight (Only support Android platform).

    Settings

    Member Visibility

    On This Page

    Properties