ZoomVideoSDKLiveStreamHelper Class Reference

A class to operate the live stream. More...

#include <ZoomVideoSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:
	Starts live stream.
(ZoomVideoSDKError)	- startLiveStreamWithParams:
	Starts a live stream of the current session using ZoomVideoSDKLiveStreamParams.
(ZoomVideoSDKError)	- stopLiveStream
	Stops live streaming.
(ZoomVideoSDKError)	- canStartLiveStream
	Checks if you can start live streaming.
(ZoomVideoSDKLiveStreamSetting *_Nullable)	- getCurrentLiveStreamSetting
	Gets the current live stream settings for the current session.
(ZoomVideoSDKError)	- updateLiveStreamSetting:
	Updates the live stream settings for the current session.
(BOOL)	- canGetOrUpdateLiveStreamSetting
	Determines whether the current user can get or update live stream settings.

Detailed Description

A class to operate the live stream.

Definition at line 60 of file ZoomVideoSDKLiveStreamHelper.h.

Method Documentation

canGetOrUpdateLiveStreamSetting

- (BOOL) canGetOrUpdateLiveStreamSetting

Determines whether 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

- (ZoomVideoSDKError) canStartLiveStream

Checks if you can start live streaming.

Returns

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

getCurrentLiveStreamSetting

- (ZoomVideoSDKLiveStreamSetting *_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, this function fails and returns nil.

startLiveStreamWithParams:

- (ZoomVideoSDKError) startLiveStreamWithParams:

(ZoomVideoSDKLiveStreamParams *_Nullable)

param

Starts a live stream of the current session using ZoomVideoSDKLiveStreamParams.

Parameters

param

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

Returns

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

Warning

Only session host can start live stream successfully.

startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:

- (ZoomVideoSDKError) startLiveStreamWithStreamingURL:		(NSString *_Nullable)	streamingURL
StreamingKey:		(NSString *_Nullable)	key
BroadcastURL:		("Use startLiveStreamWithParams: instead")	__deprecated_msg

Starts live stream.

Parameters

streamingURL	The live stream URL by which you can live the session.
key	The stream key offered by the third platform on which you want to live stream your session.
broadcastURL	The URL of live stream website.

Returns

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

Warning

Only session host can start live stream successfully.

Deprecated

Use startLiveStreamWithParams: instead.

stopLiveStream

- (ZoomVideoSDKError) stopLiveStream

Stops live streaming.

Returns

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

Warning

The function is available only for host.

updateLiveStreamSetting:

- (ZoomVideoSDKError) updateLiveStreamSetting:

(ZoomVideoSDKLiveStreamSetting *_Nullable)

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

Warning

The function is available only for host.

Note

If the same settings as the previous call are passed, this function will return Errors_Wrong_Usage.