ZoomVideoSDKIncomingLiveStreamHelper Class Reference

Incoming live stream helper interface. More...

#include <ZoomVideoSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- bindIncomingLiveStream:
	Binds incoming live stream with a stream key ID.
(ZoomVideoSDKError)	- unbindIncomingLiveStream:
	Unbinds the bound incoming live stream.
(ZoomVideoSDKError)	- getIncomingLiveStreamStatus
	Gets the status of bound streams.
(ZoomVideoSDKError)	- startIncomingLiveStream:
	Starts the bound stream as a special participant.
(ZoomVideoSDKError)	- stopIncomingLiveStream:
	Stops the bound stream as a special participant.

Detailed Description

Incoming live stream helper interface.

Definition at line 142 of file ZoomVideoSDKLiveStreamHelper.h.

Method Documentation

bindIncomingLiveStream:

- (ZoomVideoSDKError) bindIncomingLiveStream:

(NSString *_Nullable)

streamKeyID

Binds incoming live stream with a stream key ID.

Parameters

streamKeyID

The stream key ID to bind.

Returns

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

Warning

Only host can bind incoming live stream.

getIncomingLiveStreamStatus

- (ZoomVideoSDKError) getIncomingLiveStreamStatus

Gets the status of bound streams.

Returns

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

Note

Will receive callback "-onIncomingLiveStreamStatusResponse:".

Warning

Only host can get incoming live stream status.

startIncomingLiveStream:

- (ZoomVideoSDKError) startIncomingLiveStream:

(NSString *_Nullable)

streamKeyID

Starts the bound stream as a special participant.

Parameters

streamKeyID

The stream key ID to start.

Returns

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

Warning

Only host can start incoming live stream.

stopIncomingLiveStream:

- (ZoomVideoSDKError) stopIncomingLiveStream:

(NSString *_Nullable)

streamKeyID

Stops the bound stream as a special participant.

Parameters

streamKeyID

The stream key ID to stop.

Returns

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

Warning

Only host can stop incoming live stream.

unbindIncomingLiveStream:

- (ZoomVideoSDKError) unbindIncomingLiveStream:

(NSString *_Nullable)

streamKeyID

Unbinds the bound incoming live stream.

Parameters

streamKeyID

The stream key ID to unbind.

Returns

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

Warning

Only host can unbind incoming live stream.