Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKVideoContainer Class Reference

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

#include <ZoomSDKVideoContainer.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- createVideoElement:
 Create a video element in the video container.
 
(ZoomSDKError- cleanVideoElement:
 Destroy an existed video element in the video container.
 
(NSArray *_Nullable) - getVideoElementList
 Get the list of video element.
 

Protected Attributes

id< ZoomSDKVideoContainerDelegate_delegate
 
NSMutableArray * _elementArray
 

Properties

id< ZoomSDKVideoContainerDelegatedelegate
 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
elementAn object of ZoomSDKVideoElement.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ createVideoElement:

- (ZoomSDKError) createVideoElement: (ZoomSDKVideoElement *_Nullable *_Nonnull) element

Create a video element in the video container.

Parameters
elementAn object of ZoomSDKVideoElement.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ getVideoElementList

- (NSArray *_Nullable) getVideoElementList

Get the list of video element.

Returns
If the function succeeds, it will return an array containing ZoomSDKVideoElement object.

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.