ZoomSDKVideoContainer Class Reference

Container class to manage multiple video elements. More...

#include <ZoomSDKVideoContainer.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- createVideoElement:
	Creates a video element in the video container.
(ZoomSDKError)	- createPreViewVideoElement:
	Creates a preview video element in the video container.
(ZoomSDKError)	- createNormalVideoElement:
	Creates a normal video element in the video container.
(ZoomSDKError)	- createActiveVideoElement:
	Creates an active video element in the video container.
(ZoomSDKError)	- cleanVideoElement:
	Destroy an existed video element in the video container.
(NSArray *_Nullable)	- getVideoElementList
	Gets the list of video element.

Protected Attributes
id< ZoomSDKVideoContainerDelegate >	_delegate
NSMutableArray *	_elementArray

Properties
id< ZoomSDKVideoContainerDelegate >	delegate
	Delegate for video container callbacks.

Detailed Description

Container class to manage multiple video elements.

Definition at line 150 of file ZoomSDKVideoContainer.h.

Method Documentation

cleanVideoElement:

- (ZoomSDKError) cleanVideoElement:

(ZoomSDKVideoElement *)

element

Destroy an existed video element in the video container.

Parameters

element

An object of ZoomSDKVideoElement.

Returns

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

createActiveVideoElement:

- (ZoomSDKError) createActiveVideoElement:

(ZoomSDKActiveVideoElement *_Nonnull *_Nonnull)

element

Creates an active video element in the video container.

Parameters

element

An object of ZoomSDKActiveVideoElement.

Returns

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

createNormalVideoElement:

- (ZoomSDKError) createNormalVideoElement:

(ZoomSDKNormalVideoElement *_Nonnull *_Nonnull)

element

Creates a normal video element in the video container.

Parameters

element

An object of ZoomSDKNormalVideoElement.

Returns

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

createPreViewVideoElement:

- (ZoomSDKError) createPreViewVideoElement:

(ZoomSDKPreViewVideoElement *_Nonnull *_Nonnull)

element

Creates a preview video element in the video container.

Parameters

element

An object of ZoomSDKPreViewVideoElement.

Returns

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

createVideoElement:

- (ZoomSDKError) createVideoElement:

(ZoomSDKVideoElement *_Nonnull *_Nonnull)

element

Creates a video element in the video container.

Parameters

element

An object of ZoomSDKVideoElement.

Returns

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

Deprecated

This method is deprecated. Use createPreViewVideoElement:, createNormalVideoElement:, or createActiveVideoElement: instead.

getVideoElementList

- (NSArray *_Nullable) getVideoElementList

Gets the list of video element.

Returns

If the function succeeds, it returns an array containing ZoomSDKVideoElement object. Otherwise, this function fails and returns nil.

References getVideoElementList.

Referenced by getVideoElementList.

Field Documentation

_delegate

- (id<ZoomSDKVideoContainerDelegate>) _delegate

protected

Definition at line 152 of file ZoomSDKVideoContainer.h.

_elementArray

- (NSMutableArray*) _elementArray

protected

Definition at line 153 of file ZoomSDKVideoContainer.h.

Property Documentation

delegate

- (id<ZoomSDKVideoContainerDelegate>) delegate

readwritenonatomicassign

Delegate for video container callbacks.

Definition at line 158 of file ZoomSDKVideoContainer.h.