A class to manage the subscription and unsubscription of video or share raw data. More...

#include <ZoomVideoSDKRawDataPipe.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKVideoType)	- rawdataPipeType
	Gets the raw data type.

(ZoomVideoSDKVideoStatus *_Nullable)	- videoStatus
	Gets the user's video status.

(ZoomVideoSDKShareStatus *_Nullable)	- shareStatus
	Gets the user's share status.

(ZoomVideoSDKError)	- subscribeWithDelegate:resolution:
	Subscribes to video or share raw data. You can subscribe your preview video data with user ID 0 before entering the session, you can call it just after you called joinSession. Otherwise, you can subscribe video or share raw data using the real user ID in callback onUserJoin.

(ZoomVideoSDKError)	- unSubscribeWithDelegate:
	Unsubscribes from video or share raw data.

Detailed Description

A class to manage the subscription and unsubscription of video or share raw data.

Definition at line 13 of file ZoomVideoSDKRawDataPipe.h.

Method Documentation

◆ rawdataPipeType

- (ZoomVideoSDKVideoType) rawdataPipeType

Gets the raw data type.

Returns: Share or Video data type. Refer to ZoomVideoSDKRawDataType for the list of enum [link ZoomVideoSDKRawDataType].

◆ shareStatus

- (ZoomVideoSDKShareStatus *_Nullable) shareStatus

Gets the user's share status.

Returns: If the function succeeds, it returns a ZoomVideoSDKShareStatus object. Otherwise, this function fails and returns nil.

◆ subscribeWithDelegate:resolution:

- (ZoomVideoSDKError) subscribeWithDelegate:		(id< ZoomVideoSDKRawDataPipeDelegate > _Nullable)	delegate
resolution:		(ZoomVideoSDKVideoResolution)	resolution

Subscribes to video or share raw data. You can subscribe your preview video data with user ID 0 before entering the session, you can call it just after you called joinSession. Otherwise, you can subscribe video or share raw data using the real user ID in callback onUserJoin.

Parameters

delegate	The object that receives the ZoomVideoSDKRawDataPipeDelegate event.
resolution	The resolution you want to subscribe. Valid only for video data.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

Warning: The param resolution cannot use ZoomVideoSDKVideoResolution_Auto in this function. Must specify the resolution you want.

◆ unSubscribeWithDelegate:

- (ZoomVideoSDKError) unSubscribeWithDelegate: (id< ZoomVideoSDKRawDataPipeDelegate > _Nullable) delegate

Unsubscribes from video or share raw data.

Parameters

delegate The object that receives the ZoomVideoSDKRawDataPipeDelegate event. Which was passed in subscribeWithDelegate:resolution:.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

◆ videoStatus

- (ZoomVideoSDKVideoStatus *_Nullable) videoStatus

Gets the user's video status.

Returns: If the function succeeds, it returns a ZoomVideoSDKVideoStatus object. Otherwise, this function fails and returns nil.