ZoomVideoSDKLiveStreamHelper Class Reference

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

#include <ZoomVideoSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:
	Call the function to start live stream.
(ZoomVideoSDKError)	- startLiveStreamWithParams:
	Start a live stream of the current session using ZoomVideoSDKLiveStreamParams.
(ZoomVideoSDKError)	- stopLiveStream
	Set to stop live streaming.
(ZoomVideoSDKError)	- canStartLiveStream
	Check to see if you can start live streaming.
(ZoomVideoSDKLiveStreamSetting *_Nullable)	- getCurrentLiveStreamSetting
	Get the current live stream settings for the current session.
(ZoomVideoSDKError)	- 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

A class to operate the live stream.

Definition at line 60 of file ZoomVideoSDKLiveStreamHelper.h.

Method Documentation

canGetOrUpdateLiveStreamSetting

- (BOOL) canGetOrUpdateLiveStreamSetting

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

Returns

true if the user can get or update live stream settings, false otherwise.

Note

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

canStartLiveStream

- (ZoomVideoSDKError) canStartLiveStream

Check to see if you can start live streaming.

Returns

The result of it.

getCurrentLiveStreamSetting

- (ZoomVideoSDKLiveStreamSetting *_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.

startLiveStreamWithParams:

- (ZoomVideoSDKError) startLiveStreamWithParams:

(ZoomVideoSDKLiveStreamParams *_Nullable)

param

Start a live stream of the current session using ZoomVideoSDKLiveStreamParams.

Parameters

param

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

Returns

Success means that the method is called successfully, otherwise not.

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

Call the function to start live stream.

Parameters

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

Returns

Success means that the method is called successfully, otherwise not.

Warning

Only session host can start live Stream successfully.

Deprecated

This method is deprecated. Use startLiveStreamWithParams: instead.

stopLiveStream

- (ZoomVideoSDKError) stopLiveStream

Set to stop live streaming.

Returns

YES means stopping live streaming successfully, otherwise not.

Warning

The function is available only for host.

updateLiveStreamSetting:

- (ZoomVideoSDKError) updateLiveStreamSetting:

(ZoomVideoSDKLiveStreamSetting *_Nullable)

setting

Update the live stream settings for the current session.

Parameters

setting

The new live stream settings to apply.

Returns

Success means that the method is called successfully, otherwise not.

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.