Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKBroadcastStreamingController Class Referenceabstract

Broadcast streaming controller interface. More...

#include <zoom_video_sdk_broadcast_streaming_controller_interface.h>

Public Member Functions

virtual ~IZoomVideoSDKBroadcastStreamingController ()
 
virtual bool isBroadcastStreamingSupported ()=0
 Checks if the session supports broadcast streaming.
 
virtual bool canStartBroadcast ()=0
 Checks if the user has permission to start a broadcast.
 
virtual ZoomVideoSDKErrors startBroadcast ()=0
 Start broadcast streaming asynchronously. The result is notified via the callback 'onStartBroadcastResponse'.
 
virtual ZoomVideoSDKErrors stopBroadcast (const zchar_t *channelID)=0
 Stops broadcast streaming asynchronously. The result is notified via the callback 'onStopBroadcastResponse'.
 
virtual ZoomVideoSDKErrors getBroadcastStatus (const zchar_t *channelID)=0
 Gets broadcast status asynchronously. The result is notified via the callback 'onGetBroadcastControlStatus'.
 

Detailed Description

Broadcast streaming controller interface.

Definition at line 38 of file zoom_video_sdk_broadcast_streaming_controller_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKBroadcastStreamingController()

virtual IZoomVideoSDKBroadcastStreamingController::~IZoomVideoSDKBroadcastStreamingController ( )
inlinevirtual

Member Function Documentation

◆ canStartBroadcast()

virtual bool IZoomVideoSDKBroadcastStreamingController::canStartBroadcast ( )
pure virtual

Checks if the user has permission to start a broadcast.

Returns
true if allowed; false if not

◆ getBroadcastStatus()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingController::getBroadcastStatus ( const zchar_t * channelID)
pure virtual

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

Parameters
channelIDThe broadcast streaming channel ID.
Returns
ZoomVideoSDKErrors#ZoomVideoSDKErrors_Success if the function succeeds. otherwise, the method is failed.

◆ isBroadcastStreamingSupported()

virtual bool IZoomVideoSDKBroadcastStreamingController::isBroadcastStreamingSupported ( )
pure virtual

Checks if the session supports broadcast streaming.

Returns
true if supported; false if not

◆ startBroadcast()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingController::startBroadcast ( )
pure virtual

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

Returns
ZoomVideoSDKErrors#ZoomVideoSDKErrors_Success if the function succeeds; otherwise, the method failed.

◆ stopBroadcast()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingController::stopBroadcast ( const zchar_t * channelID)
pure virtual

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

Parameters
channelIDThe broadcast streaming channel ID.
Returns
ZoomVideoSDKErrors#ZoomVideoSDKErrors_Success if the function succeeds; otherwise, the method is failed.