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

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

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

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

virtual SDKError	StopLiveStream ()=0
	Stop live streaming. More...

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

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

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

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

virtual SDKError	RequestRawLiveStream (const wchar_t *broadcastURL)=0
	Send a request to enable the SDK to start a raw live stream. More...

virtual SDKError	StartRawLiveStream (const wchar_t *broadcastURL)=0
	Start raw live streaming. More...

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

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

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

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

Detailed Description

Live stream meeting controller interface.

Definition at line 116 of file meeting_live_stream_interface.h.

Member Function Documentation

◆ 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 NULL. To get extended error information, see SDKError enum.

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

◆ 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 NULL. For more details, see IMeetingLiveStreamItem.

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

◆ RequestRawLiveStream()

virtual SDKError IMeetingLiveStreamController::RequestRawLiveStream ( const wchar_t * broadcastURL )

pure virtual

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

Parameters

broadcastURL The broadcast URL 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 wchar_t *	streamingURL,
		const wchar_t *	streamingKey,
		const wchar_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

◆ StartRawLiveStream()

virtual SDKError IMeetingLiveStreamController::StartRawLiveStream ( const wchar_t * broadcastURL )

pure virtual

Start raw live streaming.

Parameters

broadcastURL The broadcast URL 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

◆ CanStartLiveStream()

◆ CanStartRawLiveStream()

◆ GetCurrentLiveStreamStatus()

◆ GetRawLiveStreamingInfoList()

◆ GetRawLiveStreamPrivilegeUserList()

◆ GetSupportLiveStreamURL()

◆ IsRawLiveStreamSupported()

◆ RemoveRawLiveStreamPrivilege()

◆ RequestRawLiveStream()

◆ SetEvent()

◆ StartLiveStream()

◆ StartLiveStreamWithSteamingURL()

◆ StartRawLiveStream()

◆ StopLiveStream()

◆ StopRawLiveStream()