ZoomSDKRenderer Class Reference

Subscribe to raw video or share data and handle rendering. More...

#include <ZoomSDKRenderer.h>

Inherits NSObject.

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

Protected Attributes
unsigned int	_subscribeID
ZoomSDKRawDataType	_rawDataType
ZoomSDKResolution	_resolution
id< ZoomSDKRendererDelegate >	_delegate

Properties
id< ZoomSDKRendererDelegate >	delegate
	The delegate to receive rendering events.

Detailed Description

Subscribe to raw video or share data and handle rendering.

Definition at line 134 of file ZoomSDKRenderer.h.

Method Documentation

getRawDataType

- (ZoomSDKRawDataType) getRawDataType

Gets the type of raw data.

Returns

The type of raw data.

References getRawDataType.

Referenced by getRawDataType.

getResolution

- (ZoomSDKResolution) getResolution

Gets the resolution of raw data.

Returns

The resolution.

References getResolution.

Referenced by getResolution.

getSubscribeID

- (unsigned int) getSubscribeID

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

Returns

If the function succeeds, it returns the subscribe ID. Otherwise, returns -1.

References getSubscribeID.

Referenced by getSubscribeID.

setResolution:

- (ZoomSDKError) setResolution:

(ZoomSDKResolution)

resolution

Sets the resolution of raw data.

Parameters

resolution

The resolution of raw data user want to receive.

Returns

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

subscribe:rawDataType:

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

Subscribe to receive raw data.

Parameters

subscribeID	The 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.
rawDataType	The type of raw data user want to receive.

Returns

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

unSubscribe

- (ZoomSDKError) unSubscribe

Unsubscribe to receive raw data.

Returns

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

References unSubscribe.

Referenced by unSubscribe.

Field Documentation

_delegate

- (id<ZoomSDKRendererDelegate>) _delegate

protected

Definition at line 139 of file ZoomSDKRenderer.h.

_rawDataType

- (ZoomSDKRawDataType) _rawDataType

protected

Definition at line 137 of file ZoomSDKRenderer.h.

_resolution

- (ZoomSDKResolution) _resolution

protected

Definition at line 138 of file ZoomSDKRenderer.h.

_subscribeID

- (unsigned int) _subscribeID

protected

Definition at line 136 of file ZoomSDKRenderer.h.

Property Documentation

delegate

- (id<ZoomSDKRendererDelegate>) delegate

readwritenonatomicassign

The delegate to receive rendering events.

Definition at line 144 of file ZoomSDKRenderer.h.