Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKRawDataPipe Class Reference

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

#include <ZoomVideoSDKRawDataPipe.h>

Inherits NSObject.

Instance Methods

(ZoomVideoSDKVideoType- rawdataPipeType
 Get the raw data data type.
 
(ZoomVideoSDKVideoStatus *_Nullable) - videoStatus
 The user's video status.
 
(ZoomVideoSDKShareStatus *_Nullable) - shareStatus
 The user's share status.
 
(ZoomVideoSDKError- subscribeWithDelegate:resolution:
 Call the function to subscribe video or share raw data. You can subscribe your 'preview video' data with userid=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 userid in callback "onUserJoin:".
 
(ZoomVideoSDKError- unSubscribeWithDelegate:
 Call the function to unsubscribe video or share raw data.
 

Detailed Description

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

Definition at line 16 of file ZoomVideoSDKRawDataPipe.h.

Method Documentation

◆ rawdataPipeType

- (ZoomVideoSDKVideoType) rawdataPipeType

Get the raw data data type.

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

◆ shareStatus

- (ZoomVideoSDKShareStatus *_Nullable) shareStatus

The user's share status.

Returns
share status. For more information, see [ZoomVideoSDKShareStatus].

◆ subscribeWithDelegate:resolution:

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

Call the function to subscribe video or share raw data. You can subscribe your 'preview video' data with userid=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 userid in callback "onUserJoin:".

Parameters
delegatethe object receive the "ZoomVideoSDKRawDataPipeDelegate" event.
resolutionthe resolution you want to subscribe. Valid only for video data.
Returns
The result of the method.
Warning
The param resolution can't using "ZoomVideoSDKVideoResolution_Auto" in this function. must be sperify the resolution you want.

◆ unSubscribeWithDelegate:

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

Call the function to unsubscribe video or share raw data.

Parameters
delegatethe object receive the "ZoomVideoSDKRawDataPipeDelegate" event. Which pass in "subscribeWithDelegate:resolution:"
Returns
The result of the method.

◆ videoStatus

- (ZoomVideoSDKVideoStatus *_Nullable) videoStatus

The user's video status.

Warning
video status. For more information, see [ZoomVideoSDKVideoStatus].