Windows Video SDK API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKVideoHelper Class Referenceabstract

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 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=NULL)=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 const zchar_t * getDeviceIDByMyPipe (IZoomVideoSDKRawDataPipe *pPipe)=0
 Get 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=NULL)=0
 Check whether the current user has permission to control the camera.

 
virtual ZoomVideoSDKErrors turnCameraLeft (unsigned int range=50, const zchar_t *pStrDeviceID=NULL)=0
 Pan the camera to the left.
 
virtual ZoomVideoSDKErrors turnCameraRight (unsigned int range=50, const zchar_t *pStrDeviceID=NULL)=0
 Pan the camera to the right.
 
virtual ZoomVideoSDKErrors turnCameraUp (unsigned int range=50, const zchar_t *pStrDeviceID=NULL)=0
 Tilt the camera up.
 
virtual ZoomVideoSDKErrors turnCameraDown (unsigned int range=50, const zchar_t *pStrDeviceID=NULL)=0
 Tilt the camera down.
 
virtual ZoomVideoSDKErrors zoomCameraIn (unsigned int range=50, const zchar_t *pStrDeviceID=NULL)=0
 Zoom the camera in.
 
virtual ZoomVideoSDKErrors zoomCameraOut (unsigned int range=50, const zchar_t *pStrDeviceID=NULL)=0
 Zoom the camera out.
 
virtual ZoomVideoSDKErrors setVideoQualityPreference (ZoomVideoSDKVideoPreferenceSetting &preference_setting)=0
 Automatically adjust user's video solution and frame-rate.
 
virtual ZoomVideoSDKErrors startVideoPreview (IZoomVideoSDKRawDataPipeDelegate *listener, const zchar_t *cameraDeviceID=NULL)=0
 Subscribe 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=NULL)=0
 Starts the 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. This function need to call first before create virtual background object to get background item last time.
 
virtual ZoomVideoSDKErrors setVirtualBackgroundItem (IVirtualBackgroundItem *imageItem)=0
 Set virtual background item.
 
virtual IVirtualBackgroundItemgetSelectedVirtualBackgroundItem ()=0
 Get virtual background item which is been selected.
 
virtual bool isOriginalAspectRatioEnabled ()=0
 Determine 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
 
virtual bool isMyVideoMirrored ()=0
 

Detailed Description

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

Definition at line 117 of file zoom_video_sdk_video_helper_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKVideoHelper()

virtual IZoomVideoSDKVideoHelper::~IZoomVideoSDKVideoHelper ( )
inlinevirtual

Definition at line 120 of file zoom_video_sdk_video_helper_interface.h.

120{}

Member Function Documentation

◆ addVirtualBackgroundItem()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::addVirtualBackgroundItem ( const zchar_t * image_path,
IVirtualBackgroundItem ** imageItem )
pure virtual

Add virtual background object.

