Video SDK for Android API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKVideoHelper.java
Go to the documentation of this file.
1package us.zoom.sdk;
2
3import java.util.List;
4
10public interface ZoomVideoSDKVideoHelper {
11
17
22 int stopVideo();
23
32 boolean rotateMyVideo(int rotation);
33
39 boolean switchCamera();
40
48
54
59 List<ZoomVideoSDKCameraDevice> getCameraList();
60
67
75 @Deprecated
77
86 int startVideoPreview(ZoomVideoSDKRawDataPipeDelegate delegate, String cameraDeviceId, ZoomVideoSDKVideoResolution resolution);
87
94
102 @Deprecated
104
113 int startVideoCanvasPreview(ZoomVideoSDKVideoView videoView, String cameraDeviceId, ZoomVideoSDKVideoAspect aspect);
114
121
127
134 boolean enableOriginalAspectRatio(boolean enabled);
135
141 int mirrorMyVideo(boolean enable);
142
148
156 boolean turnOnOrOffFlashlight(boolean isOn);
157
163
170 boolean isFlashlightOn();
171
178
184 int enableAlphaChannelMode(boolean enable);
185
191
197
204
211
217
222 List<ZoomVideoSDKUser> getSpotlightedVideoUserList();
223
231 boolean enableMultiStreamVideo(String cameraDeviceID, String customDeviceName);
232
238 boolean disableMultiStreamVideo(String cameraDeviceID);
239
245 boolean muteMultiStreamVideo(String cameraDeviceID);
246
252 boolean unmuteMultiStreamVideo(String cameraDeviceID);
253
260
267}
Video Preference Setting When setting custom modes, the developer provides the maximum and minimum fr...
Zoom Video SDK video canvas view.
Enumeration of the video aspect ratio.
Enumeration of video resolution options.
Interface for user to subscribe/unSubscribe video raw data. ZoomVideoSDKUser#getVideoPipe().
Zoom Video SDK user information.
Interface for subscribing or unsubscribing to a specific user's video or share canvas....
An interface to control video and manage cameras during a video session.
boolean isOriginalAspectRatioEnabled()
Determines whether the current aspect ratio is the original aspect ratio of video.
int startVideoPreview(ZoomVideoSDKRawDataPipeDelegate delegate, String cameraDeviceId, ZoomVideoSDKVideoResolution resolution)
Subscribes to the current user's video preview with an explicit camera device and a resolution.
int startVideoCanvasPreview(ZoomVideoSDKVideoView videoView, ZoomVideoSDKVideoAspect aspect)
Subscribes to the current user's video preview with a canvas view.
int stopVideo()
Stops sending local video data from the camera.
int getNumberOfCameras()
Gets the number of cameras available to share the video.
boolean enableMultiStreamVideo(String cameraDeviceID, String customDeviceName)
Enables multiple video stream support if you have multiple cameras and other participants can see mul...
int unSpotlightAllVideos()
Removes spotlight from all users' videos.
boolean enableOriginalAspectRatio(boolean enabled)
Sets the aspect ratio of the video sent out.
boolean rotateMyVideo(int rotation)
Rotates the video when the device is rotated. This happens during the device onConfigurationChanged o...
String getDeviceIDByMyCanvas(ZoomVideoSDKVideoCanvas canvas)
Gets the device ID associated with the current user's multi-camera canvas.
boolean switchCamera(ZoomVideoSDKCameraDevice cameraDevice)
Switches to a specific camera from the list of camera devices retrieved from getCameraList().
boolean muteMultiStreamVideo(String cameraDeviceID)
Turns off the multiple video stream.
boolean isFlashlightOn()
Determines whether the flashlight is on. Prerequisite: The camera is in an open state....
boolean isDeviceSupportAlphaChannelMode()
Determines whether the device hardware capabilities are capable of supporting video alpha mode.
boolean isSupportFlashlight()
Determines whether the flashlight is supported.
boolean disableMultiStreamVideo(String cameraDeviceID)
Disables the multiple video stream.
int stopVideoPreview(ZoomVideoSDKRawDataPipeDelegate delegate)
Unsubscribes from the current user's video preview.
List< ZoomVideoSDKCameraDevice > getCameraList()
Gets the list of camera devices available to share the video.
boolean isAlphaChannelModeEnabled()
Determines whether alpha channel mode is enabled.
boolean unmuteMultiStreamVideo(String cameraDeviceID)
Turns on the multiple video stream.
int startVideoPreview(ZoomVideoSDKRawDataPipeDelegate delegate, ZoomVideoSDKVideoResolution resolution)
Subscribes to the current user's video preview that shows the real-time video output based on their o...
int stopVideoCanvasPreview(ZoomVideoSDKVideoView videoView)
Unsubscribes from the current user's video preview.
boolean switchCamera()
Switches to the next available camera.
boolean isMyVideoMirrored()
Determines whether the current user's video is mirrored.
int startVideoCanvasPreview(ZoomVideoSDKVideoView videoView, String cameraDeviceId, ZoomVideoSDKVideoAspect aspect)
Subscribes to the current user's video preview with a canvas view, an explicit camera device,...
int setVideoQualityPreference(ZoomVideoSDKVideoPreferenceSetting preferenceSetting)
Sets the video quality preference that automatically adjusts the user's video to prioritize frame rat...
boolean canEnableAlphaChannelMode()
Determines whether alpha channel mode can be enabled.
List< ZoomVideoSDKUser > getSpotlightedVideoUserList()
Gets the list of spotlighted video users.
int enableAlphaChannelMode(boolean enable)
Enables or disables video alpha channel mode.
String getDeviceIDByMyPipe(ZoomVideoSDKRawDataPipe pipe)
Gets the device ID associated with the current user's multi-camera pipe.
int spotLightVideo(ZoomVideoSDKUser user)
Spotlights a user's video.
int unSpotLightVideo(ZoomVideoSDKUser user)
Removes spotlight from a user's video.
int mirrorMyVideo(boolean enable)
Mirrors the current user's video.
int startVideo()
Starts sending local video data from the camera.
boolean turnOnOrOffFlashlight(boolean isOn)
Turns on or off the flashlight. Prerequisite: The camera is in an open state. If the camera is closed...