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

#include <ZoomSDKRenderer.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- subscribe:rawDataType:
 Subscribe to receive raw data.
 
(ZoomSDKError- unSubscribe
 Unsubscribe to receive raw data.
 
(ZoomSDKRawDataType- getRawDataType
 Get the type of raw data.
 
(unsigned int) - getSubscribeID
 Get the subscribe ID of raw data user is subscribing to.
 
(ZoomSDKResolution- getResolution
 Get the resolution of raw data.
 
(ZoomSDKError- setResolution:
 Set the resolution of raw data.
 

Protected Attributes

unsigned int _subscribeID
 
ZoomSDKRawDataType _rawDataType
 
ZoomSDKResolution _resolution
 
id< ZoomSDKRendererDelegate_delegate
 

Properties

id< ZoomSDKRendererDelegatedelegate
 

Detailed Description

Definition at line 120 of file ZoomSDKRenderer.h.

Method Documentation

◆ getRawDataType

- (ZoomSDKRawDataType) getRawDataType

Get the type of raw data.

Returns
If the function succeeds, it will return the type of raw data.

◆ getResolution

- (ZoomSDKResolution) getResolution

Get the resolution of raw data.

Returns
If the function succeeds, it will return the resolution.

◆ getSubscribeID

- (unsigned int) getSubscribeID

Get the subscribe ID of raw data user is subscribing to.

Returns
If the function succeeds, it returns the subscribe ID.

◆ setResolution:

- (ZoomSDKError) setResolution: (ZoomSDKResolution) resolution

Set the resolution of raw data.

Parameters
resolutionThe resolution of raw data user want to receive.
Returns
If the function succeeds, it will return ZoomSDKError_Success.

◆ subscribe:rawDataType:

- (ZoomSDKError) subscribe: (unsigned int) subscribeID
rawDataType: (ZoomSDKRawDataType) rawDataType 

Subscribe to receive raw data.

Parameters
subscribeIDThe subscribe ID of the raw data user want to receive. If subscribe video, the subscribeID is user ID. If subscribe the sharing, the subscribeID is share source ID.
rawDataTypeThe type of raw data user want to receive.
Returns
If the function succeeds, it returns ZoomSDKError_Success.

◆ unSubscribe

- (ZoomSDKError) unSubscribe

Unsubscribe to receive raw data.

Returns
If the function succeeds, it will return ZoomSDKError_Success.

Field Documentation

◆ _delegate

- (id<ZoomSDKRendererDelegate>) _delegate
protected

Definition at line 125 of file ZoomSDKRenderer.h.

◆ _rawDataType

- (ZoomSDKRawDataType) _rawDataType
protected

Definition at line 123 of file ZoomSDKRenderer.h.

◆ _resolution

- (ZoomSDKResolution) _resolution
protected

Definition at line 124 of file ZoomSDKRenderer.h.

◆ _subscribeID

- (unsigned int) _subscribeID
protected

Definition at line 122 of file ZoomSDKRenderer.h.

Property Documentation

◆ delegate

- (id<ZoomSDKRendererDelegate>) delegate
readwritenonatomicassign

Definition at line 127 of file ZoomSDKRenderer.h.