Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKBroadcastStreamingViewerHelper Class Reference

#include <ZoomVideoSDKBroadcastStreamingHelper.h>

Inherits NSObject.

Instance Methods

(ZoomVideoSDKError- joinStreaming:
 Join broadcast streaming asynchronously. Result is notified via the callback '-[ZoomVideoSDKDelegate onStreamingJoinStatusChanged:]'.
 
(ZoomVideoSDKError- leaveStreaming
 Leave broadcast streaming asynchronously. Result is notified via the callback [ZoomVideoSDKDelegate onStreamingJoinStatusChanged:]'.
 
(ZoomVideoSDKStreamingJoinStatus- getStreamingJoinStatus
 Get the currentstreaming join status.
 
(ZoomVideoSDKError- subscribeVideoWithDelegate:resolution:
 Subscribe to streaming video.
 
(ZoomVideoSDKError- unSubscribeVideo
 Unsubscribe from streaming video raw data.
 
(ZoomVideoSDKError- subscribeAudioWithDelegate:
 Subscribe to streaming audio.
 
(ZoomVideoSDKError- unSubscribeAudio
 Unsubscribe from streaming audio raw data.
 

Detailed Description

Definition at line 60 of file ZoomVideoSDKBroadcastStreamingHelper.h.

Method Documentation

◆ getStreamingJoinStatus

- (ZoomVideoSDKStreamingJoinStatus) getStreamingJoinStatus

Get the currentstreaming join status.

Returns
The Join status,See ZoomVideoSDKStreamingJoinStatus .

◆ joinStreaming:

- (ZoomVideoSDKError) joinStreaming: (ZoomVideoSDKStreamingJoinContext *_Nullable) joinContext

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

Parameters
joinContextjoin context.
Returns
Errors_Success If the function succeeds, otherwise failed.

◆ leaveStreaming

- (ZoomVideoSDKError) leaveStreaming

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

Returns
Errors_Success If the function succeeds, otherwise failed.

◆ subscribeAudioWithDelegate:

- (ZoomVideoSDKError) subscribeAudioWithDelegate: (id< ZoomVideoSDKBroadcastStreamingAudioDelegate > _Nullable) delegate

Subscribe to streaming audio.

Parameters
delegateThe raw audio data callback object, See ZoomVideoSDKBroadcastStreamingAudioDelegate.
Returns
Errors_Success If the function succeeds, otherwise failed.

◆ subscribeVideoWithDelegate:resolution:

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

Subscribe to streaming video.

Parameters
resolutionThe desired video resolution, Ssupported: See ZoomVideoSDKVideoResolution.
delegatethe raw video data callback object, See ZoomVideoSDKBroadcastStreamingVideoDelegate.
Returns
Errors_Success If the function succeeds, otherwise failed.

◆ unSubscribeAudio

- (ZoomVideoSDKError) unSubscribeAudio

Unsubscribe from streaming audio raw data.

Returns
Errors_Success If the function succeeds, otherwise failed.

◆ unSubscribeVideo

- (ZoomVideoSDKError) unSubscribeVideo

Unsubscribe from streaming video raw data.

Returns
Errors_Success If the function succeeds, otherwise failed.