Windows Video SDK 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 | 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 IVirtualBackgroundItem * | getSelectedVirtualBackgroundItem ()=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 |
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.
|
inlinevirtual |
Definition at line 120 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 means able, False 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 |
Disable multiple stream video.
cameraDeviceID | The camera id which you want 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 | False means the aspect ratio is 16:9, true means that using the original aspect ratio of video |
|
pure virtual |
Returns a collection of camera devices available to share the video as an object of type IZoomVideoSDKCameraDevice.
|
pure virtual |
Get 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 |
Get virtual background item list. This function need to call first before create virtual background object to get background item last time.
|
pure virtual |
\brief Determine whether mirror my video is enabled. \return True if mirror my video is enabled, otherwise false.
|
pure virtual |
Determine whether current aspect ratio is the original aspect ratio of video.
|
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.
|
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 adjust 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 start sending local video data from the camera.
|
pure virtual |
Starts the preview video.
handle | The window handle of the preview video. |
deviceID | Specify 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. |
|
pure virtual |
Subscribe preview video raw data with a callback.
listener | Callback sink object. |
cameraDeviceID |
|
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 |
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. |