ZMVideoSDKVideoCanvas Class Reference

Manages the rendering of video or screen share content in the Zoom Video SDK. More...

#include <ZMVideoSDKVideoCanvas.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- subscribeWithView:aspectMode:resolution:
	Subscribes to video or share data.
(ZMVideoSDKErrors)	- unSubscribeWithView:
	Unsubscribes to video or share data.
(ZMVideoSDKErrors)	- setAspectMode:aspect:
	Sets the video or share aspect mode.
(ZMVideoSDKErrors)	- setResolution:resolution:
	Sets the resolution.

Properties
ZMVideoSDKCanvasType	canvasType
	The canvas type.

Detailed Description

Manages the rendering of video or screen share content in the Zoom Video SDK.

Definition at line 15 of file ZMVideoSDKVideoCanvas.h.

Method Documentation

setAspectMode:aspect:

- (ZMVideoSDKErrors) setAspectMode:		(NSView *_Nonnull)	view
aspect:		(ZMVideoSDKVideoAspect)	aspect

Sets the video or share aspect mode.

Parameters

view	The NSView object, needed to render video or share.
aspect	The aspect ratio of the video or share.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

setResolution:resolution:

- (ZMVideoSDKErrors) setResolution:		(NSView *_Nonnull)	view
resolution:		(ZMVideoSDKResolution)	resolution

Sets the resolution.

Parameters

view	The NSView object, needed to render video.
resolution	The resolution of the video.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

Warning

Avaliable only for subscribe video, unavaliable for subscribe sharing.

subscribeWithView:aspectMode:resolution:

- (ZMVideoSDKErrors) subscribeWithView:		(NSView *_Nonnull)	view
aspectMode:		(ZMVideoSDKVideoAspect)	aspect
resolution:		(ZMVideoSDKResolution)	resolution

Subscribes to video or share data.

Parameters

view	The NSView object, needed to render video or share.
aspect	The aspect ratio of the video or share.
resolution	Specified the resolution of video. valid only for subscribe video.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

unSubscribeWithView:

- (ZMVideoSDKErrors) unSubscribeWithView:

(NSView *_Nonnull)

view

Unsubscribes to video or share data.

Parameters

view	The NSView object, needed to render video or share.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

Property Documentation

canvasType

- (ZMVideoSDKCanvasType) canvasType

readnonatomicassign

The canvas type.

Definition at line 19 of file ZMVideoSDKVideoCanvas.h.