ZMVideoSDKBroadcastStreamingViewer Class Reference

Broadcast streaming viewer interface. More...

#include <ZMVideoSDKBroadcastStreamingViewer.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- joinStreaming:
	Joins broadcast streaming asynchronously. Result is notified via onStreamingJoinStatusChanged .
(ZMVideoSDKErrors)	- leaveStreaming
	Leaves broadcast streaming asynchronously. Result is notified through via onStreamingJoinStatusChanged .
(ZMVideoSDKStreamingJoinStatus)	- getStreamingJoinStatus
	The join status.
(ZMVideoSDKErrors)	- subscribeVideo:broadcastStreamingVideoCallback:
	Subscribes to streaming video.
(ZMVideoSDKErrors)	- unSubscribeVideo:
	Unsubscribes from streaming video raw data.
(ZMVideoSDKErrors)	- subscribeAudio:
	Subscribes to streaming audio.
(ZMVideoSDKErrors)	- unSubscribeAudio
	Unsubscribes from streaming audio raw data.
(void)	- addListener:
	Adds a listener for broadcast streaming viewer interactive callbacks.
(void)	- removeListener:
	Removes a listener for broadcast streaming viewer interactive callbacks.
(ZMVideoSDKErrors)	- sendChatToAll:
	Sends a chat message to all participants in the broadcast stream.
(ZMVideoSDKErrors)	- 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.
(ZMVideoSDKErrors)	- subscribeTranslationLanguage:
	Subscribes to a translation language for live transcription.
(ZMVideoSDKErrors)	- unsubscribeTranslationLanguage
	Unsubscribes from the currently subscribed translation language for live transcription.

Detailed Description

Broadcast streaming viewer interface.

Definition at line 98 of file ZMVideoSDKBroadcastStreamingViewer.h.

Method Documentation

addListener:

- (void) addListener:

(id< ZMVideoSDKBroadcastStreamingViewerDelegate >)

listener

Adds a listener for broadcast streaming viewer interactive callbacks.

Parameters

listener

The viewer delegate object.

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

- (ZMVideoSDKStreamingJoinStatus) getStreamingJoinStatus

The join status.

Returns

Join status.

References getStreamingJoinStatus.

Referenced by getStreamingJoinStatus.

joinStreaming:

- (ZMVideoSDKErrors) joinStreaming:

(ZMVideoSDKSteamingJoinContext *)

joinContext

Joins broadcast streaming asynchronously. Result is notified via onStreamingJoinStatusChanged .

Parameters

joinContext

The join context containing token and channel ID.

Returns

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

leaveStreaming

- (ZMVideoSDKErrors) leaveStreaming

Leaves broadcast streaming asynchronously. Result is notified through via onStreamingJoinStatusChanged .

Returns

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

References leaveStreaming.

Referenced by leaveStreaming.

removeListener:

- (void) removeListener:

(id< ZMVideoSDKBroadcastStreamingViewerDelegate >)

listener

Removes a listener for broadcast streaming viewer interactive callbacks.

Parameters

listener

The viewer delegate object.

sendChatToAll:

- (ZMVideoSDKErrors) sendChatToAll:

(NSString *)

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 ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

sendEmojiReaction:

- (ZMVideoSDKErrors) sendEmojiReaction:

(ZMVideoSDKEmojiReactionType)

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 ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

subscribeAudio:

- (ZMVideoSDKErrors) subscribeAudio:

(id< ZMVideoSDKBroadcastStreamingAudioDelegate >)

delegate

Subscribes to streaming audio.

Parameters

delegate

The raw audio data callback object.

Returns

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

subscribeTranslationLanguage:

- (ZMVideoSDKErrors) subscribeTranslationLanguage:

(ZMVideoSDKBroadcastStreamingTranslationLanguage)

language

Subscribes to a translation language for live transcription.

Parameters

language

The translation language to subscribe to.

Returns

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

subscribeVideo:broadcastStreamingVideoCallback:

- (ZMVideoSDKErrors) subscribeVideo:		(ZMVideoSDKResolution)	resolution
broadcastStreamingVideoCallback:		(id< ZMVideoSDKBroadcastStreamingVideoDelegate >)	delegate

Subscribes to streaming video.

Parameters

resolution	The desired video resolution. Supported: ZMVideoSDKResolution_180P, ZMVideoSDKResolution_360P, ZMVideoSDKResolution_720P, ZMVideoSDKResolution_1080P.
delegate	The raw video data callback object, see ZMVideoSDKBroadcastStreamingVideoDelegate.

Returns

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

unSubscribeAudio

- (ZMVideoSDKErrors) unSubscribeAudio

Unsubscribes from streaming audio raw data.

Returns

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

References unSubscribeAudio.

Referenced by unSubscribeAudio.

unsubscribeTranslationLanguage

- (ZMVideoSDKErrors) unsubscribeTranslationLanguage

Unsubscribes from the currently subscribed translation language for live transcription.

Returns

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

References unsubscribeTranslationLanguage.

Referenced by unsubscribeTranslationLanguage.

unSubscribeVideo:

- (ZMVideoSDKErrors) unSubscribeVideo:

(id< ZMVideoSDKBroadcastStreamingVideoDelegate >)

delegate

Unsubscribes from streaming video raw data.

Parameters

delegate

The video raw data callback object.

Returns

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