ZoomSDKVideoElement Class Reference

Interface for video element rendering in custom UI. More...

#include <ZoomSDKVideoContainer.h>

Inherits NSObject.

Inherited by ZoomSDKActiveVideoElement, ZoomSDKNormalVideoElement, and ZoomSDKPreViewVideoElement.

Instance Methods
(id)	- initWithFrame:
	Create object of video elements for each user.
(ZoomSDKError)	- showVideo:
	Set whether to show video.
(VideoRenderElementType)	- getElementType
	Get the type of the video render element: preview/active/normal.
(VideoRenderDataType)	- getDataType
	Get data type of video render: avatar/video.
(NSView *)	- getVideoView
	Get NSView object in the element.
(ZoomSDKError)	- resize:
	Resize the video view according to your requirements.
(ZoomSDKError)	- setResolution:
	Config the video view resolution.

Protected Attributes
VideoRenderElementType	_elementType
VideoRenderDataType	_dataType
unsigned int	_userid
NSView *	_videoView
NSRect	_viewFrame

Properties
unsigned int	userid
	The user ID for this video element.
NSView *	videoView
	The view used to render video.

Detailed Description

Interface for video element rendering in custom UI.

Note

This class is available only for custom UI.

Definition at line 18 of file ZoomSDKVideoContainer.h.

Method Documentation

getDataType

- (VideoRenderDataType) getDataType

Get data type of video render: avatar/video.

Returns

The data type of the video render.

getElementType

- (VideoRenderElementType) getElementType

Get the type of the video render element: preview/active/normal.

Returns

The type of the video render element.

getVideoView

- (NSView *) getVideoView

Get NSView object in the element.

Returns

The point of the video view.

initWithFrame:

- (id) initWithFrame:

(NSRect)

rect

Create object of video elements for each user.

Parameters

rect	Frame of video view.

resize:

- (ZoomSDKError) resize:

(NSRect)

frame

Resize the video view according to your requirements.

Parameters

frame

Custom frame of video view.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

setResolution:

- (ZoomSDKError) setResolution:

(ZoomSDKVideoRenderResolution)

resolution

Config the video view resolution.

Parameters

resolution

Custom resolution of video view.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

showVideo:

- (ZoomSDKError) showVideo:

(BOOL)

show

Set whether to show video.

Parameters

show	YES means displaying video, otherwise not.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Field Documentation

_dataType

- (VideoRenderDataType) _dataType

protected

Definition at line 21 of file ZoomSDKVideoContainer.h.

_elementType

- (VideoRenderElementType) _elementType

protected

Definition at line 20 of file ZoomSDKVideoContainer.h.

_userid

- (unsigned int) _userid

protected

Definition at line 22 of file ZoomSDKVideoContainer.h.

_videoView

- (NSView*) _videoView

protected

Definition at line 23 of file ZoomSDKVideoContainer.h.

_viewFrame

- (NSRect) _viewFrame

protected

Definition at line 24 of file ZoomSDKVideoContainer.h.

Property Documentation

userid

- (unsigned int) userid

readwritenonatomicassign

The user ID for this video element.

Definition at line 29 of file ZoomSDKVideoContainer.h.

videoView

- (NSView*) videoView

readwritenonatomicretain

The view used to render video.

Definition at line 33 of file ZoomSDKVideoContainer.h.