ZoomVideoSDKBroadcastStreamingViewerHelper Class Reference

Broadcast streaming viewer helper interface. More...

#include <ZoomVideoSDKBroadcastStreamingHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- joinStreaming:
	Joins broadcast streaming asynchronously. Result is notified via the callback '-[ZoomVideoSDKDelegate onStreamingJoinStatusChanged:]'.
(ZoomVideoSDKError)	- leaveStreaming
	Leaves broadcast streaming asynchronously. Result is notified via the callback '-[ZoomVideoSDKDelegate onStreamingJoinStatusChanged:]'.
(ZoomVideoSDKStreamingJoinStatus)	- getStreamingJoinStatus
	Gets the current streaming join status.
(ZoomVideoSDKError)	- subscribeVideoWithDelegate:resolution:
	Subscribes to streaming video.
(ZoomVideoSDKError)	- unSubscribeVideo
	Unsubscribes from streaming video raw data.
(ZoomVideoSDKError)	- subscribeAudioWithDelegate:
	Subscribes to streaming audio.
(ZoomVideoSDKError)	- unSubscribeAudio
	Unsubscribes from streaming audio raw data.
(void)	- subscribeViewerWithDelegate:
	Subscribes broadcast streaming viewer interactive callbacks.
(ZoomVideoSDKError)	- sendChatToAll:
	Sends a chat message to all participants in the broadcast stream.
(ZoomVideoSDKError)	- sendEmojiReaction:
	Sends an emoji reaction to all participants in the broadcast stream.
(BOOL)	- canSubscribeTranslationLanguage
	Determines whether the viewer can subscribe to a translation language for live transcription.
(ZoomVideoSDKError)	- subscribeTranslationLanguage:
	Subscribes to a translation language for live transcription.
(ZoomVideoSDKError)	- unsubscribeTranslationLanguage
	Unsubscribes from the currently subscribed translation language for live transcription.

Detailed Description

Broadcast streaming viewer helper interface.

Definition at line 102 of file ZoomVideoSDKBroadcastStreamingHelper.h.

Method Documentation

canSubscribeTranslationLanguage

- (BOOL) canSubscribeTranslationLanguage

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

Returns

YES if the viewer can subscribe to a translation language. Otherwise, NO.

References canSubscribeTranslationLanguage.

Referenced by canSubscribeTranslationLanguage.

getStreamingJoinStatus

- (ZoomVideoSDKStreamingJoinStatus) getStreamingJoinStatus

Gets the current streaming join status.

Returns

The join status.

References getStreamingJoinStatus.

Referenced by getStreamingJoinStatus.

joinStreaming:

- (ZoomVideoSDKError) joinStreaming:

(ZoomVideoSDKStreamingJoinContext *_Nullable)

joinContext

Joins broadcast streaming asynchronously. Result is notified via the callback '-[ZoomVideoSDKDelegate onStreamingJoinStatusChanged:]'.

Parameters

joinContext

The join context.

Returns

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

leaveStreaming

- (ZoomVideoSDKError) leaveStreaming

Leaves broadcast streaming asynchronously. Result is notified via the callback '-[ZoomVideoSDKDelegate onStreamingJoinStatusChanged:]'.

Returns

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

References leaveStreaming.

Referenced by leaveStreaming.

sendChatToAll:

- (ZoomVideoSDKError) sendChatToAll:

(NSString *_Nonnull)

content

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

Parameters

content

The chat message content to send.

Returns

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

sendEmojiReaction:

- (ZoomVideoSDKError) sendEmojiReaction:

(ZoomVideoSDKEmojiReactionType)

type

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

Parameters

type	The emoji reaction type to send.

Returns

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

subscribeAudioWithDelegate:

- (ZoomVideoSDKError) subscribeAudioWithDelegate:

(id< ZoomVideoSDKBroadcastStreamingAudioDelegate > _Nullable)

delegate

Subscribes to streaming audio.

Parameters

delegate

The raw audio data callback object.

Returns

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

subscribeTranslationLanguage:

- (ZoomVideoSDKError) subscribeTranslationLanguage:

(ZoomVideoSDKBroadcastStreamingTranslationLanguage)

language

Subscribes to a translation language for live transcription.

Parameters

language

The translation language to subscribe to.

Returns

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

subscribeVideoWithDelegate:resolution:

- (ZoomVideoSDKError) subscribeVideoWithDelegate:		(id< ZoomVideoSDKBroadcastStreamingVideoDelegate > _Nullable)	delegate
resolution:		(ZoomVideoSDKVideoResolution)	resolution

Subscribes to streaming video.

Parameters

resolution	The desired video resolution.
delegate	The raw video data callback object.

Returns

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

subscribeViewerWithDelegate:

- (void) subscribeViewerWithDelegate:

(id< ZoomVideoSDKBroadcastStreamingViewerDelegate > _Nullable)

delegate

Subscribes broadcast streaming viewer interactive callbacks.

Parameters

delegate

The viewer delegate callback object.If delegate is nill, Not accepting callback from Viewer Delegate

unSubscribeAudio

- (ZoomVideoSDKError) unSubscribeAudio

Unsubscribes from streaming audio raw data.

Returns

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

References unSubscribeAudio.

Referenced by unSubscribeAudio.

unsubscribeTranslationLanguage

- (ZoomVideoSDKError) unsubscribeTranslationLanguage

Unsubscribes from the currently subscribed translation language for live transcription.

Returns

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

References unsubscribeTranslationLanguage.

Referenced by unsubscribeTranslationLanguage.

unSubscribeVideo

- (ZoomVideoSDKError) unSubscribeVideo

Unsubscribes from streaming video raw data.

Returns

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

References unSubscribeVideo.

Referenced by unSubscribeVideo.