ZoomVideoSdkVideoHelper class - zoom_videosdk_video_helper library

Constructors

ZoomVideoSdkVideoHelper.new()

Properties

hashCode → int: The hash code for this object.
no setterinherited
methodChannel → MethodChannel: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

enableOriginalAspectRatio(bool enable) → Future<bool>: This function is used to set the aspect ratio of the video sent out.
enable true if you want to enable the original aspect ratio.
Return true if successful, otherwise false Remark: If session is using video source and data_mode is not VideoSourceDataMode_None, default always use original aspect ration of video.
getCameraList() → Future<List<ZoomVideoSdkCameraDevice>>: Get the list of camera devices available to share the video.
Return List of ZoomVideoSDKCameraDevice in string
getNumberOfCameras() → Future<num>: Get the number of cameras available to share the video.
Return number of cameras.
getSpotlightedVideoUserList() → Future<List<ZoomVideoSdkUser>?>: Get the list of users whose video is spotlighted.
Return List of ZoomVideoSDKUser in string
isFlashlightOn() → Future<bool>: Check if the flashlight is on.
Return true if the flashlight is on. Otherwise, this function returns false.
isMyVideoMirrored() → Future<bool>: Call this method to query mirror my video enable.
Return true if the mirror effect enabled, false otherwise.
isOriginalAspectRatioEnabled() → Future<bool>: Determine whether current aspect ratio is the original aspect ratio of video.the camera.
Return true if is original aspect ratio, otherwise false.
isSupportFlashlight() → Future<bool>: Check if the device supports flashlight.
Return true if the device supports flashlight. Otherwise, this function returns false.
mirrorMyVideo(bool enable) → Future<String>: Call this method to mirror my video.
enable true: mirror my video, false: disable the mirror effect
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
rotateMyVideo(num rotation) → Future<bool>: Rotate the video when the device is rotated. This happens during the device onConfigurationChanged or onResume within Activity. For more information regarding onConfigurationChanged, see https://developer.android.com/reference/android/app/Activity#onConfigurationChanged(android.content.res.Configuration). For more information regarding onResume, see https://developer.android.com/reference/android/app/Activity#onResume().
Return true if the rotation was successful. Otherwise, this function returns false.
spotLightVideo(String userId) → Future<String>: Spotlight the video of the specified user.
userId The user ID of the user
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
startVideo() → Future<String>: Start sending local video data from the camera.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
stopVideo() → Future<String>: Stop sending local video data from the camera.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
switchCamera(String? deviceId) → Future<bool>: If deviceId is null, it'll switch to the next available camera. Otherwise, it will switch to the camera with the deviceId
Return true if the switch to the next camera was successful. Otherwise, this function returns false.
toString() → String: A string representation of this object.
inherited
turnOnOrOffFlashlight(bool isOn) → Future<bool>: Turn on or off the flashlight.
isOn true if you want to turn on the flashlight, false to turn it off.
Return true if the operation was successful. Otherwise, this function returns false.
unSpotlightAllVideos() → Future<String>: Unspotlight all videos.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
unSpotLightVideo(String userId) → Future<String>: Unspotlight the video of the specified user.
userId The user ID of the user
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.

Operators

operator ==(Object other) → bool: The equality operator.
inherited