Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKBroadcastStreamingHelper Class Reference

#include <ZoomVideoSDKBroadcastStreamingHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - isBroadcastStreamingSupported
 Check if the session supports broadcast streaming.
 
(BOOL) - canStartBroadcast
 Check if the user has permission to start broadcast.
 
(ZoomVideoSDKError- startBroadcast
 Start broadcast streaming asynchronously.The result is notified via the callback '-[ZoomVideoSDKDelegate onStartBroadcastResponse:channelID:]'.
 
(ZoomVideoSDKError- stopBroadcast:
 Stops broadcast streaming asynchronously. The result is notified via the callback ''-[ZoomVideoSDKDelegate onStopBroadcastResponse:]'.
 
(ZoomVideoSDKError- getBroadcastStatus:
 Get broadcast status asynchronously.The result is notified via the callback -[ZoomVideoSDKDelegate onGetBroadcastControlStatus:status:]'.
 

Detailed Description

Definition at line 14 of file ZoomVideoSDKBroadcastStreamingHelper.h.

Method Documentation

◆ canStartBroadcast

- (BOOL) canStartBroadcast

Check if the user has permission to start broadcast.

Returns
YES if allow; NO if not

◆ getBroadcastStatus:

- (ZoomVideoSDKError) getBroadcastStatus: (NSString *_Nonnull) channelID

Get broadcast status asynchronously.The result is notified via the callback -[ZoomVideoSDKDelegate onGetBroadcastControlStatus:status:]'.

Parameters
channelIDbroadcast streaming channel ID.
Returns
Errors_Success If the function succeeds, otherwise fthe method failed

◆ isBroadcastStreamingSupported

- (BOOL) isBroadcastStreamingSupported

Check if the session supports broadcast streaming.

Returns
true if supported; false if not

◆ startBroadcast

- (ZoomVideoSDKError) startBroadcast

Start broadcast streaming asynchronously.The result is notified via the callback '-[ZoomVideoSDKDelegate onStartBroadcastResponse:channelID:]'.

Returns
Errors_Success If the function succeeds, otherwise the method failed..

◆ stopBroadcast:

- (ZoomVideoSDKError) stopBroadcast: (NSString *_Nonnull) channelID

Stops broadcast streaming asynchronously. The result is notified via the callback ''-[ZoomVideoSDKDelegate onStopBroadcastResponse:]'.

Parameters
channelIDbroadcast streaming channel id.
Returns
If the function succeeds, the return value is Errors_Success. Otherwise failed. For detailed error codes, see ZoomVideoSDKError enum.