IZoomVideoSDKSubSessionHelper Class Reference

Subsession helper interface. More...

#include <zoom_video_sdk_subsession_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKSubSessionHelper ()
virtual ZoomVideoSDKErrors	addSubSessionToPreList (const zchar_t *sSubSessionName)=0
	Add a subsession name to the prepared list.
virtual ZoomVideoSDKErrors	removeSubSessionFromPreList (const zchar_t *sSubSessionName)=0
	Remove a subsession name from the prepared list.
virtual ZoomVideoSDKErrors	clearSubSessionPreList ()=0
	Clear the prepared list.
virtual IVideoSDKVector< const zchar_t * > *	getSubSessionPreList ()=0
	Get the list of prepared subsession names.
virtual ZoomVideoSDKErrors	commitSubSessionList ()=0
	Withdraw all committed subsessions and commit the prepared list.
virtual ZoomVideoSDKErrors	withdrawSubSessionList ()=0
	Withdraw all committed subsessions.
virtual IVideoSDKVector< ISubSessionKit * > *	getCommittedSubSessionList ()=0
	Get the list of commited subsessions.

Detailed Description

Subsession helper interface.

Note

Only session host and manager can get this helper.

Definition at line 213 of file zoom_video_sdk_subsession_interface.h.

Constructor & Destructor Documentation

~IZoomVideoSDKSubSessionHelper()

virtual IZoomVideoSDKSubSessionHelper::~IZoomVideoSDKSubSessionHelper ( )

inlinevirtual

Definition at line 216 of file zoom_video_sdk_subsession_interface.h.

{};

Member Function Documentation

addSubSessionToPreList()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionHelper::addSubSessionToPreList ( const zchar_t * sSubSessionName )

pure virtual

Add a subsession name to the prepared list.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.

clearSubSessionPreList()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionHelper::clearSubSessionPreList ( )

pure virtual

Clear the prepared list.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.

commitSubSessionList()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionHelper::commitSubSessionList ( )

pure virtual

Withdraw all committed subsessions and commit the prepared list.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.

Note

If the function succeeds, the prepared list will be cleared, 'onSubSessionStatusChanged'is the corresponding callback notification.

getCommittedSubSessionList()

virtual IVideoSDKVector< ISubSessionKit * > * IZoomVideoSDKSubSessionHelper::getCommittedSubSessionList ( )

pure virtual

Get the list of commited subsessions.

Returns

If the function succeeds, it returns an array of ISubSessionKit. Otherwise returns NULL. For more details, see ISubSessionKit.

getSubSessionPreList()

virtual IVideoSDKVector< const zchar_t * > * IZoomVideoSDKSubSessionHelper::getSubSessionPreList ( )

pure virtual

Get the list of prepared subsession names.

Returns

If the function succeeds, it returns an array of subsession names.

removeSubSessionFromPreList()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionHelper::removeSubSessionFromPreList ( const zchar_t * sSubSessionName )

pure virtual

Remove a subsession name from the prepared list.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.

withdrawSubSessionList()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionHelper::withdrawSubSessionList ( )

pure virtual

Withdraw all committed subsessions.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.

Note

If the function succeeds, the prepared list will be cleared, 'onSubSessionStatusChanged'is the corresponding callback notification.