ZMVideoSDKLiveStreamHelper Class Reference

Helper class for managing outgoing live stream. More...

#include <ZMVideoSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- startLiveStream:broadcastUrl:liveStreamKey:
	Start live stream.
(ZMVideoSDKErrors)	- stopLiveStream
	Stop live stream.
(ZMVideoSDKErrors)	- canStartLiveStream
	Determine if can start living stream.
(ZMVideoSDKErrors)	- startLiveStreamWithParams:
	Start a live stream of the current session using ZMVideoSDKLiveStreamParams.
(ZMVideoSDKLiveStreamSetting *_Nullable)	- getCurrentLiveStreamSetting
	Get the current live stream settings for the current session.
(ZMVideoSDKErrors)	- updateLiveStreamSetting:
	Update the live stream settings for the current session.
(BOOL)	- canGetOrUpdateLiveStreamSetting
	Check if the current user can get or update live stream settings.

Detailed Description

Helper class for managing outgoing live stream.

Definition at line 61 of file ZMVideoSDKLiveStreamHelper.h.

Method Documentation

canGetOrUpdateLiveStreamSetting

- (BOOL) canGetOrUpdateLiveStreamSetting

Check if the current user can get or update live stream settings.

Returns

YES if the user can get or update live stream settings, NO otherwise.

Note

Live stream must be started, and only the person who started the live stream can get or update the setting.

canStartLiveStream

- (ZMVideoSDKErrors) canStartLiveStream

Determine if can start living stream.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

getCurrentLiveStreamSetting

- (ZMVideoSDKLiveStreamSetting *_Nullable) getCurrentLiveStreamSetting

Get the current live stream settings for the current session.

Returns

The current live stream settings. Returns nil if no live stream is active.

startLiveStream:broadcastUrl:liveStreamKey:

- (ZMVideoSDKErrors) startLiveStream:		(NSString *)	streamUrl
broadcastUrl:		(NSString *)	url
liveStreamKey:		(NSString *)	key

Start live stream.

Parameters

streamUrl	The live stream url.
url	The live stream broadcast url.
key	The live stream key.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

Deprecated

Use startLiveStreamWithParams: instead.

startLiveStreamWithParams:

- (ZMVideoSDKErrors) startLiveStreamWithParams:

(ZMVideoSDKLiveStreamParams *)

param

Start a live stream of the current session using ZMVideoSDKLiveStreamParams.

Parameters

param

The live stream parameters containing URL, key, broadcast URL and settings.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

stopLiveStream

- (ZMVideoSDKErrors) stopLiveStream

Stop live stream.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

updateLiveStreamSetting:

- (ZMVideoSDKErrors) updateLiveStreamSetting:

(ZMVideoSDKLiveStreamSetting *)

setting

Update the live stream settings for the current session.

Parameters

setting

The new live stream settings to apply.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.