Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKLiveStreamHelper.h
Go to the documentation of this file.
1
5
6
7#import <ZoomSDK/ZoomSDKErrors.h>
8
9NS_ASSUME_NONNULL_BEGIN
14@interface ZoomSDKLiveStreamItem : NSObject
19- (NSString*)getLiveStreamURL;
20
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
85
91@end
92
97@protocol ZoomSDKLiveStreamHelperDelegate <NSObject>
102- (void)onLiveStreamStatusChange:(LiveStreamStatus)status;
103
108- (void)onRawLiveStreamPrivilegeChanged:(BOOL)bHasPrivilege;
109
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
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;
170
172
178- (NSArray*)getSupportLiveStreamItem DEPRECATED_MSG_ATTRIBUTE("Use -getSupportLiveStreamItems instead");
179
185
191
197- (ZoomSDKError)startLiveStream:(ZoomSDKLiveStreamItem*)item;
198
206- (ZoomSDKError)startLiveStreamByURL:(NSString*)streamURL StreamKey:(NSString*)key BroadcastURL:(NSString*)broadcastURL;
207
213
219
225
231
238- (ZoomSDKError)requestRawLiveStreaming:(NSString*)broadcastURL broadcastName:(NSString*)broadcastName;
239
246- (ZoomSDKError)startRawLiveStreaming:(NSString *)broadcastURL broadcastName:(NSString*)broadcastName;
247
253
259- (ZoomSDKError)removeRawLiveStreamPrivilege:(unsigned int)userID;
260
266
271- (NSArray<NSNumber*>*_Nullable)getRawLiveStreamPrivilegeUserList;
278
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.
ZoomSDKError canStartLiveStream()
Query if it is able for the user to enable live stream.
NSArray< NSNumber * > *_Nullable getRawLiveStreamPrivilegeUserList()
Gets the list of users’ IDs who have raw live stream privileges.
ZoomSDKError stopLiveStream()
Stops a live stream.
ZoomSDKError canStartRawLiveStream()
Whether if the current user is able to start raw live streaming.
ZoomSDKError stopRawLiveStream()
Stops raw live streaming.
BOOL canEnableLiveStreamReminder()
Checks if the current user can enable or disable the live stream reminder.
ZoomSDKLiveStreamItem *_Nullable getCurrentLiveStreamItem()
Gets the current live stream object.
NSArray< ZoomSDKRawLiveStreamInfo * > *_Nullable getRawLiveStreamingInfoList()
Gets a list of current active raw live streams.
BOOL isLiveStreamReminderEnabled()
Checks if the live stream reminder is enabled. When the live stream reminder is enabled,...
NSArray * getSupportLiveStreamItem()
Gets the items of live stream supported by the SDK.
LiveStreamStatus getLiveStreamStatus()
Gets the status of current live stream.
id< ZoomSDKLiveStreamHelperDelegate > _delegate
BOOL isRawLiveStreamSupported()
Query Whether the meeting supports raw live streams.
id< ZoomSDKLiveStreamHelperDelegate > delegate
Sets or get the delegate to receive live stream event callbacks.
NSArray< ZoomSDKLiveStreamItem * > *_Nullable getSupportLiveStreamItems()
Gets the list of live stream information items in the current meeting.
Represents a standard live stream target with URL and description.
NSString * getLiveStreamURL()
Gets live stream URL.
NSString * getLiveStreamURLDescription()
Gets description of live stream URL.
NSString * getLiveStreamViewerURL()
Gets the live's viewer URL stream meeting.
Information of an active raw live stream.
unsigned int userID
Gets the user ID.
NSString * broadcastName
Gets the broadcast name.
NSString * broadcastUrl
Gets the broadcast URL.
Process after the host receives the requirement from the user to give the raw live stream privilege.
ZoomSDKError grantRawLiveStreamPrivilege()
Allows the user to start raw live stream and finally self-destroy.
ZoomSDKError denyRawLiveStreamPrivilege()
Denies the user permission to start raw live stream and finally self-destroy.
NSString * requesterName
Gets the user name who requested privileges.
unsigned int requesterId
Gets the user ID who requested privilege.
NSString * broadcastUrl
Gets the broadcast URL.
NSString * broadcastName
Gets the broadcast name.
void onRawLiveStreamPrivilegeRequestTimeout()
Callback event when the current user's request has times out.
void onLiveStreamReminderStatusChangeFailed()
Callback event when the live stream reminder enable status change fails.