IZoomVideoSDKRawDataPipe Class Reference

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

#include <zoom_video_sdk_user_helper_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	subscribe (ZoomVideoSDKResolution resolution, IZoomVideoSDKRawDataPipeDelegate *listener)=0
	Subscribe video/share.
virtual ZoomVideoSDKErrors	unSubscribe (IZoomVideoSDKRawDataPipeDelegate *listener)=0
	Unsubscribe video/share.
virtual ZoomVideoSDKRawDataType	getRawdataType ()=0
	Get the raw data data type.
virtual ZoomVideoSDKVideoStatus	getVideoStatus ()=0
	Get video status.
virtual const zchar_t *	getVideoDeviceName ()=0
	Get video device name.
virtual ZoomVideoSDKShareStatus	getShareStatus ()=0
	Get share status.
virtual ZoomVideoSDKShareCapturePauseReason	getShareCapturePauseReason ()=0
	Gets the reason why the share capture is paused.
virtual ZoomVideoSDKShareType	getShareType ()=0
	Get share type.
virtual ZoomVideoSDKVideoStatisticInfo	getVideoStatisticInfo ()=0
	Get video statistic information.

Detailed Description

Video/share raw data pipe interface.

Definition at line 171 of file zoom_video_sdk_user_helper_interface.h.

Member Function Documentation

getRawdataType()

virtual ZoomVideoSDKRawDataType IZoomVideoSDKRawDataPipe::getRawdataType ( )

pure virtual

Get the raw data data type.

Returns

Share or Video data type.

getShareCapturePauseReason()

virtual ZoomVideoSDKShareCapturePauseReason IZoomVideoSDKRawDataPipe::getShareCapturePauseReason ( )

pure virtual

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 ZoomVideoSDKShare_Capture_Pause_None.

getShareStatus()

virtual ZoomVideoSDKShareStatus IZoomVideoSDKRawDataPipe::getShareStatus ( )

pure virtual

Get share status.

Returns

Share status of the user object.

getShareType()

virtual ZoomVideoSDKShareType IZoomVideoSDKRawDataPipe::getShareType ( )

pure virtual

Get share type.

Returns

Share type of the user object.

getVideoDeviceName()

virtual const zchar_t * IZoomVideoSDKRawDataPipe::getVideoDeviceName ( )

pure virtual

Get video device name.

Returns

Video device name if the function succeeds, otherwise returns nullptr.

getVideoStatisticInfo()

virtual ZoomVideoSDKVideoStatisticInfo IZoomVideoSDKRawDataPipe::getVideoStatisticInfo ( )

pure virtual

Get video statistic information.

Returns

video statistic information.

getVideoStatus()

virtual ZoomVideoSDKVideoStatus IZoomVideoSDKRawDataPipe::getVideoStatus ( )

pure virtual

Get video status.

Returns

Video status of the user object.

subscribe()

virtual ZoomVideoSDKErrors IZoomVideoSDKRawDataPipe::subscribe ( ZoomVideoSDKResolution resolution, IZoomVideoSDKRawDataPipeDelegate * listener )

pure virtual

Subscribe video/share.

Parameters

resolution	Subscribe size.
listener	Callback sink object.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed.

unSubscribe()

virtual ZoomVideoSDKErrors IZoomVideoSDKRawDataPipe::unSubscribe ( IZoomVideoSDKRawDataPipeDelegate * listener )

pure virtual

Unsubscribe video/share.

Parameters

listener

The callback sink object.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed.