Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKBroadcastStreamingHelper.h
Go to the documentation of this file.
1//
2// ZoomVideoSDKBroadcastStreamingHelper.h
3// ZoomVideoSDK
4//
5// Created by ZOOM on 2025/7/28.
6// Copyright © 2025 Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10
11NS_ASSUME_NONNULL_BEGIN
12
13
15
21
27
33
39- (ZoomVideoSDKError)stopBroadcast:(NSString * _Nonnull)channelID;
40
46- (ZoomVideoSDKError)getBroadcastStatus:(NSString * _Nonnull)channelID;
47
48@end
49
58@property (nonatomic,copy) NSString * token;
62@property (nonatomic,copy) NSString * channelID;
66@property (nonatomic,copy) NSString * _Nullable userName;
67@end
68
73@protocol ZoomVideoSDKBroadcastStreamingViewerDelegate <NSObject>
74@optional
81- (void)onStreamingChatMessageReceived:(NSString * _Nonnull)senderName content:(NSString * _Nonnull)content isSelfSend:(BOOL)isSelfSend;
82
87- (void)onStreamingEmojiReactionReceived:(ZoomVideoSDKEmojiReactionType)type;
88
93- (void)onStreamingLiveTranscriptionMsgReceived:(NSString * _Nonnull)content;
94@end
95
96
97
108- (ZoomVideoSDKError)joinStreaming:(ZoomVideoSDKStreamingJoinContext* _Nullable)joinContext;
109
115
121
128- (ZoomVideoSDKError)subscribeVideoWithDelegate:(id<ZoomVideoSDKBroadcastStreamingVideoDelegate> _Nullable)delegate resolution:(ZoomVideoSDKVideoResolution)resolution;
129
135
141- (ZoomVideoSDKError)subscribeAudioWithDelegate:(id<ZoomVideoSDKBroadcastStreamingAudioDelegate> _Nullable)delegate;
142
148
153- (void)subscribeViewerWithDelegate:(id<ZoomVideoSDKBroadcastStreamingViewerDelegate> _Nullable)delegate;
154
160- (ZoomVideoSDKError)sendChatToAll:(NSString * _Nonnull)content;
161
168
174
181
187
188@end
189
190
191
192
193NS_ASSUME_NONNULL_END
ZoomVideoSDKEmojiReactionType
Enumeration of emoji reaction types.
ZoomVideoSDKVideoResolution
Enumeration of the render resolution.
ZoomVideoSDKBroadcastStreamingTranslationLanguage
Enumeration of supported translation languages for broadcast streaming live transcription.
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
ZoomVideoSDKStreamingJoinStatus
Enumeration of the streaming join status.
BOOL isBroadcastStreamingSupported()
Determines whether the session supports broadcast streaming.
BOOL canStartBroadcast()
Determines whether the user has permission to start broadcast.
ZoomVideoSDKError startBroadcast()
Starts broadcast streaming asynchronously. The result is notified via the callback '-[ZoomVideoSDKDel...
BOOL canSubscribeTranslationLanguage()
Determines whether the viewer can subscribe to a translation language for live transcription.
ZoomVideoSDKError unSubscribeVideo()
Unsubscribes from streaming video raw data.
ZoomVideoSDKError unSubscribeAudio()
Unsubscribes from streaming audio raw data.
ZoomVideoSDKError unsubscribeTranslationLanguage()
Unsubscribes from the currently subscribed translation language for live transcription.
ZoomVideoSDKStreamingJoinStatus getStreamingJoinStatus()
Gets the current streaming join status.
ZoomVideoSDKError leaveStreaming()
Leaves broadcast streaming asynchronously. Result is notified via the callback '-[ZoomVideoSDKDelegat...
NSString *_Nullable userName
Gets the viewer's display name for use when sending chat messages.