Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKLiveStreamHelper.h
Go to the documentation of this file.
1
7#import <ZoomSDK/ZoomSDKErrors.h>
8
9NS_ASSUME_NONNULL_BEGIN
14@interface ZoomSDKLiveStreamItem : NSObject
19- (NSString*)getLiveStreamURL;
20
25- (NSString*)getLiveStreamViewerURL;
26
32@end
33
38@interface ZoomSDKRawLiveStreamInfo : NSObject
42@property(nonatomic, assign, readonly) unsigned int userID;
46@property(nonatomic, copy, readonly) NSString *broadcastUrl;
50@property(nonatomic, copy, readonly) NSString *broadcastName;
51@end
52
53
62@property(nonatomic, copy, readonly, nullable) NSString *requestId;
66@property(nonatomic, assign, readonly) unsigned int requesterId;
70@property(nonatomic, copy, readonly, nullable) NSString *requesterName;
74@property(nonatomic, copy, readonly, nullable) NSString *broadcastUrl;
78@property(nonatomic, copy, readonly, nullable) NSString *broadcastName;
79
84- (ZoomSDKError)grantRawLiveStreamPrivilege;
85
90- (ZoomSDKError)denyRawLiveStreamPrivilege;
91@end
92
97@protocol ZoomSDKLiveStreamHelperDelegate <NSObject>
102- (void)onLiveStreamStatusChange:(LiveStreamStatus)status;
103
108- (void)onRawLiveStreamPrivilegeChanged:(BOOL)bHasPrivilege;
109
113- (void)onRawLiveStreamPrivilegeRequestTimeout;
114
120- (void)onUserRawLiveStreamPrivilegeChanged:(unsigned int)userID hasPrivilege:(BOOL)bHasPrivilege;
121
126- (void)onRawLiveStreamPrivilegeRequested:(ZoomSDKRequestRawLiveStreamPrivilegeHandler*_Nullable)handler;
127
132- (void)onUserRawLiveStreamingStatusChanged:(NSArray<ZoomSDKRawLiveStreamInfo*>*_Nullable)liveStreamList;
133
138- (void)onLiveStreamReminderStatusChanged:(BOOL)enable;
139
143- (void)onLiveStreamReminderStatusChangeFailed;
144
150- (void)onUserThresholdReachedForLiveStream:(int)percent;
151@end
152
153
158@interface ZoomSDKLiveStreamHelper : NSObject
159{
160 id<ZoomSDKLiveStreamHelperDelegate> _delegate;
161}
165@property(nonatomic, assign, nullable)id<ZoomSDKLiveStreamHelperDelegate> delegate;
171- (ZoomSDKError)canStartLiveStream;
172
178- (NSArray*)getSupportLiveStreamItem DEPRECATED_MSG_ATTRIBUTE("Use -getSupportLiveStreamItems instead");
179
184- (NSArray<ZoomSDKLiveStreamItem*>*_Nullable)getSupportLiveStreamItems;
185
190- (ZoomSDKLiveStreamItem*_Nullable)getCurrentLiveStreamItem;
191
197- (ZoomSDKError)startLiveStream:(ZoomSDKLiveStreamItem*)item;
198
206- (ZoomSDKError)startLiveStreamByURL:(NSString*)streamURL StreamKey:(NSString*)key BroadcastURL:(NSString*)broadcastURL;
207
212- (ZoomSDKError)stopLiveStream;
213
218- (LiveStreamStatus)getLiveStreamStatus;
219
224- (BOOL)isRawLiveStreamSupported;
225
230- (ZoomSDKError)canStartRawLiveStream;
231
238- (ZoomSDKError)requestRawLiveStreaming:(NSString*)broadcastURL broadcastName:(NSString*)broadcastName;
239
246- (ZoomSDKError)startRawLiveStreaming:(NSString *)broadcastURL broadcastName:(NSString*)broadcastName;
247
252- (ZoomSDKError)stopRawLiveStream;
253
259- (ZoomSDKError)removeRawLiveStreamPrivilege:(unsigned int)userID;
260
265- (NSArray<ZoomSDKRawLiveStreamInfo*>*_Nullable)getRawLiveStreamingInfoList;
266
271- (NSArray<NSNumber*>*_Nullable)getRawLiveStreamPrivilegeUserList;
277- (BOOL)isLiveStreamReminderEnabled;
278
283- (BOOL)canEnableLiveStreamReminder;
284
290- (ZoomSDKError)enableLiveStreamReminder:(BOOL)enable;
291@end
292NS_ASSUME_NONNULL_END
LiveStreamStatus
Enumeration of live stream status.
ZoomSDKError
Enumeration of common errors of SDK.
Interface for managing standard and raw live streams in a meeting.
id< ZoomSDKLiveStreamHelperDelegate > _delegate
Represents a standard live stream target with URL and description.
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 an active raw live stream.
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.