zoom_video_sdk_subsession_interface.h File Reference

Subsession helper. More...

#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"

Go to the source code of this file.

Classes
class	ISubSessionUser
	Lightweight user identity used for subsession and cross-session commands. More...
class	ISubSessionKit
	Subsession kit. More...
class	ISubSessionUserHelpRequestHandler
	Subsession user help request handler. More...
class	IZoomVideoSDKSubSessionManager
	Subsession manager helper interface. More...
class	IZoomVideoSDKSubSessionParticipant
	Subsession participant helper interface. More...
class	IZoomVideoSDKSubSessionHelper
	Subsession helper. interface. More...

Enumerations
enum	ZoomVideoSDKSubSessionStatus {   ZoomVideoSDKSubSessionStatus_None = 0 , ZoomVideoSDKSubSessionStatus_Committed , ZoomVideoSDKSubSessionStatus_Withdrawn , ZoomVideoSDKSubSessionStatus_Started ,   ZoomVideoSDKSubSessionStatus_Stopping , ZoomVideoSDKSubSessionStatus_Stopped , ZoomVideoSDKSubSessionStatus_CommitFailed , ZoomVideoSDKSubSessionStatus_WithdrawFailed ,   ZoomVideoSDKSubSessionStatus_StartFailed , ZoomVideoSDKSubSessionStatus_StopFailed }
	Enumerations of subsession statuses. More...
enum	ZoomVideoSDKUserHelpRequestResult { ZoomVideoSDKUserHelpRequestResult_Idle = 0 , ZoomVideoSDKUserHelpRequestResult_Busy , ZoomVideoSDKUserHelpRequestResult_Ignore , ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession }
	Enumerations of subsession user help request results. More...
enum	ZoomVideoSDKSubSessionUserType { ZoomVideoSDKSubSessionUserType_MainSession = 0 , ZoomVideoSDKSubSessionUserType_SubSession = 1 }
	Indicates whether a lightweight user belongs to the main session or a subsession. More...

Detailed Description

Subsession helper.

Definition in file zoom_video_sdk_subsession_interface.h.

Enumeration Type Documentation

ZoomVideoSDKSubSessionStatus

enum ZoomVideoSDKSubSessionStatus

Enumerations of subsession statuses.

Enumerator
ZoomVideoSDKSubSessionStatus_None	The Initialized status.
ZoomVideoSDKSubSessionStatus_Committed	When a subsession is committed.
ZoomVideoSDKSubSessionStatus_Withdrawn	When a subsession is withdrawn.
ZoomVideoSDKSubSessionStatus_Started	When the subsession is started.
ZoomVideoSDKSubSessionStatus_Stopping	When the subsession is stopping.
ZoomVideoSDKSubSessionStatus_Stopped	When the subsession is stopped.
ZoomVideoSDKSubSessionStatus_CommitFailed	When commit subsession failed.
ZoomVideoSDKSubSessionStatus_WithdrawFailed	When withdraw subsession failed.
ZoomVideoSDKSubSessionStatus_StartFailed	When start subsession failed.
ZoomVideoSDKSubSessionStatus_StopFailed	When stop subsession failed.

Definition at line 16 of file zoom_video_sdk_subsession_interface.h.

{
    ZoomVideoSDKSubSessionStatus_None = 0,
    ZoomVideoSDKSubSessionStatus_Committed,
    ZoomVideoSDKSubSessionStatus_Withdrawn,
    ZoomVideoSDKSubSessionStatus_Started,
    ZoomVideoSDKSubSessionStatus_Stopping,
    ZoomVideoSDKSubSessionStatus_Stopped,
    ZoomVideoSDKSubSessionStatus_CommitFailed,
    ZoomVideoSDKSubSessionStatus_WithdrawFailed,
    ZoomVideoSDKSubSessionStatus_StartFailed,
    ZoomVideoSDKSubSessionStatus_StopFailed,
};

ZoomVideoSDKSubSessionUserType

enum ZoomVideoSDKSubSessionUserType

Indicates whether a lightweight user belongs to the main session or a subsession.

Enumerator
ZoomVideoSDKSubSessionUserType_MainSession
ZoomVideoSDKSubSessionUserType_SubSession

Definition at line 59 of file zoom_video_sdk_subsession_interface.h.

{
    ZoomVideoSDKSubSessionUserType_MainSession = 0,
    ZoomVideoSDKSubSessionUserType_SubSession = 1,
};

ZoomVideoSDKUserHelpRequestResult

enum ZoomVideoSDKUserHelpRequestResult

Enumerations of subsession user help request results.

Enumerator
ZoomVideoSDKUserHelpRequestResult_Idle	The host has received the help request, and no one else is currently requesting help.
ZoomVideoSDKUserHelpRequestResult_Busy	The host is handling another user's request with the request dialog.
ZoomVideoSDKUserHelpRequestResult_Ignore	The host is handling another user's request.
ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession	The host is already in this subsession.

Definition at line 43 of file zoom_video_sdk_subsession_interface.h.

{
    ZoomVideoSDKUserHelpRequestResult_Idle = 0,
    ZoomVideoSDKUserHelpRequestResult_Busy,
    ZoomVideoSDKUserHelpRequestResult_Ignore,
    ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession
};