Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKSubsessionHelper.h
Go to the documentation of this file.
1
5
6
7#import <Foundation/Foundation.h>
8
9@class ZMVideoSDKUser;
10NS_ASSUME_NONNULL_BEGIN
11
16@interface ZMVideoSDKSubSessionUser : NSObject
20@property(nonatomic, copy, readonly)NSString* userName;
24@property(nonatomic, copy, readonly)NSString* userGUID;
25@end
26
31@interface ZMVideoSDKSubSessionKit : NSObject
35@property(nonatomic, copy, readonly)NSString* subSessionName;
39@property(nonatomic, copy, readonly)NSString* subSessionID;
45
51@end
52
61@property(nonatomic, copy, readonly)NSString* requestUserName;
65@property(nonatomic, copy, readonly)NSString* requestSubSessionName;
72
78@end
79
84@interface ZMVideoSDKSubSessionManager : NSObject
91
97
104
111- (ZMVideoSDKErrors)broadcastMessage:(NSString*)message;
112@end
113
124
131@end
132
133
139@interface ZMVideoSDKSubSessionHelper : NSObject
140
146- (ZMVideoSDKErrors)commitSubSessionList:(NSArray<NSString*>*)subSessionList;
147
153
159@end
160NS_ASSUME_NONNULL_END
ZMVideoSDKErrors
Enumerates all errors in the VideoSDK.
Helper class for managing subsessions.
ZMVideoSDKErrors withdrawSubSessionList()
Withdraw all committed subsessions.
NSArray< ZMVideoSDKSubSessionKit * > *_Nullable getCommittedSubSessionList()
Gets the list of commited subsessions.
Represents a subsession instance.
ZMVideoSDKErrors joinSubSession()
Joins this subsession.
NSArray< ZMVideoSDKSubSessionUser * > *_Nullable getSubSessionUserList()
Gets the list of users in this subsession.
NSString * subSessionID
Gets the subsession's ID.
NSString * subSessionName
Gets the subsession's name.
Manages subsession lifecycle and communication.
BOOL isSubSessionStarted()
Determines if the subsession has started.
ZMVideoSDKErrors stopSubSession()
Stops subsession.
ZMVideoSDKErrors startSubSession()
Starts subsession.
Interface for subsession participants.
ZMVideoSDKErrors requestForHelp()
Requests help.
ZMVideoSDKErrors returnToMainSession()
Return to main session.
Handler for user help requests in subsessions.
ZMVideoSDKErrors ignore()
Ignore this request.
NSString * requestSubSessionName
Gets the subsession's name where the user sent this request.
NSString * requestUserName
Gets the user's username who sent this request.
ZMVideoSDKErrors joinSubSessionByUserRequest()
Joins the subsession where the help request originated.
Represents a user within a subsession.
NSString * userName
Gets the subsession user's username.
NSString * userGUID
Gets the subsession user's GUID.
Zoom Video SDK user information.