Interface for managing standard and raw live streams in a meeting. More...

#include <ZoomSDKLiveStreamHelper.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- canStartLiveStream
	Query if it is able for the user to enable live stream.
(NSArray *)	- getSupportLiveStreamItem
	Gets the items of live stream supported by the SDK.
(NSArray< ZoomSDKLiveStreamItem * > *_Nullable)	- getSupportLiveStreamItems
	Gets the list of live stream information items in the current meeting.
(ZoomSDKLiveStreamItem *_Nullable)	- getCurrentLiveStreamItem
	Gets the current live stream object.
(ZoomSDKError)	- startLiveStream:
	Starts a live stream.
(ZoomSDKError)	- startLiveStreamByURL:StreamKey:BroadcastURL:
	Starts a live stream with the URL customized by user.
(ZoomSDKError)	- stopLiveStream
	Stops a live stream.
(LiveStreamStatus)	- getLiveStreamStatus
	Gets 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:
	Sends a request to enable the SDK to start a raw live stream.
(ZoomSDKError)	- startRawLiveStreaming:broadcastName:
	Starts raw live streaming.
(ZoomSDKError)	- stopRawLiveStream
	Stops raw live streaming.
(ZoomSDKError)	- removeRawLiveStreamPrivilege:
	Removes the raw live stream privilege.
(NSArray< ZoomSDKRawLiveStreamInfo * > *_Nullable)	- getRawLiveStreamingInfoList
	Gets a list of current active raw live streams.
(NSArray< NSNumber * > *_Nullable)	- getRawLiveStreamPrivilegeUserList
	Gets the list of users’ IDs who have raw live stream privileges.
(BOOL)	- isLiveStreamReminderEnabled
	Checks 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
	Checks if the current user can enable or disable the live stream reminder.
(ZoomSDKError)	- enableLiveStreamReminder:
	Enables or disable the live stream reminder.

Protected Attributes
id< ZoomSDKLiveStreamHelperDelegate >	_delegate

Properties
id< ZoomSDKLiveStreamHelperDelegate >	delegate
	Sets or get the delegate to receive live stream event callbacks.

Detailed Description

Interface for managing standard and raw live streams in a meeting.

Definition at line 158 of file ZoomSDKLiveStreamHelper.h.

Method Documentation

◆ canEnableLiveStreamReminder

- (BOOL) canEnableLiveStreamReminder

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

Returns: YES if the current user can enable or disable the live stream reminder. Otherwise, NO.

References canEnableLiveStreamReminder.

Referenced by canEnableLiveStreamReminder.

◆ canStartLiveStream

- (ZoomSDKError) canStartLiveStream

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

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References canStartLiveStream.

Referenced by canStartLiveStream.

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

References canStartRawLiveStream.

Referenced by canStartRawLiveStream.

◆ enableLiveStreamReminder:

- (ZoomSDKError) enableLiveStreamReminder: (BOOL) enable

Enables or disable the live stream reminder.

Parameters

enable YES to enable the live stream reminder, NO to disable the live stream reminder.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getCurrentLiveStreamItem

- (ZoomSDKLiveStreamItem *_Nullable) getCurrentLiveStreamItem

Gets the current live stream object.

Returns: If the function succeeds, it returns the current live stream object. Otherwise, this function fails and returns nil.

References getCurrentLiveStreamItem.

Referenced by getCurrentLiveStreamItem.

◆ getLiveStreamStatus

- (LiveStreamStatus) getLiveStreamStatus

Gets the status of current live stream.

Returns: If the function succeeds, it returns the LiveStreamStatus_InProgress. Otherwise, this function returns an error.

References getLiveStreamStatus.

Referenced by getLiveStreamStatus.

◆ getRawLiveStreamingInfoList

- (NSArray< ZoomSDKRawLiveStreamInfo * > *_Nullable) getRawLiveStreamingInfoList

Gets a list of current active raw live streams.

Returns: If the function succeeds, it returns a pointer to the NSArray object. Otherwise, this function fails and returns nil.

References getRawLiveStreamingInfoList.

Referenced by getRawLiveStreamingInfoList.

◆ getRawLiveStreamPrivilegeUserList

- (NSArray< NSNumber * > *_Nullable) getRawLiveStreamPrivilegeUserList

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

