Video SDK for Linux API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKSubSessionParticipant Class Referenceabstract

Subsession participant helper interface. More...

#include <zoom_video_sdk_subsession_interface.h>

Public Member Functions

virtual ~IZoomVideoSDKSubSessionParticipant ()
virtual ZoomVideoSDKErrors returnToMainSession ()=0
 Return to main session.
virtual ZoomVideoSDKErrors requestForHelp ()=0
 Request help.
virtual IVideoSDKVector< ISubSessionUser * > * getMainSessionUserList ()=0
 Gets users in the main session as lightweight ISubSessionUser targets.

Detailed Description

Subsession participant helper interface.

Definition at line 207 of file zoom_video_sdk_subsession_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKSubSessionParticipant()

virtual IZoomVideoSDKSubSessionParticipant::~IZoomVideoSDKSubSessionParticipant ( )
inlinevirtual

Definition at line 210 of file zoom_video_sdk_subsession_interface.h.

210{};

Member Function Documentation

◆ getMainSessionUserList()

virtual IVideoSDKVector< ISubSessionUser * > * IZoomVideoSDKSubSessionParticipant::getMainSessionUserList ( )
pure virtual

Gets users in the main session as lightweight ISubSessionUser targets.

Returns
A temporary list owned by the SDK, or nullptr when the participant context is unavailable. The list and the strings it contains remain valid until the next call to this method or destruction of the participant.

◆ requestForHelp()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionParticipant::requestForHelp ( )
pure virtual

Request help.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.
Note
'onSubSessionUserHelpRequestResult'is the corresponding callback notification.

◆ returnToMainSession()

virtual ZoomVideoSDKErrors IZoomVideoSDKSubSessionParticipant::returnToMainSession ( )
pure virtual

Return to main session.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.