Video/share raw data pipe interface. More...

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- subscribe:listener:
	Subscribe video/share raw data.

(ZMVideoSDKErrors)	- unSubscribe:
	Unsubscribe video/share raw data.

(ZMVideoSDKRawDataType)	- getRawdataType
	Get the raw data data type.

(ZMVideoSDKVideoStatus *_Nullable)	- getVideoStatus
	Get video status.

(NSString *_Nullable)	- getVideoDeviceName
	Get video device name.

(ZMVideoSDKShareStatus)	- getShareStatus
	Get share status.

(ZMVideoSDKShareCapturePauseReason)	- getShareCapturePauseReason
	Gets the reason why the share capture is paused.

(ZMVideoSDKShareType)	- getShareType
	Get share type.

(ZMVideoSDKVideoStatisticInfo *_Nullable)	- getVideoStatisticInfo
	Get video statistic information.

Detailed Description

Video/share raw data pipe interface.

Definition at line 258 of file ZMVideoSDKUserHelper.h.

Method Documentation

◆ getRawdataType

- (ZMVideoSDKRawDataType) getRawdataType

Get the raw data data type.

Returns: Share or Video data type.

◆ getShareCapturePauseReason

- (ZMVideoSDKShareCapturePauseReason) getShareCapturePauseReason

Gets the reason why the share capture is paused.

Returns: The current pause reason of the ongoing share.

Note: If sharing is not paused, the return value is ZMVideoSDKShare_Capture_Pause_None.

◆ getShareStatus

- (ZMVideoSDKShareStatus) getShareStatus

Get share status.

Returns: If the function succeeds, the return value is current share status.

◆ getShareType

- (ZMVideoSDKShareType) getShareType

Get share type.

Returns: If the function succeeds, the return value is current share type.

◆ getVideoDeviceName

- (NSString *_Nullable) getVideoDeviceName

Get video device name.

Returns: If the function succeeds, the return value is the video device name, otherwise returns nil.

◆ getVideoStatisticInfo

- (ZMVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Get video statistic information.

Returns: If the function succeeds, the return value is the object of ZMVideoSDKVideoStatisticInfo.

◆ getVideoStatus

- (ZMVideoSDKVideoStatus *_Nullable) getVideoStatus

Get video status.

Returns: If the function succeeds, the return value is pointer of video status object, otherwise returns nil.

◆ subscribe:listener:

- (ZMVideoSDKErrors) subscribe:		(ZMVideoSDKResolution)	resolution
listener:		(id< ZMVideoSDKRawDataPipeDelegate >)	listener

Subscribe video/share raw data.

Parameters

resolution	The subscribe size.
listener	The callback sink object.

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success.

◆ unSubscribe:

- (ZMVideoSDKErrors) unSubscribe: (id< ZMVideoSDKRawDataPipeDelegate >) listener

Unsubscribe video/share raw data.