ZMVideoSDKLiveStreamHelper Class Reference

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

#include <ZMVideoSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- startLiveStream:broadcastUrl:liveStreamKey:
	Starts live stream.
(ZMVideoSDKErrors)	- stopLiveStream
	Stops live stream.
(ZMVideoSDKErrors)	- canStartLiveStream
	Determines if can start living stream.
(ZMVideoSDKErrors)	- startLiveStreamWithParams:
	Starts a live stream of the current session using ZMVideoSDKLiveStreamParams.
(ZMVideoSDKLiveStreamSetting *_Nullable)	- getCurrentLiveStreamSetting
	Gets the current live stream settings for the current session.
(ZMVideoSDKErrors)	- updateLiveStreamSetting:
	Updates the live stream settings for the current session.
(BOOL)	- canGetOrUpdateLiveStreamSetting
	Checks 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

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

Returns

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

Note

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

canStartLiveStream

- (ZMVideoSDKErrors) canStartLiveStream

Determines if can start living stream.

Returns

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

getCurrentLiveStreamSetting

- (ZMVideoSDKLiveStreamSetting *_Nullable) getCurrentLiveStreamSetting

Gets the current live stream settings for the current session.

Returns

If the function succeeds, it returns the current live stream settings. Otherwise, returns nil if no live stream is active.

startLiveStream:broadcastUrl:liveStreamKey:

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

Starts 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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Deprecated

Use startLiveStreamWithParams: instead.

startLiveStreamWithParams:

- (ZMVideoSDKErrors) startLiveStreamWithParams:

(ZMVideoSDKLiveStreamParams *)

param

Starts 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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

stopLiveStream

- (ZMVideoSDKErrors) stopLiveStream

Stops live stream.

Returns

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

updateLiveStreamSetting:

- (ZMVideoSDKErrors) updateLiveStreamSetting:

(ZMVideoSDKLiveStreamSetting *)

setting

Updates the live stream settings for the current session.

Parameters

setting

The new live stream settings to apply.

Returns

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