Returns: If the function succeeds, it returns a pointer to the NSArray object. Otherwise, this function fails and returns nil.

References getRawLiveStreamPrivilegeUserList.

Referenced by getRawLiveStreamPrivilegeUserList.

◆ getSupportLiveStreamItem

- (NSArray *) getSupportLiveStreamItem

Gets the items of live stream supported by the SDK.

Returns: If the function succeeds, it returns the items. Otherwise, this function fails and returns nil.

Deprecated: Use ZoomSDKASController::getSupportLiveStreamItems instead.

References getSupportLiveStreamItem, and getSupportLiveStreamItems.

Referenced by getSupportLiveStreamItem.

◆ getSupportLiveStreamItems

- (NSArray< ZoomSDKLiveStreamItem * > *_Nullable) getSupportLiveStreamItems

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

Returns: If the function succeeds, it returns the the live stream item list. Otherwise, this function fails and returns nil.

References getSupportLiveStreamItems.

Referenced by getSupportLiveStreamItem, and getSupportLiveStreamItems.

◆ isLiveStreamReminderEnabled

- (BOOL) isLiveStreamReminderEnabled

Checks 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 if the live stream reminder is enabled. Otherwise, NO.

References isLiveStreamReminderEnabled.

Referenced by isLiveStreamReminderEnabled.

◆ isRawLiveStreamSupported

- (BOOL) isRawLiveStreamSupported

Query Whether the meeting supports raw live streams.

Returns: Yes if supported, Otherwise, NO.

References isRawLiveStreamSupported.

Referenced by isRawLiveStreamSupported.

◆ removeRawLiveStreamPrivilege:

- (ZoomSDKError) removeRawLiveStreamPrivilege: (unsigned int) userID

Removes the raw live stream privilege.

Parameters

userID Specify the user's ID whose privilege will be removed.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ requestRawLiveStreaming:broadcastName:

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

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

Parameters

broadcastURL	The live stream's broadcast URL.
broadcastName	The live stream's broadcast name.

Returns: If the function succeeds, it returns ZoomSDKError_Success and the SDK will send the request. Otherwise, this function returns an error and the request will not be sent.

◆ startLiveStream:

- (ZoomSDKError) startLiveStream: (ZoomSDKLiveStreamItem *) item

Starts a live stream.

Parameters

item	The item of live stream supported by the SDK.

Returns: If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startLiveStreamByURL:StreamKey:BroadcastURL:

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

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

◆ startRawLiveStreaming:broadcastName:

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

Starts raw live streaming.

Parameters

broadcastURL	The live stream's broadcast URL
broadcastName	The live stream's broadcast name.

Returns: If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

◆ stopLiveStream

- (ZoomSDKError) stopLiveStream

Stops a live stream.

Returns: If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

References stopLiveStream.

Referenced by stopLiveStream.

◆ stopRawLiveStream

- (ZoomSDKError) stopRawLiveStream

Stops raw live streaming.

Returns: If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

References stopRawLiveStream.

Referenced by stopRawLiveStream.

Field Documentation

◆ _delegate

- (id<ZoomSDKLiveStreamHelperDelegate>) _delegate

protected

Definition at line 160 of file ZoomSDKLiveStreamHelper.h.

Property Documentation

◆ delegate

- (id<ZoomSDKLiveStreamHelperDelegate>) delegate

readwritenonatomicassign

Sets or get the delegate to receive live stream event callbacks.

Definition at line 165 of file ZoomSDKLiveStreamHelper.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ canEnableLiveStreamReminder

◆ canStartLiveStream

◆ canStartRawLiveStream

◆ enableLiveStreamReminder:

◆ getCurrentLiveStreamItem

◆ getLiveStreamStatus

◆ getRawLiveStreamingInfoList

◆ getRawLiveStreamPrivilegeUserList

◆ getSupportLiveStreamItem

◆ getSupportLiveStreamItems

◆ isLiveStreamReminderEnabled

◆ isRawLiveStreamSupported

◆ removeRawLiveStreamPrivilege:

◆ requestRawLiveStreaming:broadcastName:

◆ startLiveStream:

◆ startLiveStreamByURL:StreamKey:BroadcastURL:

◆ startRawLiveStreaming:broadcastName:

◆ stopLiveStream

◆ stopRawLiveStream

Field Documentation

◆ _delegate

Property Documentation

◆ delegate