IZoomVideoSDKIncomingLiveStreamHelper Class Reference

Incoming live stream helper interface. Note: Currently only supports one stream. More...

#include <zoom_video_sdk_livestream_helper_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	bindIncomingLiveStream (const zchar_t *strStreamKeyID)=0
	Bind incoming live stream with a stream key ID.
virtual ZoomVideoSDKErrors	unbindIncomingLiveStream (const zchar_t *strStreamKeyID)=0
	Unbind the bound incoming live stream.
virtual ZoomVideoSDKErrors	getIncomingLiveStreamStatus ()=0
	Get the status of bound streams.
virtual ZoomVideoSDKErrors	startIncomingLiveStream (const zchar_t *strStreamKeyID)=0
	Start the bound stream as a special participant.
virtual ZoomVideoSDKErrors	stopIncomingLiveStream (const zchar_t *strStreamKeyID)=0
	Stop the bound stream as a special participant.

Detailed Description

Incoming live stream helper interface. Note: Currently only supports one stream.

Definition at line 56 of file zoom_video_sdk_livestream_helper_interface.h.

Member Function Documentation

bindIncomingLiveStream()

virtual ZoomVideoSDKErrors IZoomVideoSDKIncomingLiveStreamHelper::bindIncomingLiveStream ( const zchar_t * strStreamKeyID )

pure virtual

Bind incoming live stream with a stream key ID.

Parameters

strStreamKeyID

The stream key ID to bind.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

getIncomingLiveStreamStatus()

virtual ZoomVideoSDKErrors IZoomVideoSDKIncomingLiveStreamHelper::getIncomingLiveStreamStatus ( )

pure virtual

Get the status of bound streams.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

startIncomingLiveStream()

virtual ZoomVideoSDKErrors IZoomVideoSDKIncomingLiveStreamHelper::startIncomingLiveStream ( const zchar_t * strStreamKeyID )

pure virtual

Start the bound stream as a special participant.

Parameters

strStreamKeyID

The stream key ID to start.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

stopIncomingLiveStream()

virtual ZoomVideoSDKErrors IZoomVideoSDKIncomingLiveStreamHelper::stopIncomingLiveStream ( const zchar_t * strStreamKeyID )

pure virtual

Stop the bound stream as a special participant.

Parameters

strStreamKeyID

The stream key ID to stop.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

unbindIncomingLiveStream()

virtual ZoomVideoSDKErrors IZoomVideoSDKIncomingLiveStreamHelper::unbindIncomingLiveStream ( const zchar_t * strStreamKeyID )

pure virtual

Unbind the bound incoming live stream.

Parameters

strStreamKeyID

The stream key ID to unbind.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.