Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKLiveStreamHelper.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
12@interface ZoomVideoSDKLiveStreamSetting : NSObject
13
17@property(nonatomic, assign) ZoomVideoSDKLiveStreamLayout layout;
18
23
24@end
25
31@interface ZoomVideoSDKLiveStreamParams : NSObject
32
36@property(nonatomic, copy, nullable) NSString* streamUrl;
37
41@property(nonatomic, copy, nullable) NSString* key;
42
46@property(nonatomic, copy, nullable) NSString* broadcastUrl;
47
51@property(nonatomic, retain, nullable) ZoomVideoSDKLiveStreamSetting* setting;
52
53@end
54
55
60@interface ZoomVideoSDKLiveStreamHelper : NSObject
61
71- (ZoomVideoSDKError)startLiveStreamWithStreamingURL:(NSString * _Nullable)streamingURL StreamingKey:(NSString * _Nullable)key BroadcastURL:(NSString * _Nullable)broadcastURL __deprecated_msg("Use startLiveStreamWithParams: instead");
72
79- (ZoomVideoSDKError)startLiveStreamWithParams:(ZoomVideoSDKLiveStreamParams * _Nullable)param;
80
87
93
99
107- (ZoomVideoSDKError)updateLiveStreamSetting:(ZoomVideoSDKLiveStreamSetting * _Nullable)setting;
108
115
116@end
117
126@property(nonatomic, copy) NSString* _Nullable streamKeyID;
130@property(nonatomic, assign) BOOL isRTMPConnected;
134@property(nonatomic, assign) BOOL isStreamPushed;
135
136@end
137
143
150- (ZoomVideoSDKError)bindIncomingLiveStream:(NSString *_Nullable)streamKeyID;
151
158- (ZoomVideoSDKError)unbindIncomingLiveStream:(NSString *_Nullable)streamKeyID;
159
167
174- (ZoomVideoSDKError)startIncomingLiveStream:(NSString *_Nullable)streamKeyID;
175
182- (ZoomVideoSDKError)stopIncomingLiveStream:(NSString *_Nullable)streamKeyID;
183
184@end
185
ZoomVideoSDKLiveStreamCloseCaption
Enumeration of the live stream close caption options.
ZoomVideoSDKLiveStreamLayout
Enumeration of live stream layout types.
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
Incoming live stream helper interface.
ZoomVideoSDKError getIncomingLiveStreamStatus()
Gets the status of bound streams.
NSString *_Nullable streamKeyID
Gets the incoming live stream ID.
BOOL isRTMPConnected
Determines whether the streaming software (such as OBS) is connected to the Zoom platform.
BOOL isStreamPushed
Determines whether the video stream has been pushed to the session.
A class to operate the live stream.
BOOL canGetOrUpdateLiveStreamSetting()
Determines whether the current user can get or update live stream settings.
ZoomVideoSDKLiveStreamSetting *_Nullable getCurrentLiveStreamSetting()
Gets the current live stream settings for the current session.
ZoomVideoSDKError stopLiveStream()
Stops live streaming.
ZoomVideoSDKError canStartLiveStream()
Checks if you can start live streaming.
Live stream parameters for starting live stream. This class contains all the necessary parameters to ...
ZoomVideoSDKLiveStreamSetting * setting
Live stream settings configuration class for Zoom Video SDK. This class contains layout and close cap...
ZoomVideoSDKLiveStreamCloseCaption closeCaption