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#import <ZMVideoSDK/ZMVideoSDKDef.h>
9
10@class ZMVideoSDKUser;
11NS_ASSUME_NONNULL_BEGIN
12
17@interface ZMVideoSDKSubSessionUser : NSObject
21@property(nonatomic, copy, readonly)NSString* userName;
25@property(nonatomic, copy, readonly)NSString* userGUID;
27@property(nonatomic, assign, readonly)ZMVideoSDKSubSessionUserType userType;
28@end
29
34@interface ZMVideoSDKSubSessionKit : NSObject
38@property(nonatomic, copy, readonly)NSString* subSessionName;
42@property(nonatomic, copy, readonly)NSString* subSessionID;
48
54@end
55
64@property(nonatomic, copy, readonly)NSString* requestUserName;
68@property(nonatomic, copy, readonly)NSString* requestSubSessionName;
75
81@end
82
87@interface ZMVideoSDKSubSessionManager : NSObject
94
100
107
114- (ZMVideoSDKErrors)broadcastMessage:(NSString*)message;
115@end
116
127
134
140@end
141
142
148@interface ZMVideoSDKSubSessionHelper : NSObject
149
155- (ZMVideoSDKErrors)commitSubSessionList:(NSArray<NSString*>*)subSessionList;
156
162
168@end
169NS_ASSUME_NONNULL_END
ZMVideoSDKSubSessionUserType
Indicates which session a lightweight user belongs to.
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.
NSArray< ZMVideoSDKSubSessionUser * > *_Nullable getMainSessionUserList()
Gets lightweight users in the main session.
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.
ZMVideoSDKSubSessionUserType userType
Gets the session containing this user.
NSString * userGUID
Gets the subsession user's GUID.
Zoom Video SDK user information.