Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKSubSessionManager Class Referenceabstract

Subsession manager helper interface. More...

#include <zoom_video_sdk_subsession_interface.h>

Public Member Functions

virtual ~IZoomVideoSDKSubSessionManager ()
 
virtual ZoomVideoSDKErrors startSubSession ()=0
 Start subsession.
 
virtual bool isSubSessionStarted ()=0
 Determine if the subsession has started.
 
virtual ZoomVideoSDKErrors stopSubSession ()=0
 Stop subsession.
 
virtual ZoomVideoSDKErrors broadcastMessage (const zchar_t *sMessage)=0
 Broadcast a message to all subsessions.
 

Detailed Description

Subsession manager helper interface.

Definition at line 151 of file zoom_video_sdk_subsession_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKSubSessionManager()

virtual IZoomVideoSDKSubSessionManager::~IZoomVideoSDKSubSessionManager ( )
inlinevirtual

Definition at line 154 of file zoom_video_sdk_subsession_interface.h.

154{};

Member Function Documentation

◆ broadcastMessage()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionManager::broadcastMessage ( const zchar_t * sMessage)
pure virtual

Broadcast a message to all subsessions.

Parameters
sMessageThe message to be broadcast.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.
Note
'onBroadcastMessageFromMainSession' is the corresponding callback notification.

◆ isSubSessionStarted()

virtual bool IZoomVideoSDKSubSessionManager::isSubSessionStarted ( )
pure virtual

Determine if the subsession has started.

Returns
If the subsession is started, the return value is true, otherwise not.

◆ startSubSession()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionManager::startSubSession ( )
pure virtual

Start subsession.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.
Note
'onSubSessionStatusChanged' is the corresponding callback notification.

◆ stopSubSession()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionManager::stopSubSession ( )
pure virtual

Stop subsession.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success, otherwise not.
Note
'onSubSessionStatusChanged' is the corresponding callback notification.