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

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- subscribe:listener:
	Subscribes video or share raw data.
(ZMVideoSDKErrors)	- unSubscribe:
	Unsubscribes video or share raw data.
(ZMVideoSDKRawDataType)	- getRawdataType
	Gets the raw data data type.
(ZMVideoSDKVideoStatus *_Nullable)	- getVideoStatus
	Gets video status.
(NSString *_Nullable)	- getVideoDeviceName
	Gets video device name.
(ZMVideoSDKShareStatus)	- getShareStatus
	Gets share status.
(ZMVideoSDKShareCapturePauseReason)	- getShareCapturePauseReason
	Gets the reason why the share capture is paused.
(ZMVideoSDKShareType)	- getShareType
	Gets share type.
(ZMVideoSDKVideoStatisticInfo *_Nullable)	- getVideoStatisticInfo
	Gets video statistic information.

Detailed Description

Video or share raw data pipe interface.

Definition at line 259 of file ZMVideoSDKUserHelper.h.

Method Documentation

◆ getRawdataType

- (ZMVideoSDKRawDataType) getRawdataType

Gets the raw data data type.

Returns: Share or Video data type.

References getRawdataType.

Referenced by getRawdataType.

◆ 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, it returns ZMVideoSDKShare_Capture_Pause_None.

References getShareCapturePauseReason.

Referenced by getShareCapturePauseReason.

◆ getShareStatus

- (ZMVideoSDKShareStatus) getShareStatus

Gets share status.

Returns: The current share status.

References getShareStatus.

Referenced by getShareStatus.

◆ getShareType

- (ZMVideoSDKShareType) getShareType

Gets share type.

Returns: The current share type.

References getShareType.

Referenced by getShareType.

◆ getVideoDeviceName

- (NSString *_Nullable) getVideoDeviceName

Gets video device name.

Returns: If the function succeeds, it returns the video device name. Otherwise, this function fails and returns nil.

References getVideoDeviceName.

Referenced by getVideoDeviceName.

◆ getVideoStatisticInfo

- (ZMVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Gets video statistic information.

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

References getVideoStatisticInfo.

Referenced by getVideoStatisticInfo.

◆ getVideoStatus

- (ZMVideoSDKVideoStatus *_Nullable) getVideoStatus

Gets video status.

Returns: If the function succeeds, it returns pointer of video status object. Otherwise, this function fails and returns nil.

References getVideoStatus.

Referenced by getVideoStatus.

◆ subscribe:listener:

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

Subscribes video or share raw data.

Parameters

resolution	The subscribe size.
listener	The callback sink object.

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

◆ unSubscribe:

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

Unsubscribes video or share raw data.