Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKLiveStreamHelper.h
Go to the documentation of this file.
1
2
3#import <ZoomSDK/ZoomSDKErrors.h>
4
5NS_ASSUME_NONNULL_BEGIN
9@interface ZoomSDKLiveStreamItem : NSObject
14- (NSString*)getLiveStreamURL;
15
20- (NSString*)getLiveStreamViewerURL;
21
27@end
28
32@interface ZoomSDKRawLiveStreamInfo : NSObject
36@property(nonatomic, assign, readonly) unsigned int userID;
40@property(nonatomic, copy, readonly) NSString *broadcastUrl;
44@property(nonatomic, copy, readonly) NSString *broadcastName;
45@end
46
47
55@property(nonatomic, copy, readonly, nullable) NSString *requestId;
59@property(nonatomic, assign, readonly) unsigned int requesterId;
63@property(nonatomic, copy, readonly, nullable) NSString *requesterName;
67@property(nonatomic, copy, readonly, nullable) NSString *broadcastUrl;
71@property(nonatomic, copy, readonly, nullable) NSString *broadcastName;
72
77- (ZoomSDKError)grantRawLiveStreamPrivilege;
78
83- (ZoomSDKError)denyRawLiveStreamPrivilege;
84@end
85
86
87@protocol ZoomSDKLiveStreamHelperDelegate <NSObject>
92- (void)onLiveStreamStatusChange:(LiveStreamStatus)status;
93
98- (void)onRawLiveStreamPrivilegeChanged:(BOOL)bHasPrivilege;
99
103- (void)onRawLiveStreamPrivilegeRequestTimeout;
104
110- (void)onUserRawLiveStreamPrivilegeChanged:(unsigned int)userID hasPrivilege:(BOOL)bHasPrivilege;
111
116- (void)onRawLiveStreamPrivilegeRequested:(ZoomSDKRequestRawLiveStreamPrivilegeHandler*_Nullable)handler;
117
122- (void)onUserRawLiveStreamingStatusChanged:(NSArray<ZoomSDKRawLiveStreamInfo*>*_Nullable)liveStreamList;
123
128- (void)onLiveStreamReminderStatusChanged:(BOOL)enable;
129
133- (void)onLiveStreamReminderStatusChangeFailed;
134
140- (void)onUserThresholdReachedForLiveStream:(int)percent;
141@end
142
143
144
145@interface ZoomSDKLiveStreamHelper : NSObject
146{
147 id<ZoomSDKLiveStreamHelperDelegate> _delegate;
148}
149@property(nonatomic, assign, nullable)id<ZoomSDKLiveStreamHelperDelegate> delegate;
155- (ZoomSDKError)canStartLiveStream;
156
162- (NSArray*)getSupportLiveStreamItem DEPRECATED_MSG_ATTRIBUTE("Use -getSupportLiveStreamItems instead");
163
168- (NSArray<ZoomSDKLiveStreamItem*>*_Nullable)getSupportLiveStreamItems;
169
174- (ZoomSDKLiveStreamItem*_Nullable)getCurrentLiveStreamItem;
175
181- (ZoomSDKError)startLiveStream:(ZoomSDKLiveStreamItem*)item;
182
190- (ZoomSDKError)startLiveStreamByURL:(NSString*)streamURL StreamKey:(NSString*)key BroadcastURL:(NSString*)broadcastURL;
191
196- (ZoomSDKError)stopLiveStream;
197
202- (LiveStreamStatus)getLiveStreamStatus;
203
208- (BOOL)isRawLiveStreamSupported;
209
214- (ZoomSDKError)canStartRawLiveStream;
215
222- (ZoomSDKError)requestRawLiveStreaming:(NSString*)broadcastURL broadcastName:(NSString*)broadcastName;
223
230- (ZoomSDKError)startRawLiveStreaming:(NSString *)broadcastURL broadcastName:(NSString*)broadcastName;
231
236- (ZoomSDKError)stopRawLiveStream;
237
243- (ZoomSDKError)removeRawLiveStreamPrivilege:(unsigned int)userID;
244
249- (NSArray<ZoomSDKRawLiveStreamInfo*>*_Nullable)getRawLiveStreamingInfoList;
250
255- (NSArray<NSNumber*>*_Nullable)getRawLiveStreamPrivilegeUserList;
261- (BOOL)isLiveStreamReminderEnabled;
262
267- (BOOL)canEnableLiveStreamReminder;
268
274- (ZoomSDKError)enableLiveStreamReminder:(BOOL)enable;
275@end
276NS_ASSUME_NONNULL_END
LiveStreamStatus
Enumeration of live stream status.
ZoomSDKError
Enumeration of common errors of SDK.
id< ZoomSDKLiveStreamHelperDelegate > _delegate
ZOOM SDK live stream item.
NSString * getLiveStreamURL()
Get live stream URL.
NSString * getLiveStreamURLDescription()
Get description of live stream URL.
NSString * getLiveStreamViewerURL()
Get the viewer URL of the live stream meeting.
Information of raw live stream info.
unsigned int userID
Get the user ID.
NSString * broadcastName
Get the broadcast name.
NSString * broadcastUrl
Get the broadcast URL.
Process after the host receives the requirement from the user to give the raw live stream privilege.