Parameters
image_pathSetting using image path.
imageItemOnce the function is called successfully, this parameter will store the pointer to the IVirtualBackgroundItem*.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ canControlCamera()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::canControlCamera ( bool & bCan,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Check whether the current user has permission to control the camera.

Parameters
[out]bCanTrue means able, False not. It validates only when the return value is ZoomVideoSDKErrors_Success.
pStrDeviceIDThe camera device ID to check. The default is the main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise the function fails. To get extended error information, see ZoomVideoSDKErrors enum.

◆ disableMultiStreamVideo()

virtual bool IZoomVideoSDKVideoHelper::disableMultiStreamVideo ( const zchar_t * cameraDeviceID)
pure virtual

Disable multiple stream video.

Parameters
cameraDeviceIDThe camera id which you want to disable.
Returns
True if success. Otherwise returns false.

◆ enableMultiStreamVideo()

virtual bool IZoomVideoSDKVideoHelper::enableMultiStreamVideo ( const zchar_t * cameraDeviceID,
const zchar_t * customDeviceName = NULL )
pure virtual

Enable multiple stream video if you have multiple cameras and other participants can see multiple videos of you.

Parameters
cameraDeviceIDThe camera ID for the camera to enable.
customDeviceNameThe custom device name of the camera. If this parameter is not passed, a default name will be generated.
Returns
True if success. Otherwise returns false.

◆ enableOriginalAspectRatio()

virtual bool IZoomVideoSDKVideoHelper::enableOriginalAspectRatio ( bool bEnabled)
pure virtual

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

Parameters
bEnabledFalse means the aspect ratio is 16:9, true means that using the original aspect ratio of video
Returns
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()

virtual IVideoSDKVector< IZoomVideoSDKCameraDevice * > * IZoomVideoSDKVideoHelper::getCameraList ( )
pure virtual

Returns a collection of camera devices available to share the video as an object of type IZoomVideoSDKCameraDevice.

Returns
Camera devices list.

◆ getDeviceIDByMyPipe()

virtual const zchar_t * IZoomVideoSDKVideoHelper::getDeviceIDByMyPipe ( IZoomVideoSDKRawDataPipe * pPipe)
pure virtual

Get the device ID associated with my multi-camera pipe.

Parameters
pPipeMy multi-camera pipe
Returns
The video device ID if successful. Otherwise returns NULL.

◆ getNumberOfCameras()

virtual uint32_t IZoomVideoSDKVideoHelper::getNumberOfCameras ( )
pure virtual

Returns number of cameras available to share the video.

Returns
Number of cameras.

◆ getSelectedVirtualBackgroundItem()

virtual IVirtualBackgroundItem * IZoomVideoSDKVideoHelper::getSelectedVirtualBackgroundItem ( )
pure virtual

Get virtual background item which is been selected.

Returns
If the function succeeds, the return value is IVirtualBackgroundItem object. Otherwise failed. the return value is NULL.

◆ getVirtualBackgroundItemList()

virtual IVideoSDKVector< IVirtualBackgroundItem * > * IZoomVideoSDKVideoHelper::getVirtualBackgroundItemList ( )
pure virtual

Get virtual background item list. This function need to call first before create virtual background object to get background item last time.

Returns
If the function succeeds, the return value is IVirtualBackgroundItem object vector. Otherwise failed. the return value is NULL.

◆ isMyVideoMirrored()

virtual bool IZoomVideoSDKVideoHelper::isMyVideoMirrored ( )
pure virtual

\brief Determine whether mirror my video is enabled. \return True if mirror my video is enabled, otherwise false.

◆ isOriginalAspectRatioEnabled()

virtual bool IZoomVideoSDKVideoHelper::isOriginalAspectRatioEnabled ( )
pure virtual

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

Returns
True if is original aspect ratio, otherwise false.

◆ mirrorMyVideo()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::mirrorMyVideo ( bool bEnabled)
pure virtual

\brief Mirrors the current user's video. Valid only for canvas. \param bEnable TRUE to enable mirror my video. \return If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error. To get extended error information, see \link ZoomVideoSDKErrors \endlink enum.

◆ removeVirtualBackgroundItem()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::removeVirtualBackgroundItem ( IVirtualBackgroundItem * imageItem)
pure virtual

Remove virtual background object.

Parameters
imageItemThe choosing IVirtualBackgroundItem object.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ rotateMyVideo()

virtual bool IZoomVideoSDKVideoHelper::rotateMyVideo ( VideoRotation rotation)
pure virtual

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

Returns
Returns true if the rotation was successful, false otherwise.

◆ selectCamera()

virtual bool IZoomVideoSDKVideoHelper::selectCamera ( const zchar_t * cameraDeviceID)
pure virtual

Switch to the camera passed in as cameraDeviceID.

Returns
Returns true if the switch was successful, false otherwise.

◆ setVideoQualityPreference()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::setVideoQualityPreference ( ZoomVideoSDKVideoPreferenceSetting & preference_setting)
pure virtual

Automatically adjust user's video solution and frame-rate.

Parameters
[out]preference_settingSpecifies the video quality preference.
when setting custom modes, the maximum and minimum frame rates are provided by the developer.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ setVirtualBackgroundItem()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::setVirtualBackgroundItem ( IVirtualBackgroundItem * imageItem)
pure virtual

Set virtual background item.

Parameters
imageItemThe choosing IVirtualBackgroundItem object.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ startVideo()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::startVideo ( )
pure virtual

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

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ startVideoCanvasPreview()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::startVideoCanvasPreview ( void * handle,
const zchar_t * cameraDeviceID = NULL )
pure virtual

Starts the preview video.

Parameters
handleThe window handle of the preview video.
deviceIDSpecify a camera device to test. If the param is an incorrect camera ID, the SDK returns an error. Otherwise the SDK tests the specified device and sets it to be the selected one.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors enum.

◆ startVideoPreview()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::startVideoPreview ( IZoomVideoSDKRawDataPipeDelegate * listener,
const zchar_t * cameraDeviceID = NULL )
pure virtual

Subscribe preview video raw data with a callback.

Parameters
listenerCallback sink object.
cameraDeviceID
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ stopVideo()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::stopVideo ( )
pure virtual

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

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ stopVideoCanvasPreview()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::stopVideoCanvasPreview ( void * handle)
pure virtual

Stops the preview video.

Parameters
handleThe window handle of the preview video.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors enum.

◆ stopVideoPreview()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::stopVideoPreview ( IZoomVideoSDKRawDataPipeDelegate * listener)
pure virtual

UnSubscribe preview video raw data with the subscribed callback.

Parameters
listenerCallback sink object.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ switchCamera()

virtual bool IZoomVideoSDKVideoHelper::switchCamera ( )
pure virtual

Switch to the next available camera.

Returns
Returns true if the switch to the next camera was successful, false otherwise.

◆ turnCameraDown()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::turnCameraDown ( unsigned int range = 50,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Tilt the camera down.

Parameters
rangeRotation range, 10 <= range <= 100.
pStrDeviceIDThe camera device ID to operate.The default is the main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise it fails. To get extended error information, see ZoomVideoSDKErrors enum.

◆ turnCameraLeft()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::turnCameraLeft ( unsigned int range = 50,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Pan the camera to the left.

Parameters
rangeRotation range, 10 <= range <= 100.
pStrDeviceIDThe camera device ID to rotate. The default is the main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise it fails. To get extended error information, see ZoomVideoSDKErrors enum.

◆ turnCameraRight()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::turnCameraRight ( unsigned int range = 50,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Pan the camera to the right.

Parameters
rangeRotation range, 10 <= range <= 100.
pStrDeviceIDThe camera device ID to rotate.The default is the main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ turnCameraUp()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::turnCameraUp ( unsigned int range = 50,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Tilt the camera up.

Parameters
rangeRotation range, 10 <= range <= 100.
pStrDeviceIDThe camera device ID to operate.The default is main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise it fails. To get extended error information, see ZoomVideoSDKErrors enum.

◆ zoomCameraIn()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::zoomCameraIn ( unsigned int range = 50,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Zoom the camera in.

Parameters
rangeZoom range, 10 <= range <= 100.
pStrDeviceIDThe camera device ID to operate.The default is the main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise it fails. To get extended error information, see ZoomVideoSDKErrors enum.

◆ zoomCameraOut()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoHelper::zoomCameraOut ( unsigned int range = 50,
const zchar_t * pStrDeviceID = NULL )
pure virtual

Zoom the camera out.

Parameters
rangeZoom range, 10 <= range <= 100.
pStrDeviceIDThe camera device ID to operate.The default is the main camera ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise it fails. To get extended error information, see ZoomVideoSDKErrors enum.