|
Video SDK for Linux API Reference
|
An interface to control video and manage cameras during a video session. More...
#include <zoom_video_sdk_video_helper_interface.h>
Public Member Functions | |
| virtual | ~IZoomVideoSDKVideoHelper () |
| virtual ZoomVideoSDKErrors | startVideo ()=0 |
| Call this method to start sending local video data from the camera. | |
| virtual ZoomVideoSDKErrors | spotLightVideo (IZoomVideoSDKUser *pUser)=0 |
| Call this method to spotlight user's video. | |
| virtual ZoomVideoSDKErrors | unSpotLightVideo (IZoomVideoSDKUser *pUser)=0 |
| Call this method to unSpotlight user's video. | |
| virtual ZoomVideoSDKErrors | unSpotlightAllVideos ()=0 |
| Call this method to set all user's video unSpotlight. | |
| virtual IVideoSDKVector< IZoomVideoSDKUser * > * | getSpotlightedVideoUserList ()=0 |
| Call this method to get spotlighted video user list. | |
| virtual ZoomVideoSDKErrors | stopVideo ()=0 |
| Call this method to stop sending local video data from the camera. | |
| virtual bool | rotateMyVideo (VideoRotation rotation)=0 |
| Call this method to rotate the video when the device is rotated. | |
| virtual bool | switchCamera ()=0 |
| Switch to the next available camera. | |
| virtual bool | selectCamera (const zchar_t *cameraDeviceID)=0 |
| Switch to the camera passed in as cameraDeviceID. | |
| virtual bool | enableMultiStreamVideo (const zchar_t *cameraDeviceID, const zchar_t *customDeviceName=nullptr)=0 |
| Enable multiple stream video if you have multiple cameras. and other participants can see multiple videos of you. | |
| virtual bool | disableMultiStreamVideo (const zchar_t *cameraDeviceID)=0 |
| Disable multiple stream video. | |
| virtual bool | muteMultiStreamVideo (const zchar_t *cameraDeviceID)=0 |
| Turn off multiple stream video. | |
| virtual bool | unmuteMultiStreamVideo (const zchar_t *cameraDeviceID)=0 |
| Turn on multiple stream video. | |
| virtual const zchar_t * | getDeviceIDByMyPipe (IZoomVideoSDKRawDataPipe *pPipe)=0 |
| Gets the device ID associated with my multi-camera pipe. | |
| virtual uint32_t | getNumberOfCameras ()=0 |
| Returns number of cameras available to share the video. | |
| virtual IVideoSDKVector< IZoomVideoSDKCameraDevice * > * | getCameraList ()=0 |
| Returns a collection of camera devices available to share the video as an object of type IZoomVideoSDKCameraDevice. | |
| virtual ZoomVideoSDKErrors | canControlCamera (bool &bCan, const zchar_t *pStrDeviceID=nullptr)=0 |
| Check whether the current user has permission to control the camera. | |
| virtual ZoomVideoSDKErrors | turnCameraLeft (unsigned int range=50, const zchar_t *pStrDeviceID=nullptr)=0 |
| Pan the camera to the left. | |
| virtual ZoomVideoSDKErrors | turnCameraRight (unsigned int range=50, const zchar_t *pStrDeviceID=nullptr)=0 |
| Pan the camera to the right. | |
| virtual ZoomVideoSDKErrors | turnCameraUp (unsigned int range=50, const zchar_t *pStrDeviceID=nullptr)=0 |
| Tilt the camera up. | |
| virtual ZoomVideoSDKErrors | turnCameraDown (unsigned int range=50, const zchar_t *pStrDeviceID=nullptr)=0 |
| Tilt the camera down. | |
| virtual ZoomVideoSDKErrors | zoomCameraIn (unsigned int range=50, const zchar_t *pStrDeviceID=nullptr)=0 |
| Zoom the camera in. | |
| virtual ZoomVideoSDKErrors | zoomCameraOut (unsigned int range=50, const zchar_t *pStrDeviceID=nullptr)=0 |
| Zoom the camera out. | |
| virtual ZoomVideoSDKErrors | setVideoQualityPreference (ZoomVideoSDKVideoPreferenceSetting &preference_setting)=0 |
| Automatically adjusts user's video solution and frame-rate. | |
| virtual ZoomVideoSDKErrors | startVideoPreview (IZoomVideoSDKRawDataPipeDelegate *listener, const zchar_t *cameraDeviceID=nullptr, ZoomVideoSDKResolution resolution=ZoomVideoSDKResolution_1080P)=0 |
| Subscribes to preview video raw data with a callback. | |
| virtual ZoomVideoSDKErrors | stopVideoPreview (IZoomVideoSDKRawDataPipeDelegate *listener)=0 |
| UnSubscribe preview video raw data with the subscribed callback. | |
| virtual ZoomVideoSDKErrors | startVideoCanvasPreview (void *handle, const zchar_t *cameraDeviceID=nullptr, ZoomVideoSDKVideoAspect aspect=ZoomVideoSDKVideoAspect_LetterBox)=0 |
| Starts the canvas preview video. | |
| virtual ZoomVideoSDKErrors | stopVideoCanvasPreview (void *handle)=0 |
| Stops the preview video. | |
| virtual ZoomVideoSDKErrors | addVirtualBackgroundItem (const zchar_t *image_path, IVirtualBackgroundItem **imageItem)=0 |
| Add virtual background object. | |
| virtual ZoomVideoSDKErrors | removeVirtualBackgroundItem (IVirtualBackgroundItem *imageItem)=0 |
| Remove virtual background object. | |
| virtual IVideoSDKVector< IVirtualBackgroundItem * > * | getVirtualBackgroundItemList ()=0 |
| Get virtual background item list. | |
| virtual ZoomVideoSDKErrors | setVirtualBackgroundItem (IVirtualBackgroundItem *imageItem)=0 |
| Set virtual background item. | |
| virtual IVirtualBackgroundItem * | getSelectedVirtualBackgroundItem ()=0 |
| Get virtual background item which is been selected. | |
| virtual bool | isOriginalAspectRatioEnabled ()=0 |
| Determines whether current aspect ratio is the original aspect ratio of video. | |
| virtual bool | enableOriginalAspectRatio (bool bEnabled)=0 |
| This function is used to set the aspect ratio of the video sent out. | |
| virtual ZoomVideoSDKErrors | mirrorMyVideo (bool bEnabled)=0 |
| Mirrors the current user's video. Valid only for canvas. | |
| virtual bool | isMyVideoMirrored ()=0 |
| Determines whether mirror my video is enabled. | |
| virtual bool | canEnableAlphaChannelMode ()=0 |
| Determines if alpha channel mode can be enabled. | |
| virtual ZoomVideoSDKErrors | enableAlphaChannelMode (bool enable)=0 |
| Enable or disable video alpha channel mode. | |
| virtual bool | isAlphaChannelModeEnabled ()=0 |
| Determines if alpha channel mode is enabled. | |
| virtual bool | isDeviceSupportAlphaChannelMode ()=0 |
| Determines whether the device hardware capabilities are capable of supporting video alpha mode. | |
An interface to control video and manage cameras during a video session.
Definition at line 158 of file zoom_video_sdk_video_helper_interface.h.
|
inlinevirtual |
Definition at line 161 of file zoom_video_sdk_video_helper_interface.h.
|
pure virtual |
Add virtual background object.
| image_path | Setting using image path. |
| imageItem | Once the function is called successfully, this parameter will store the pointer to the IVirtualBackgroundItem*. |
|
pure virtual |
Check whether the current user has permission to control the camera.
| [out] | bCan | true if able, false if not. It validates only when the return value is ZoomVideoSDKErrors_Success. |
| pStrDeviceID | The camera device ID to check. The default is the main camera ID. |
|
pure virtual |
Determines if alpha channel mode can be enabled.
|
pure virtual |
Disable multiple stream video.
| cameraDeviceID | The camera id which you want to disable. |
|
pure virtual |
Enable or disable video alpha channel mode.
| enable | true to enable alpha channel mode, false to disable. |
|
pure virtual |
Enable multiple stream video if you have multiple cameras. and other participants can see multiple videos of you.
| cameraDeviceID | The camera ID for the camera to enable. |
| customDeviceName | The custom device name of the camera. If this parameter is not passed, a default name will be generated. |
|
pure virtual |
This function is used to set the aspect ratio of the video sent out.
| bEnabled | true indicates to use the original aspect ratio of video, false indicates to use 16:9. |
|
pure virtual |
Returns a collection of camera devices available to share the video as an object of type IZoomVideoSDKCameraDevice.
|
pure virtual |
Gets the device ID associated with my multi-camera pipe.
| pPipe | My multi-camera pipe. |
|
pure virtual |
Returns number of cameras available to share the video.
|
pure virtual |
Get virtual background item which is been selected.
|
pure virtual |
Call this method to get spotlighted video user list.
|
pure virtual |
Get virtual background item list.
|
pure virtual |
Determines if alpha channel mode is enabled.
|
pure virtual |
Determines whether the device hardware capabilities are capable of supporting video alpha mode.
|
pure virtual |
Determines whether mirror my video is enabled.
|
pure virtual |
Determines whether current aspect ratio is the original aspect ratio of video.
|
pure virtual |
Mirrors the current user's video. Valid only for canvas.
| bEnable | true to enable mirror my video. |
|
pure virtual |
Turn off multiple stream video.
| cameraDeviceID | The camera id which is running as multiple camera. |
|
pure virtual |
Remove virtual background object.
| imageItem | The choosing IVirtualBackgroundItem object. |
|
pure virtual |
Call this method to rotate the video when the device is rotated.
|
pure virtual |
Switch to the camera passed in as cameraDeviceID.
|
pure virtual |
Automatically adjusts user's video solution and frame-rate.
| [out] | preference_setting | Specifies the video quality preference. When setting custom modes, the maximum and minimum frame rates are provided by the developer. |
|
pure virtual |
Set virtual background item.
| imageItem | The choosing IVirtualBackgroundItem object. |
|
pure virtual |
Call this method to spotlight user's video.
| pUser | The user which you want to spotlight. |
|
pure virtual |
Call this method to start sending local video data from the camera.
|
pure virtual |
Starts the canvas preview video.
| handle | The window handle of the preview video. |
| cameraDeviceID | Specify a camera device. Pass nullptr or empty string to use the currently selected camera. If invalid, the SDK returns an error. |
| aspect | The aspect mode applied after creation. LetterBox preserves legacy behavior. |
References ZoomVideoSDKVideoAspect_LetterBox.
|
pure virtual |
Subscribes to preview video raw data with a callback.
| listener | Callback object. |
| cameraDeviceID | Camera device ID. Pass nullptr or empty string to use the currently selected camera. |
| resolution | Specify the resolution at which to open the camera. |
References ZoomVideoSDKResolution_1080P.
|
pure virtual |
Call this method to stop sending local video data from the camera.
|
pure virtual |
Stops the preview video.
| handle | The window handle of the preview video. |
|
pure virtual |
UnSubscribe preview video raw data with the subscribed callback.
| listener | Callback sink object. |
|
pure virtual |
Switch to the next available camera.
|
pure virtual |
Tilt the camera down.
| range | Rotation range, 10 <= range <= 100. |
| pStrDeviceID | The camera device ID to operate.The default is the main camera ID. |
|
pure virtual |
Pan the camera to the left.
| range | Rotation range, 10 <= range <= 100. |
| pStrDeviceID | The camera device ID to rotate. The default is the main camera ID. |
|
pure virtual |
Pan the camera to the right.
| range | Rotation range, 10 <= range <= 100. |
| pStrDeviceID | The camera device ID to rotate.The default is the main camera ID. |
|
pure virtual |
Tilt the camera up.
| range | Rotation range, 10 <= range <= 100. |
| pStrDeviceID | The camera device ID to operate.The default is main camera ID. |
|
pure virtual |
Turn on multiple stream video.
| cameraDeviceID | The camera id which is running as multiple camera. |
|
pure virtual |
Call this method to set all user's video unSpotlight.
|
pure virtual |
Call this method to unSpotlight user's video.
| pUser | The user which you want to unSpotlight. |
|
pure virtual |
Zoom the camera in.
| range | Zoom range, 10 <= range <= 100. |
| pStrDeviceID | The camera device ID to operate.The default is the main camera ID. |
|
pure virtual |
Zoom the camera out.
| range | Zoom range, 10 <= range <= 100. |
| pStrDeviceID | The camera device ID to operate.The default is the main camera ID. |