Class ZoomVideoSdkVideoHelper

Implements

ZoomVideoSdkVideoHelperType

Index

Constructors

Methods

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

Constructors

constructor

new ZoomVideoSdkVideoHelper(): ZoomVideoSdkVideoHelper
Returns ZoomVideoSdkVideoHelper

Methods

enableOriginalAspectRatio

enableOriginalAspectRatio(enable: boolean): Promise<any>
This function is used to set the aspect ratio of the video sent out.
Parameters
- enable: boolean
Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.enableOriginalAspectRatio
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:133

getCameraList

getCameraList(): Promise<ZoomVideoSdkCameraDeviceType[]>
Get the list of camera devices.

Returns Promise<ZoomVideoSdkCameraDeviceType[]>
Implementation of ZoomVideoSdkVideoHelperType.getCameraList
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:115

getNumberOfCameras

getNumberOfCameras(): Promise<any>
Get the number of cameras available to share the video.

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.getNumberOfCameras
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:122

isFlashlightOn

isFlashlightOn(): Promise<any>
Return true if the flashlight is on. Otherwise, it'll return false (Only support Android platform).

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.isFlashlightOn
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:163

isMyVideoMirrored

isMyVideoMirrored(): Promise<any>
Determine whether my video is mirrored.

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.isMyVideoMirrored
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:137

isOriginalAspectRatioEnabled

isOriginalAspectRatioEnabled(): Promise<any>
Determine whether current aspect ratio is the original aspect ratio of video.

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.isOriginalAspectRatioEnabled
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:129

isSupportFlashlight

isSupportFlashlight(): Promise<any>
Return true if support to control the flashlight (Only support Android platform).

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.isSupportFlashlight
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:156

mirrorMyVideo

mirrorMyVideo(enable: boolean): Promise<any>
Call this method to mirror my video.
Parameters
- enable: boolean
Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.mirrorMyVideo
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:141

rotateMyVideo

rotateMyVideo(rotation: number): Promise<any>
Call this method to rotate the video when the device is rotated.
Parameters
- rotation: number
Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.rotateMyVideo
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:111

startVideo

startVideo(): Promise<any>
Call this method to start sending local video data from the camera.

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.startVideo
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:96

stopVideo

stopVideo(): Promise<any>
Call this method to stop sending local video data from the camera.

Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.stopVideo
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:100

switchCamera

switchCamera(deviceId?: string): Promise<any>
Switch to the next available camera.
Parameters
- OptionaldeviceId: string
Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.switchCamera
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:104

turnOnOrOffFlashlight

turnOnOrOffFlashlight(enable: boolean): Promise<any>
Turn on or off the flashlight (Only support Android platform).
Parameters
- enable: boolean
  True means to turn it on. False is to turn it off.
Returns Promise<any>
Implementation of ZoomVideoSdkVideoHelperType.turnOnOrOffFlashlight
- Defined in src/native/ZoomVideoSdkVideoHelper.ts:149