Live stream meeting controller interface. More...

#include <meeting_live_stream_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingLiveStreamCtrlEvent *pEvent)=0
	Set live stream meeting callback event handler.

virtual SDKError	CanStartLiveStream ()=0
	Determine if it is able to start live streaming.

virtual SDKError	StartLiveStream (IMeetingLiveStreamItem *item_)=0
	Start live streaming.

virtual SDKError	StartLiveStreamWithSteamingURL (const zchar_t streamingURL, const zchar_t streamingKey, const zchar_t *broadcastURL)=0
	Start live streaming.

virtual SDKError	StopLiveStream ()=0
	Stop live streaming.

virtual IList< IMeetingLiveStreamItem * > *	GetSupportLiveStreamURL ()=0
	Get the list of URL and associated information used by live streaming in the current meeting.

virtual IList< IMeetingLiveStreamItem * > *	GetSupportLiveStreamItems ()=0
	Get the list of live stream information items in the current meeting.

virtual IMeetingLiveStreamItem *	GetCurrentLiveStreamItem ()=0
	Get the current live stream object.

virtual LiveStreamStatus	GetCurrentLiveStreamStatus ()=0
	Get live stream status of current meeting.

virtual bool	IsRawLiveStreamSupported ()=0
	Query Whether the meeting supports raw live streams.

virtual SDKError	CanStartRawLiveStream ()=0
	Whether if the current user is able to start raw live streaming.

virtual SDKError	RequestRawLiveStreaming (const zchar_t broadcastURL, const zchar_t broadcastName)=0
	Send a request to enable the SDK to start a raw live stream.

virtual SDKError	StartRawLiveStreaming (const zchar_t broadcastURL, const zchar_t broadcastName)=0
	Start raw live streaming.

virtual SDKError	StopRawLiveStream ()=0
	Stop raw live streaming.

virtual SDKError	RemoveRawLiveStreamPrivilege (unsigned int userid)=0
	Remove the raw live stream privilege.

virtual IList< RawLiveStreamInfo > *	GetRawLiveStreamingInfoList ()=0
	Get a list of current active raw live streams.

virtual IList< unsigned int > *	GetRawLiveStreamPrivilegeUserList ()=0
	Get the list of users'IDs who have raw live stream privileges.

virtual bool	IsLiveStreamReminderEnabled ()=0
	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 IMeetingServiceEvent::onMeetingFullToWatchLiveStream when the meeting user has reached the meeting capability.

virtual bool	CanEnableLiveStreamReminder ()=0
	Check if the current user can enable/disable the live stream reminder.

virtual SDKError	EnableLiveStreamReminder (bool enable)=0
	Enable or disable the live stream reminder.

Detailed Description

Live stream meeting controller interface.

Definition at line 138 of file meeting_live_stream_interface.h.

Member Function Documentation

◆ CanEnableLiveStreamReminder()

virtual bool IMeetingLiveStreamController::CanEnableLiveStreamReminder ( )

pure virtual

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

Returns: True means the current user can enable/disable the live stream reminder.

◆ CanStartLiveStream()

virtual SDKError IMeetingLiveStreamController::CanStartLiveStream ( )

pure virtual

Determine if it is able to start live streaming.

Returns: If it is enabled to start the live streaming, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ CanStartRawLiveStream()

virtual SDKError IMeetingLiveStreamController::CanStartRawLiveStream ( )

pure virtual

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 SDKErr_Success. Otherwise it fails,and returns nullptr. To get extended error information, see SDKError enum.

◆ EnableLiveStreamReminder()

virtual SDKError IMeetingLiveStreamController::EnableLiveStreamReminder ( bool enable )

pure virtual

Enable or disable the live stream reminder.

Parameters

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

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise it fails. To get extended error information, see SDKError enum.

◆ GetCurrentLiveStreamItem()

virtual IMeetingLiveStreamItem * IMeetingLiveStreamController::GetCurrentLiveStreamItem ( )

pure virtual

Get the current live stream object.

Returns: If the function succeeds, the return value is the current live stream object. Otherwise the function fails and the return value is nullptr. For more details, see IMeetingLiveStreamItem.

◆ GetCurrentLiveStreamStatus()

virtual LiveStreamStatus IMeetingLiveStreamController::GetCurrentLiveStreamStatus ( )

pure virtual

Get live stream status of current meeting.

Returns: If the function succeeds, the return value is the live stream status of current meeting.
Otherwise failed. For more details, see LiveStreamStatus enum.

◆ GetRawLiveStreamingInfoList()

virtual IList< RawLiveStreamInfo > * IMeetingLiveStreamController::GetRawLiveStreamingInfoList ( )

pure virtual

Get a list of current active raw live streams.

Returns: If the function succeeds, the return value is a pointer to the IList object. For more details, see IList.

