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.

Detailed Description

Broadcast streaming viewer helper interface.

Definition at line 71 of file ZoomVideoSDKBroadcastStreamingHelper.h.

Method Documentation

getStreamingJoinStatus

- (ZoomVideoSDKStreamingJoinStatus) getStreamingJoinStatus

Gets the current streaming join status.

Returns

The join status.

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.

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.

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.

unSubscribeAudio

- (ZoomVideoSDKError) unSubscribeAudio

Unsubscribes from streaming audio raw data.

Returns

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

unSubscribeVideo

- (ZoomVideoSDKError) unSubscribeVideo

Unsubscribes from streaming video raw data.

Returns

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