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

Broadcast streaming viewer interface for viewing broadcast streams. More...

#include <zoom_video_sdk_broadcast_streaming_viewer_interface.h>

Public Member Functions

virtual ~IZoomVideoSDKBroadcastStreamingViewer ()
 
virtual ZoomVideoSDKErrors joinStreaming (ZoomVideoSDKSteamingJoinContext &joinContext)=0
 Joins broadcast streaming asynchronously. Result is notified via the callback 'onStreamingJoinStatusChanged'.
 
virtual ZoomVideoSDKErrors leaveStreaming ()=0
 Leaves broadcast streaming asynchronously. Result is notified via the callback 'onStreamingJoinStatusChanged'.
 
virtual ZoomVideoSDKStreamingJoinStatus getStreamingJoinStatus ()=0
 Gets the current streaming join status.
 
virtual ZoomVideoSDKErrors subscribeVideo (ZoomVideoSDKResolution resolution, IZoomVideoSDKBroadcastStreamingVideoCallback *pCallback)=0
 Subscribes to streaming video.
 
virtual ZoomVideoSDKErrors unSubscribeVideo (IZoomVideoSDKBroadcastStreamingVideoCallback *pCallback)=0
 Unsubscribe from streaming video raw data.
 
virtual ZoomVideoSDKErrors subscribeAudio (IZoomVideoSDKBroadcastStreamingAudioCallback *pCallback)=0
 Subscribes to streaming audio.
 
virtual ZoomVideoSDKErrors unSubscribeAudio ()=0
 Unsubscribe from streaming audio raw data.
 

Detailed Description

Broadcast streaming viewer interface for viewing broadcast streams.

Definition at line 91 of file zoom_video_sdk_broadcast_streaming_viewer_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKBroadcastStreamingViewer()

virtual IZoomVideoSDKBroadcastStreamingViewer::~IZoomVideoSDKBroadcastStreamingViewer ( )
inlinevirtual

Member Function Documentation

◆ getStreamingJoinStatus()

virtual ZoomVideoSDKStreamingJoinStatus IZoomVideoSDKBroadcastStreamingViewer::getStreamingJoinStatus ( )
pure virtual

Gets the current streaming join status.

Returns
The join status. See ZoomVideoSDKStreamingJoinStatus.

◆ joinStreaming()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::joinStreaming ( ZoomVideoSDKSteamingJoinContext & joinContext)
pure virtual

Joins broadcast streaming asynchronously. Result is notified via the callback 'onStreamingJoinStatusChanged'.

Parameters
joinContextThe join context containing token and channel ID.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ leaveStreaming()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::leaveStreaming ( )
pure virtual

Leaves broadcast streaming asynchronously. Result is notified via the callback 'onStreamingJoinStatusChanged'.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ subscribeAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::subscribeAudio ( IZoomVideoSDKBroadcastStreamingAudioCallback * pCallback)
pure virtual

Subscribes to streaming audio.

Parameters
pCallbackThe raw audio data callback object. See IZoomVideoSDKBroadcastStreamingAudioCallback.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ subscribeVideo()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::subscribeVideo ( ZoomVideoSDKResolution resolution,
IZoomVideoSDKBroadcastStreamingVideoCallback * pCallback )
pure virtual

Subscribes to streaming video.

Parameters
resolutionThe desired video resolution. Supported: ZoomVideoSDKResolution_180P, ZoomVideoSDKResolution_360P, ZoomVideoSDKResolution_720P, ZoomVideoSDKResolution_1080P. See ZoomVideoSDKResolution.
pCallbackthe raw video data callback object, see IZoomVideoSDKBroadcastStreamingVideoCallback.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ unSubscribeAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::unSubscribeAudio ( )
pure virtual

Unsubscribe from streaming audio raw data.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ unSubscribeVideo()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::unSubscribeVideo ( IZoomVideoSDKBroadcastStreamingVideoCallback * pCallback)
pure virtual

Unsubscribe from streaming video raw data.

Parameters
pCallbackThe video raw data callback object, see IZoomVideoSDKBroadcastStreamingVideoCallback.
Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.