ZoomSDKLiveStreamHelper Class Reference

#include <ZoomSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- canStartLiveStream
	Query if it is able for the user to enable live stream.
(NSArray *)	- getSupportLiveStreamItem
	Get the items of live stream supported by the SDK.
(NSArray< ZoomSDKLiveStreamItem * > *_Nullable)	- getSupportLiveStreamItems
	Get the list of live stream information items in the current meeting.
(ZoomSDKLiveStreamItem *_Nullable)	- getCurrentLiveStreamItem
	Get the current live stream object.
(ZoomSDKError)	- startLiveStream:
	Start a live stream.
(ZoomSDKError)	- startLiveStreamByURL:StreamKey:BroadcastURL:
	Start a live stream with the URL customized by user.
(ZoomSDKError)	- stopLiveStream
	Stop a live stream.
(LiveStreamStatus)	- getLiveStreamStatus
	Get the status of current live stream.
(BOOL)	- isRawLiveStreamSupported
	Query Whether the meeting supports raw live streams.
(ZoomSDKError)	- canStartRawLiveStream
	Whether if the current user is able to start raw live streaming.
(ZoomSDKError)	- requestRawLiveStreaming:broadcastName:
	Send a request to enable the SDK to start a raw live stream.
(ZoomSDKError)	- startRawLiveStreaming:broadcastName:
	Start raw live streaming.
(ZoomSDKError)	- stopRawLiveStream
	Stop raw live streaming.
(ZoomSDKError)	- removeRawLiveStreamPrivilege:
	Remove the raw live stream privilege.
(NSArray< ZoomSDKRawLiveStreamInfo * > *_Nullable)	- getRawLiveStreamingInfoList
	Get a list of current active raw live streams.
(NSArray< NSNumber * > *_Nullable)	- getRawLiveStreamPrivilegeUserList
	Get the list of users’ IDs who have raw live stream privileges.
(BOOL)	- isLiveStreamReminderEnabled
	Check if the live stream reminder is enabled. When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can watch the meeting live stream with the callback ZoomSDKMeetingServiceDelegate::onMeetingFullToWatchLiveStream: when the meeting user has reached the meeting capacity.
(BOOL)	- canEnableLiveStreamReminder
	Check if the current user can enable or disable the live stream reminder.
(ZoomSDKError)	- enableLiveStreamReminder:
	Enable or disable the live stream reminder.

Protected Attributes
id< ZoomSDKLiveStreamHelperDelegate >	_delegate

Properties
id< ZoomSDKLiveStreamHelperDelegate >	delegate

Detailed Description

Definition at line 145 of file ZoomSDKLiveStreamHelper.h.

Method Documentation

canEnableLiveStreamReminder

- (BOOL) canEnableLiveStreamReminder

Check if the current user can enable or disable the live stream reminder.

Returns

YES means the current user can enable or disable the live stream reminder.

canStartLiveStream

- (ZoomSDKError) canStartLiveStream

Query if it is able for the user to enable live stream.

Returns

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

canStartRawLiveStream

- (ZoomSDKError) canStartRawLiveStream

Whether if the current user is able to start raw live streaming.

Returns

If the current user is able to start raw live streaming, the return value is ZoomSDKError_Success, otherwise failed.

enableLiveStreamReminder:

- (ZoomSDKError) enableLiveStreamReminder:

(BOOL)

enable

Enable or disable the live stream reminder.

Parameters

enble

YES means enable the live stream reminder. False means disable the live stream reminder.

Returns

If the function succeeds, the return value is ZoomSDKError_Success, otherwise it fails.

getCurrentLiveStreamItem

- (ZoomSDKLiveStreamItem *_Nullable) getCurrentLiveStreamItem

Get the current live stream object.

Returns

If the function succeeds, it will return the current live stream object, otherwise failed.

getLiveStreamStatus

- (LiveStreamStatus) getLiveStreamStatus

Get the status of current live stream.

Returns

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

getRawLiveStreamingInfoList