◆ GetRawLiveStreamPrivilegeUserList()

virtual IList< unsigned int > * IMeetingLiveStreamController::GetRawLiveStreamPrivilegeUserList ( )

pure virtual

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 IList object.

◆ GetSupportLiveStreamItems()

virtual IList< IMeetingLiveStreamItem * > * IMeetingLiveStreamController::GetSupportLiveStreamItems ( )

pure virtual

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

Returns: If the function succeeds, the return value is the live stream item list. Otherwise the function fails and the return value is nullptr. For more details, see IMeetingLiveStreamItem.

◆ GetSupportLiveStreamURL()

virtual IList< IMeetingLiveStreamItem * > * IMeetingLiveStreamController::GetSupportLiveStreamURL ( )

pure virtual

Get the list of URL and associated information used by live streaming in the current meeting.

Returns: If the function succeeds, the return value is the meeting information to be live streamed. Otherwise failed, the return value is nullptr. For more details, see IMeetingLiveStreamItem.

Deprecated: This interface is marked as deprecated, and is replaced by GetSupportLiveStreamItems().

◆ IsLiveStreamReminderEnabled()

virtual bool IMeetingLiveStreamController::IsLiveStreamReminderEnabled ( )

pure virtual

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 IMeetingServiceEvent::onMeetingFullToWatchLiveStream when the meeting user has reached the meeting capability.

Returns: True means the live stream reminder is enabled.

◆ IsRawLiveStreamSupported()

virtual bool IMeetingLiveStreamController::IsRawLiveStreamSupported ( )

pure virtual

Query Whether the meeting supports raw live streams.

Returns: true if supported, false if not supported.

◆ RemoveRawLiveStreamPrivilege()

virtual SDKError IMeetingLiveStreamController::RemoveRawLiveStreamPrivilege ( unsigned int userid )

pure virtual

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 SDKErr_Success. Otherwise it fails. To get extended error information, see SDKError enum.

◆ RequestRawLiveStreaming()

virtual SDKError IMeetingLiveStreamController::RequestRawLiveStreaming	(	const zchar_t *	broadcastURL,
		const zchar_t *	broadcastName )

pure virtual

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 SDKErr_Success and the SDK will send the request. Otherwise it fails and the request will not be sent. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError IMeetingLiveStreamController::SetEvent ( IMeetingLiveStreamCtrlEvent * pEvent )

pure virtual

Set live stream meeting callback event handler.

Parameters

pEvent A pointer to the IMeetingLiveStreamCtrlEvent that receives live stream event.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StartLiveStream()

virtual SDKError IMeetingLiveStreamController::StartLiveStream ( IMeetingLiveStreamItem * item_ )

pure virtual

Start live streaming.

Parameters

item_ A pointer to the IMeetingLiveStreamItem created via IMeetingLiveStreamController::GetSupportLiveStreamURL() API.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StartLiveStreamWithSteamingURL()

virtual SDKError IMeetingLiveStreamController::StartLiveStreamWithSteamingURL	(	const zchar_t *	streamingURL,
		const zchar_t *	streamingKey,
		const zchar_t *	broadcastURL )

pure virtual

Start live streaming.

Parameters

streamingURL	The URL of live streaming.
streamingKey	The key of live streaming.
broadcastURL	The broadcast URL of live-stream.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Get the parameters from the third party of live stream service

◆ StartRawLiveStreaming()

virtual SDKError IMeetingLiveStreamController::StartRawLiveStreaming	(	const zchar_t *	broadcastURL,
		const zchar_t *	broadcastName )

pure virtual

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, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StopLiveStream()

virtual SDKError IMeetingLiveStreamController::StopLiveStream ( )

pure virtual

Stop live streaming.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StopRawLiveStream()

virtual SDKError IMeetingLiveStreamController::StopRawLiveStream ( )

pure virtual

Stop raw live streaming.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanEnableLiveStreamReminder()

◆ CanStartLiveStream()

◆ CanStartRawLiveStream()

◆ EnableLiveStreamReminder()

◆ GetCurrentLiveStreamItem()

◆ GetCurrentLiveStreamStatus()

◆ GetRawLiveStreamingInfoList()

◆ GetRawLiveStreamPrivilegeUserList()

◆ GetSupportLiveStreamItems()

◆ GetSupportLiveStreamURL()

◆ IsLiveStreamReminderEnabled()

◆ IsRawLiveStreamSupported()

◆ RemoveRawLiveStreamPrivilege()

◆ RequestRawLiveStreaming()

◆ SetEvent()

◆ StartLiveStream()

◆ StartLiveStreamWithSteamingURL()

◆ StartRawLiveStreaming()

◆ StopLiveStream()

◆ StopRawLiveStream()