Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKBroadcastStreamingController Class Reference

Interface for Broadcast streaming. More...

#include <ZMVideoSDKBroadcastStreamingController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isBroadcastStreamingSupported
 Checks if the session supports broadcast streaming.
 
(BOOL) - canStartBroadcast
 Checks if the user has permission to start a broadcast.
 
(ZMVideoSDKErrors- startBroadcast
 Start broadcast streaming asynchronously. The result is notified via the callback onStartBroadcastResponse .
 
(ZMVideoSDKErrors- stopBroadcast:
 Stops broadcast streaming asynchronously. The result is notified via the callback onStopBroadcastResponse .
 
(ZMVideoSDKErrors- getBroadcastStatus:
 Gets the broadcast status asynchronously. The result is notified via the callback onGetBroadcastControlStatus .
 

Detailed Description

Interface for Broadcast streaming.

Definition at line 15 of file ZMVideoSDKBroadcastStreamingController.h.

Method Documentation

◆ canStartBroadcast

- (BOOL) canStartBroadcast

Checks if the user has permission to start a broadcast.

Returns
YES if supported; NO if not.

◆ getBroadcastStatus:

- (ZMVideoSDKErrors) getBroadcastStatus: (NSString *) channelID

Gets the broadcast status asynchronously. The result is notified via the callback onGetBroadcastControlStatus .

Parameters
channelIDThe broadcast streaming channel ID.
Returns
If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise failed.

◆ isBroadcastStreamingSupported

- (BOOL) isBroadcastStreamingSupported

Checks if the session supports broadcast streaming.

Returns
YES if supported; NO if not.

◆ startBroadcast

- (ZMVideoSDKErrors) startBroadcast

Start broadcast streaming asynchronously. The result is notified via the callback onStartBroadcastResponse .

Returns
If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise failed.

◆ stopBroadcast:

- (ZMVideoSDKErrors) stopBroadcast: (NSString *) channelID

Stops broadcast streaming asynchronously. The result is notified via the callback onStopBroadcastResponse .

Parameters
channelIDThe broadcast streaming channel ID.
Returns
If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise failed.