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

#include <ZoomVideoSDKBroadcastStreamingHelper.h>

Inherits NSObject.

Instance Methods

(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 '-[ZoomVideoSDKDelegate onStartBroadcastResponse:channelID:]'.
 
(ZoomVideoSDKError- stopBroadcast:
 Stops broadcast streaming asynchronously. The result is notified via the callback '-[ZoomVideoSDKDelegate onStopBroadcastResponse:]'.
 
(ZoomVideoSDKError- getBroadcastStatus:
 Gets 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

Determines whether the user has permission to start broadcast.

Returns
YES if allowed. Otherwise, NO.

◆ getBroadcastStatus:

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

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

Parameters
channelIDThe broadcast streaming channel ID.
Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

◆ isBroadcastStreamingSupported

- (BOOL) isBroadcastStreamingSupported

Determines whether the session supports broadcast streaming.

Returns
YES if supported. Otherwise, NO.

◆ startBroadcast

- (ZoomVideoSDKError) startBroadcast

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

Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

◆ stopBroadcast:

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

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

Parameters
channelIDThe broadcast streaming channel ID.
Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.