IZoomVideoSDKCanvas Class Reference

video or share canvas interface. More...

#include <zoom_video_sdk_user_helper_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKCanvas ()
virtual ZoomVideoSDKErrors	subscribeWithView (void *handle, ZoomVideoSDKVideoAspect videoAspect, ZoomVideoSDKResolution resolution=ZoomVideoSDKResolution_Auto)=0
	Subscribes to the user's video or share view.
virtual ZoomVideoSDKErrors	unSubscribeWithView (void *handle)=0
	Unsubscribes to the user's video or share view.
virtual ZoomVideoSDKErrors	setAspectMode (void *handle, ZoomVideoSDKVideoAspect aspect)=0
	Set the render video or share aspect ratio.
virtual ZoomVideoSDKErrors	setResolution (void *handle, ZoomVideoSDKResolution resolution)=0
	Sets the resolution for the user's video. Once you specify the value, the resolution will not change even if the size of the window is changed. Specifying a bigger resolution may cause a subscription failure.
virtual ZoomVideoSDKCanvasType	canvasType ()=0
	Gets the canvas type.

Detailed Description

video or share canvas interface.

Definition at line 291 of file zoom_video_sdk_user_helper_interface.h.

Constructor & Destructor Documentation

~IZoomVideoSDKCanvas()

virtual IZoomVideoSDKCanvas::~IZoomVideoSDKCanvas ( )

inlinevirtual

Definition at line 294 of file zoom_video_sdk_user_helper_interface.h.

{}

Member Function Documentation

canvasType()

virtual ZoomVideoSDKCanvasType IZoomVideoSDKCanvas::canvasType ( )

pure virtual

Gets the canvas type.

Returns

Share or Video canvas type, see ZoomVideoSDKCanvasType enum.

setAspectMode()

virtual ZoomVideoSDKErrors IZoomVideoSDKCanvas::setAspectMode ( void * handle, ZoomVideoSDKVideoAspect aspect )

pure virtual

Set the render video or share aspect ratio.

Parameters

handle	The window handle of the showing video or share content.
aspect	Specify a new video aspect ratio.

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.

setResolution()

virtual ZoomVideoSDKErrors IZoomVideoSDKCanvas::setResolution ( void * handle, ZoomVideoSDKResolution resolution )

pure virtual

Sets the resolution for the user's video. Once you specify the value, the resolution will not change even if the size of the window is changed. Specifying a bigger resolution may cause a subscription failure.

Parameters

handle	The window handle of the showing video.
resolution	Specify the resolution for the video in the current render.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors enum.

subscribeWithView()

virtual ZoomVideoSDKErrors IZoomVideoSDKCanvas::subscribeWithView ( void * handle, ZoomVideoSDKVideoAspect videoAspect, ZoomVideoSDKResolution resolution = ZoomVideoSDKResolution_Auto )

pure virtual

Subscribes to the user's video or share view.

Parameters

handle	The window handle of the showing video or share content.
aspect	Specify a video or share aspect ratio.
resolution	Specify a video resolution, valid only for video canvas.

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.

unSubscribeWithView()

virtual ZoomVideoSDKErrors IZoomVideoSDKCanvas::unSubscribeWithView ( void * handle )

pure virtual

Unsubscribes to the user's video or share view.

Parameters

handle

The window handle of the showing video or share content.

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.