Live stream meeting controller interface. More...

#include <meeting_live_stream_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingLiveStreamCtrlEvent *pEvent)=0
	Sets live stream meeting callback event handler.
virtual SDKError	CanStartLiveStream ()=0
	Determines if it is able to start live streaming.
virtual SDKError	StartLiveStream (IMeetingLiveStreamItem *item_)=0
	Starts live streaming.
virtual SDKError	StartLiveStreamWithSteamingURL (const zchar_t streamingURL, const zchar_t streamingKey, const zchar_t *broadcastURL)=0
	Starts live streaming.
virtual SDKError	StopLiveStream ()=0
	Stops live streaming.
virtual IList< IMeetingLiveStreamItem * > *	GetSupportLiveStreamItems ()=0
	Gets the list of live stream information items in the current meeting.
virtual IMeetingLiveStreamItem *	GetCurrentLiveStreamItem ()=0
	Gets the current live stream object.
virtual LiveStreamStatus	GetCurrentLiveStreamStatus ()=0
	Gets 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
	Sends a request to enable the SDK to start a raw live stream.
virtual SDKError	StartRawLiveStreaming (const zchar_t broadcastURL, const zchar_t broadcastName)=0
	Starts raw live streaming.
virtual SDKError	StopRawLiveStream ()=0
	Stops raw live streaming.
virtual SDKError	RemoveRawLiveStreamPrivilege (unsigned int userid)=0
	Remove the raw live stream privilege.
virtual IList< RawLiveStreamInfo > *	GetRawLiveStreamingInfoList ()=0
	Gets a list of current active raw live streams.
virtual IList< unsigned int > *	GetRawLiveStreamPrivilegeUserList ()=0
	Gets the list of users'IDs who have raw live stream privileges.
virtual bool	IsLiveStreamReminderEnabled ()=0
	Checks if the live stream reminder is enabled.
virtual bool	CanEnableLiveStreamReminder ()=0
	Checks if the current user can enable/disable the live stream reminder.
virtual SDKError	EnableLiveStreamReminder (bool enable)=0
	Enables or disable the live stream reminder.

Detailed Description

Live stream meeting controller interface.

Definition at line 197 of file meeting_live_stream_interface.h.

Member Function Documentation

◆ CanEnableLiveStreamReminder()

virtual bool IMeetingLiveStreamController::CanEnableLiveStreamReminder ( )

pure virtual

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

Returns: true indicates the current user can enable/disable the live stream reminder.

◆ CanStartLiveStream()

virtual SDKError IMeetingLiveStreamController::CanStartLiveStream ( )

pure virtual

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

◆ 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.

◆ EnableLiveStreamReminder()

virtual SDKError IMeetingLiveStreamController::EnableLiveStreamReminder ( bool enable )

pure virtual

Enables or disable the live stream reminder.

Parameters

enable true indicates 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.

◆ GetCurrentLiveStreamItem()

virtual IMeetingLiveStreamItem * IMeetingLiveStreamController::GetCurrentLiveStreamItem ( )

pure virtual

Gets the current live stream object.

Returns: If the function succeeds, the return value is the current live stream object. Otherwise, the return value is nullptr.

◆ GetCurrentLiveStreamStatus()

virtual LiveStreamStatus IMeetingLiveStreamController::GetCurrentLiveStreamStatus ( )

pure virtual

Gets live stream status of current meeting.

Returns: If the function succeeds, the return value is the live stream status of current meeting.

◆ GetRawLiveStreamingInfoList()

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

pure virtual

Gets a list of current active raw live streams.

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

◆ GetRawLiveStreamPrivilegeUserList()

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

pure virtual

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

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

◆ GetSupportLiveStreamItems()

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

pure virtual

Gets 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 return value is nullptr.

◆ IsLiveStreamReminderEnabled()

virtual bool IMeetingLiveStreamController::IsLiveStreamReminderEnabled ( )

pure virtual

Checks if the live stream reminder is enabled.

Returns: true indicates the live stream reminder is enabled.

Note: 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.

◆ IsRawLiveStreamSupported()

virtual bool IMeetingLiveStreamController::IsRawLiveStreamSupported ( )

pure virtual

Query Whether the meeting supports raw live streams.

Returns: true if supported. Otherwise, false.

◆ 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.

◆ RequestRawLiveStreaming()

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

pure virtual

Sends 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.

◆ SetEvent()

virtual SDKError IMeetingLiveStreamController::SetEvent ( IMeetingLiveStreamCtrlEvent * pEvent )

pure virtual

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

◆ StartLiveStream()

virtual SDKError IMeetingLiveStreamController::StartLiveStream ( IMeetingLiveStreamItem * item_ )

pure virtual

Starts live streaming.

Parameters

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

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ StartLiveStreamWithSteamingURL()

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

pure virtual

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

Note: 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

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

◆ StopLiveStream()

virtual SDKError IMeetingLiveStreamController::StopLiveStream ( )

pure virtual

Stops live streaming.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ StopRawLiveStream()

virtual SDKError IMeetingLiveStreamController::StopRawLiveStream ( )

pure virtual

Stops raw live streaming.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanEnableLiveStreamReminder()

◆ CanStartLiveStream()

◆ CanStartRawLiveStream()

◆ EnableLiveStreamReminder()

◆ GetCurrentLiveStreamItem()

◆ GetCurrentLiveStreamStatus()

◆ GetRawLiveStreamingInfoList()

◆ GetRawLiveStreamPrivilegeUserList()

◆ GetSupportLiveStreamItems()

◆ IsLiveStreamReminderEnabled()

◆ IsRawLiveStreamSupported()

◆ RemoveRawLiveStreamPrivilege()

◆ RequestRawLiveStreaming()

◆ SetEvent()

◆ StartLiveStream()

◆ StartLiveStreamWithSteamingURL()

◆ StartRawLiveStreaming()

◆ StopLiveStream()

◆ StopRawLiveStream()