Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKSubSessionHelper.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7
8NS_ASSUME_NONNULL_BEGIN
9
17
27- (NSString * _Nullable)getRequestUserName;
28
33- (NSString * _Nullable)getRequestSubSessionName;
34
41
47@end
48
53@interface ZoomVideoSDKSubSessionUser : NSObject
58- (NSString *)getUserName;
63- (NSString *)getUserGUID;
64
67@end
68
73@interface ZoomVideoSDKSubSessionKit : NSObject
78- (NSString * _Nullable)getSubSessionName;
83- (NSString * _Nullable)getSubSessionID;
84
95@end
96
101@interface ZoomVideoSDKSubSessionManager : NSObject
125- (ZoomVideoSDKError)broadcastMessage:(NSString *_Nonnull)message;
126
127@end
128
145
151
152@end
153
159@interface ZoomVideoSDKSubSessionHelper : NSObject
165- (ZoomVideoSDKError)addSubSessionToPreList:(NSArray <NSString *>* _Nonnull)subSessionNames;
171- (ZoomVideoSDKError)removeSubSessionFromPreList:(NSArray <NSString *> *_Nonnull)subSessionNames;
181- (NSArray <NSString*>* _Nullable)getSubSessionPreList;
188
200
201@end
202
203NS_ASSUME_NONNULL_END
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
ZoomVideoSDKSubSessionUserType
Indicates which session a lightweight user belongs to.
@ ZoomVideoSDKSubSessionUserTypeMainSession
@ ZoomVideoSDKSubSessionUserTypeSubSession
ZoomVideoSDKError withdrawSubSessionList()
Withdraws all committed subsession list.
ZoomVideoSDKError commitSubSessionList()
Withdraws all committed subsession list and commits the prepared list.
NSArray< ZoomVideoSDKSubSessionKit * > *_Nullable getCommittedSubSessionList()
Gets the committed subsession list.
NSArray< NSString * > *_Nullable getSubSessionPreList()
Gets the subsession name prepared list.
ZoomVideoSDKError clearSubSessionPreList()
Clears the prepared list.
Represents a subsession instance.
NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable getSubSessionUserList()
Gets the user list in this subsession.
ZoomVideoSDKError joinSubSession()
Joins this subsession.
NSString *_Nullable getSubSessionName()
Gets the subsession's name.
NSString *_Nullable getSubSessionID()
Gets the subsession's ID.
Manages subsession lifecycle and communication.
BOOL isSubSessionStarted()
Determines whether the subsession is started.
ZoomVideoSDKError startSubSession()
Starts subsession.
ZoomVideoSDKError stopSubSession()
Stops subsession.
SubSession attendee helper interface.
NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable getMainSessionUserList()
Gets main-session users with stable GUID and node ID information.
ZoomVideoSDKError returnToMainSession()
Returns to main session.
ZoomVideoSDKError requestForHelp()
Requests for help.
NSString *_Nullable getRequestSubSessionName()
Gets the name of the subsession where the user sent this request.
ZoomVideoSDKError ignore()
Ignores this request.
NSString *_Nullable getRequestUserName()
Gets the username of the user who sent this request.
ZoomVideoSDKError joinSubSessionByUserRequest()
Joins the subsession which request help is from.
Represents a subsession user info.
NSString * getUserGUID()
Gets the subsession user's GUID.
ZoomVideoSDKSubSessionUserType getUserType()
Gets whether the user belongs to the main session or a subsession.
NSString * getUserName()
Gets the subsession user's username.