IZoomVideoSDKBroadcastStreamingViewer Class Reference

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.
virtual void	addListener (IZoomVideoSDKBroadcastStreamingViewerDelegate *pListener)=0
	Adds a listener for broadcast streaming viewer interactive callbacks.
virtual void	removeListener (IZoomVideoSDKBroadcastStreamingViewerDelegate *pListener)=0
	Removes a listener for broadcast streaming viewer interactive callbacks.
virtual ZoomVideoSDKErrors	sendChatToAll (const zchar_t *content)=0
	Sends a chat message to all participants in the broadcast stream.
virtual ZoomVideoSDKErrors	sendEmojiReaction (ZoomVideoSDKEmojiReactionType type)=0
	Sends an emoji reaction to all participants in the broadcast stream.
virtual bool	canSubscribeTranslationLanguage ()=0
	Determines whether the viewer can subscribe to a translation language for live transcription.
virtual ZoomVideoSDKErrors	subscribeTranslationLanguage (ZoomVideoSDKBroadcastStreamingTranslationLanguage language)=0
	Subscribes to a translation language for live transcription.
virtual ZoomVideoSDKErrors	unsubscribeTranslationLanguage ()=0
	Unsubscribes from the currently subscribed translation language for live transcription.

Detailed Description

Broadcast streaming viewer interface for viewing broadcast streams.

Definition at line 131 of file zoom_video_sdk_broadcast_streaming_viewer_interface.h.

Constructor & Destructor Documentation

~IZoomVideoSDKBroadcastStreamingViewer()

virtual IZoomVideoSDKBroadcastStreamingViewer::~IZoomVideoSDKBroadcastStreamingViewer ( )

inlinevirtual

Definition at line 134 of file zoom_video_sdk_broadcast_streaming_viewer_interface.h.

{}

Member Function Documentation

addListener()

virtual void IZoomVideoSDKBroadcastStreamingViewer::addListener ( IZoomVideoSDKBroadcastStreamingViewerDelegate * pListener )

pure virtual

Adds a listener for broadcast streaming viewer interactive callbacks.

Parameters

pListener

The viewer delegate object. See IZoomVideoSDKBroadcastStreamingViewerDelegate.

canSubscribeTranslationLanguage()

virtual bool IZoomVideoSDKBroadcastStreamingViewer::canSubscribeTranslationLanguage ( )

pure virtual

Determines whether the viewer can subscribe to a translation language for live transcription.

Returns

true if the viewer can subscribe to a translation language. Otherwise, false.

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

joinContext

The 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.

removeListener()

virtual void IZoomVideoSDKBroadcastStreamingViewer::removeListener ( IZoomVideoSDKBroadcastStreamingViewerDelegate * pListener )

pure virtual

Removes a listener for broadcast streaming viewer interactive callbacks.

Parameters

pListener

The viewer delegate object. See IZoomVideoSDKBroadcastStreamingViewerDelegate.

sendChatToAll()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::sendChatToAll ( const zchar_t * content )

pure virtual

Sends a chat message to all participants in the broadcast stream.

Parameters

content

The chat message content to send.

Returns

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

sendEmojiReaction()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::sendEmojiReaction ( ZoomVideoSDKEmojiReactionType type )

pure virtual

Sends an emoji reaction to all participants in the broadcast stream.

Parameters

type	The emoji reaction type to send. See ZoomVideoSDKEmojiReactionType.

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

pCallback

The raw audio data callback object. See IZoomVideoSDKBroadcastStreamingAudioCallback.

Returns

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

subscribeTranslationLanguage()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::subscribeTranslationLanguage ( ZoomVideoSDKBroadcastStreamingTranslationLanguage language )

pure virtual

Subscribes to a translation language for live transcription.

Parameters

language

The translation language to subscribe to. See ZoomVideoSDKBroadcastStreamingTranslationLanguage.

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

resolution	The desired video resolution. Supported: ZoomVideoSDKResolution_180P, ZoomVideoSDKResolution_360P, ZoomVideoSDKResolution_720P, ZoomVideoSDKResolution_1080P. See ZoomVideoSDKResolution.
pCallback	the 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.

unsubscribeTranslationLanguage()

virtual ZoomVideoSDKErrors IZoomVideoSDKBroadcastStreamingViewer::unsubscribeTranslationLanguage ( )

pure virtual

Unsubscribes from the currently subscribed translation language for live transcription.

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

pCallback

The video raw data callback object, see IZoomVideoSDKBroadcastStreamingVideoCallback.

Returns

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