ZMVideoSDKIncomingLiveStreamHelper Class Reference

Interface for managing incoming live streams. More...

#include <ZMVideoSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- bindIncomingLiveStream:
	Bind incoming live stream with a stream key ID.
(ZMVideoSDKErrors)	- unbindIncomingLiveStream:
	Unbind the bound incoming live stream.
(ZMVideoSDKErrors)	- getIncomingLiveStreamStatus
	Get the status of the bound streams.
(ZMVideoSDKErrors)	- startIncomingLiveStream:
	Start the bound stream as a special participant.
(ZMVideoSDKErrors)	- stopIncomingLiveStream:
	Stop the bound stream as a special participant.

Detailed Description

Interface for managing incoming live streams.

Definition at line 139 of file ZMVideoSDKLiveStreamHelper.h.

Method Documentation

bindIncomingLiveStream:

- (ZMVideoSDKErrors) bindIncomingLiveStream:

(NSString *)

strStreamKeyID

Bind incoming live stream with a stream key ID.

Parameters

strStreamKeyID

The stream key ID to bind.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

getIncomingLiveStreamStatus

- (ZMVideoSDKErrors) getIncomingLiveStreamStatus

Get the status of the bound streams.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success, otherwise failed.

Note

Will receive callback "-onIncomingLiveStreamStatusResponse:"

startIncomingLiveStream:

- (ZMVideoSDKErrors) startIncomingLiveStream:

(NSString *)

strStreamKeyID

Start the bound stream as a special participant.

Parameters

strStreamKeyID

The stream key ID you want to start.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

stopIncomingLiveStream:

- (ZMVideoSDKErrors) stopIncomingLiveStream:

(NSString *)

strStreamKeyID

Stop the bound stream as a special participant.

Parameters

strStreamKeyID

The stream key ID to stop.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

unbindIncomingLiveStream:

- (ZMVideoSDKErrors) unbindIncomingLiveStream:

(NSString *)

strStreamKeyID

Unbind the bound incoming live stream.

Parameters

strStreamKeyID

The stream key ID you want to unbind.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.