Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKSubSessionHelper.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7
8NS_ASSUME_NONNULL_BEGIN
9
19- (NSString * _Nullable)getRequestUserName;
20
25- (NSString * _Nullable)getRequestSubSessionName;
26
33
39@end
40
45@interface ZoomVideoSDKSubSessionUser : NSObject
50- (NSString *)getUserName;
55- (NSString *)getUserGUID;
56@end
57
62@interface ZoomVideoSDKSubSessionKit : NSObject
67- (NSString * _Nullable)getSubSessionName;
72- (NSString * _Nullable)getSubSessionID;
73
84@end
85
90@interface ZoomVideoSDKSubSessionManager : NSObject
107- (BOOL)isSubSessionStarted;
114- (ZoomVideoSDKError)broadcastMessage:(NSString *_Nonnull)message;
115
116@end
117
134
135@end
136
142@interface ZoomVideoSDKSubSessionHelper : NSObject
148- (ZoomVideoSDKError)addSubSessionToPreList:(NSArray <NSString *>* _Nonnull)subSessionNames;
154- (ZoomVideoSDKError)removeSubSessionFromPreList:(NSArray <NSString *> *_Nonnull)subSessionNames;
164- (NSArray <NSString*>* _Nullable)getSubSessionPreList;
171
183
184@end
185
186NS_ASSUME_NONNULL_END
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
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.
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.
NSString * getUserName()
Gets the subsession user's username.