Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKSubSessionHelper.h
Go to the documentation of this file.
1//
2// ZoomVIdeoSDKSubSessionHelper.h
3// ZoomVideoSDK
4//
5// Created by Zoom on 2025/5/15.
6// Copyright © 2025 Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10
11NS_ASSUME_NONNULL_BEGIN
12
21-(NSString * _Nullable)getRequestUserName;
22
27-(NSString * _Nullable)getRequestSubSessionName;
28
35
41@end
42
43@interface ZoomVideoSDKSubSessionUser : NSObject
48- (NSString *)getUserName;
53- (NSString *)getUserGUID;
54@end
55
56@interface ZoomVideoSDKSubSessionKit : NSObject
61- (NSString * _Nullable)getSubSessionName;
66- (NSString * _Nullable)getSubSessionID;
67
78@end
79
80@interface ZoomVideoSDKSubSessionManager : NSObject
104- (ZoomVideoSDKError)broadcastMessage:(NSString *_Nonnull)message;
105
106@end
107
123
124@end
129@interface ZoomVideoSDKSubSessionHelper : NSObject
134- (ZoomVideoSDKError)addSubSessionToPreList:(NSArray <NSString *>* _Nonnull)subSessionNames;
139- (ZoomVideoSDKError)removeSubSessionFromPreList:(NSArray <NSString *> *_Nonnull)subSessionNames;
149- (NSArray <NSString*>* _Nullable)getSubSessionPreList;
156
167
168@end
169
170NS_ASSUME_NONNULL_END
ZoomVideoSDKError
Enumerates all errors in the VideoSDK.
ZoomVideoSDKError withdrawSubSessionList()
Withdraw all committed subsession list.
ZoomVideoSDKError commitSubSessionList()
Withdraw all committed subsession list and commit the prepared list.
NSArray< ZoomVideoSDKSubSessionKit * > *_Nullable getCommittedSubSessionList()
Get the commited subsession list.
NSArray< NSString * > *_Nullable getSubSessionPreList()
Get the subsession name prepared list.
ZoomVideoSDKError clearSubSessionPreList()
Clear the prepared list.
NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable getSubSessionUserList()
Get the user list in this subsessions.
ZoomVideoSDKError joinSubSession()
Join this subsessions.
NSString *_Nullable getSubSessionName()
Get the subsession's nam.
NSString *_Nullable getSubSessionID()
Get the subsessions's ID.
BOOL isSubSessionStarted()
Determine if the subsession is started .
ZoomVideoSDKError startSubSession()
Start subsession.
ZoomVideoSDKError stopSubSession()
Stop subsession.
SubSession attendee helper interface.
ZoomVideoSDKError returnToMainSession()
Return to main session.
ZoomVideoSDKError requestForHelp()
Request for help.
NSString *_Nullable getRequestSubSessionName()
Get the name of the subsession where the user sent this request.
ZoomVideoSDKError ignore()
Ignore this request.
NSString *_Nullable getRequestUserName()
Get the username of the user who sent this request.
ZoomVideoSDKError joinSubSessionByUserRequest()
Join the subsession which request help is from.
NSString * getUserGUID()
Get the subsession user's GUID.
NSString * getUserName()
Get the subsession user's username.