- (NSArray< ZoomSDKRawLiveStreamInfo * > *_Nullable) getRawLiveStreamingInfoList

Get a list of current active raw live streams.

Returns

If the function succeeds, the return value is a pointer to the NSArray object, otherwise nil.

getRawLiveStreamPrivilegeUserList

- (NSArray< NSNumber * > *_Nullable) getRawLiveStreamPrivilegeUserList

Get the list of users’ IDs who have raw live stream privileges.

Returns

If the function succeeds, the return value is a pointer to the NSArray object.

getSupportLiveStreamItem

- (NSArray *) getSupportLiveStreamItem

Get the items of live stream supported by the SDK.

Returns

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

Deprecated

Use ZoomSDKASController::getSupportLiveStreamItems instead.

getSupportLiveStreamItems

- (NSArray< ZoomSDKLiveStreamItem * > *_Nullable) getSupportLiveStreamItems

Get the list of live stream information items in the current meeting.

Returns

If the function succeeds, it will return the the live stream item list, otherwise failed.

isLiveStreamReminderEnabled

- (BOOL) isLiveStreamReminderEnabled

Check if the live stream reminder is enabled. When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can watch the meeting live stream with the callback ZoomSDKMeetingServiceDelegate::onMeetingFullToWatchLiveStream: when the meeting user has reached the meeting capacity.

Returns

YES means the live stream reminder is enabled.

isRawLiveStreamSupported

- (BOOL) isRawLiveStreamSupported

Query Whether the meeting supports raw live streams.

Returns

Yes if supported, NO if not supported.

removeRawLiveStreamPrivilege:

- (ZoomSDKError) removeRawLiveStreamPrivilege:

(unsigned int)

userID

Remove the raw live stream privilege.

Parameters

userID

Specify the ID of the user whose privilege will be removed.

Returns

If the function succeeds, the return value is ZoomSDKError_Success, otherwise it fails.

requestRawLiveStreaming:broadcastName:

- (ZoomSDKError) requestRawLiveStreaming:		(NSString *)	broadcastURL
broadcastName:		(NSString *)	broadcastName

Send a request to enable the SDK to start a raw live stream.

Parameters

broadcastURL	The broadcast URL of the live-stream.
broadcastName	The broadcast name of the live-stream.

Returns

If the function succeeds, the return value is ZoomSDKError_Success and the SDK will send the request, otherwise it fails and the request will not be sent.

startLiveStream:

- (ZoomSDKError) startLiveStream:

(ZoomSDKLiveStreamItem *)

item

Start a live stream.

Parameters

item	The item of live stream supported by the SDK.

Returns

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

startLiveStreamByURL:StreamKey:BroadcastURL:

- (ZoomSDKError) startLiveStreamByURL:		(NSString *)	streamURL
StreamKey:		(NSString *)	key
BroadcastURL:		(NSString *)	broadcastURL

Start a live stream with the URL customized by user.

Parameters

streamURL	The URL of customized live stream.
key	The key of customized stream stream.
broadcastURL	Everyone who uses this link can watch the live broadcast.

Returns

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

startRawLiveStreaming:broadcastName:

- (ZoomSDKError) startRawLiveStreaming:		(NSString *)	broadcastURL
broadcastName:		(NSString *)	broadcastName

Start raw live streaming.

Parameters

broadcastURL	The broadcast URL of the live-stream.
broadcastName	The broadcast name of the live-stream.

Returns

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

stopLiveStream

- (ZoomSDKError) stopLiveStream

Stop a live stream.

Returns

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

stopRawLiveStream

- (ZoomSDKError) stopRawLiveStream

Stop raw live streaming.

Returns

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

Field Documentation

_delegate

- (id<ZoomSDKLiveStreamHelperDelegate>) _delegate

protected

Definition at line 147 of file ZoomSDKLiveStreamHelper.h.

Property Documentation

delegate

- (id<ZoomSDKLiveStreamHelperDelegate>) delegate

readwritenonatomicassign

Definition at line 149 of file ZoomSDKLiveStreamHelper.h.