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

#import <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) - getUserID
 Get the user id of raw data user is subscribing.
 
(ZoomSDKResolution- getResolution
 Get the resolution of raw data.
 
(ZoomSDKError- setResolution:
 Set the resolution of raw data.
 

Protected Attributes

unsigned int _userID
 
ZoomSDKRawDataType _rawDataType
 
ZoomSDKResolution _resolution
 
id< ZoomSDKRendererDelegate_delegate
 

Properties

id< ZoomSDKRendererDelegatedelegate
 

Detailed Description

Definition at line 87 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.

◆ getUserID

- (unsigned int) getUserID

Get the user id of raw data user is subscribing.

Returns
If the function succeeds, it will return the user 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)  userID
rawDataType: (ZoomSDKRawDataType rawDataType 

Subscribe to receive raw data.

Parameters
userIDThe user id of the raw data user want to receive.
rawDataTypeThe type of raw data user want to receive.
Returns
If the function succeeds, it will return 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 92 of file ZoomSDKRenderer.h.

◆ _rawDataType

- (ZoomSDKRawDataType) _rawDataType
protected

Definition at line 90 of file ZoomSDKRenderer.h.

◆ _resolution

- (ZoomSDKResolution) _resolution
protected

Definition at line 91 of file ZoomSDKRenderer.h.

◆ _userID

- (unsigned int) _userID
protected

Definition at line 89 of file ZoomSDKRenderer.h.

Property Documentation

◆ delegate

- (id<ZoomSDKRendererDelegate>) delegate
readwritenonatomicassign

Definition at line 94 of file ZoomSDKRenderer.h.