ZoomVideoSDKVideoCanvas Class Reference

The video canvas is the display area of the video streams on the user’s local device. To instantiate a local video canvas instance and show the video stream of a user, simply initialize the ZoomVideoSDKVideoCanvas object, subscribe the userId of a specific user, and add it to your UIView. More...

#include <ZoomVideoSDKVideoCanvas.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKVideoType)	- canvasType
	This canvas type.
(ZoomVideoSDKVideoStatus *_Nullable)	- videoStatus
	The user video status.
(ZoomVideoSDKShareStatus *_Nullable)	- shareStatus
	The user share status.
(ZoomVideoSDKError)	- subscribeWithView:aspectMode:andResolution:
	Subscribe to the user's video or share view.
(ZoomVideoSDKError)	- subscribeWithPiPView:aspectMode:andResolution:
	Subscribe to the user's video or share view in Picture-in-Picture mode for video calls.
(ZoomVideoSDKError)	- unSubscribeWithView:
	Call the function to unsubscribe video or share data.
(ZoomVideoSDKError)	- setAspectMode:toView:
	Set the video aspect mode.
(ZoomVideoSDKError)	- setResolution:toView:
	Set the video resolution.

Detailed Description

The video canvas is the display area of the video streams on the user’s local device. To instantiate a local video canvas instance and show the video stream of a user, simply initialize the ZoomVideoSDKVideoCanvas object, subscribe the userId of a specific user, and add it to your UIView.

Definition at line 15 of file ZoomVideoSDKVideoCanvas.h.

Method Documentation

canvasType

- (ZoomVideoSDKVideoType) canvasType

This canvas type.

setAspectMode:toView:

- (ZoomVideoSDKError) setAspectMode:		(ZoomVideoSDKVideoAspect)	aspect
toView:		(UIView *_Nullable)	view

Set the video aspect mode.

Parameters

aspect	The aspect mode of video.
view	The UIView object to render video.

Returns

The result of the method.

setResolution:toView:

- (ZoomVideoSDKError) setResolution:		(ZoomVideoSDKVideoResolution)	resolution
toView:		(UIView *_Nullable)	view

Set the video resolution.

Parameters

resolution	The video resolution. Valid only for video canvas
view	The UIView object to render video.

Returns

If the function succeeds, it will return Error_Success.

shareStatus

- (ZoomVideoSDKShareStatus *_Nullable) shareStatus

The user share status.

Warning

This interface be marked as deprecated, then it will be instead by shareStatus (ZoomVideoSDKRawDataPipe) and shareStatus

subscribeWithPiPView:aspectMode:andResolution:

- (ZoomVideoSDKError) subscribeWithPiPView:		(UIView *_Nullable)	view
aspectMode:		(ZoomVideoSDKVideoAspect)	aspect
andResolution:		(ZoomVideoSDKVideoResolution)	resolution

Subscribe to the user's video or share view in Picture-in-Picture mode for video calls.

Parameters

view	the object of UIView, that's you need render data.
aspect	the render's aspect.
resolution	Specify a render's resolution, valid only for video canvas.

Note

To know more about PiP mode for video calls, please visit https://developer.apple.com/documentation/avkit/adopting_picture_in_picture_for_video_calls .

Returns

The result of this method.

subscribeWithView:aspectMode:andResolution:

- (ZoomVideoSDKError) subscribeWithView:		(UIView *_Nullable)	view
aspectMode:		(ZoomVideoSDKVideoAspect)	aspect
andResolution:		(ZoomVideoSDKVideoResolution)	resolution

Subscribe to the user's video or share view.

Parameters

view	the object of UIView, that's you need render data.
aspect	the render's aspect.
resolution	Specify a render's resolution, valid only for video canvas.

Returns

The result of this method.

unSubscribeWithView:

- (ZoomVideoSDKError) unSubscribeWithView:

(UIView *_Nullable)

view

Call the function to unsubscribe video or share data.

Returns

The result of the method.

videoStatus

- (ZoomVideoSDKVideoStatus *_Nullable) videoStatus

The user video status.

Warning

This interface be marked as deprecated, then it will be instead by videoStatus (ZoomVideoSDKRawDataPipe) and videoStatus