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:
	Creates object of video elements for each user.
(ZoomSDKError)	- showVideo:
	Sets whether to show video.
(VideoRenderElementType)	- getElementType
	Gets the video's type render element: preview, active, or normal.
(VideoRenderDataType)	- getDataType
	Gets data type of video render: avatar or video.
(NSView *)	- getVideoView
	Gets 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

Gets data type of video render: avatar or video.

Returns

The data type of the video render.

getElementType

- (VideoRenderElementType) getElementType

Gets the video's type render element: preview, active, or normal.

Returns

The video render element's type.

getVideoView

- (NSView *) getVideoView

Gets NSView object in the element.

Returns

The point of the video view.

initWithFrame:

- (id) initWithFrame:

(NSRect)

rect

Creates 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

setResolution:

- (ZoomSDKError) setResolution:

(ZoomSDKVideoRenderResolution)

resolution

Config the video view resolution.

Parameters

resolution

Custom resolution of video view.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

showVideo:

- (ZoomSDKError) showVideo:

(BOOL)

show

Sets whether to show video.

Parameters

show	YES if displaying video, NO otherwise.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

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.