ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IMeetingLiveStreamController Class Referenceabstract

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

Detailed Description

Live stream meeting controller interface.

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.

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

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

◆ SetEvent()

virtual SDKError IMeetingLiveStreamController::SetEvent ( IMeetingLiveStreamCtrlEvent pEvent)
pure virtual

Set live stream meeting callback event handler.

Parameters
pEventA 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
streamingURLThe URL of live streaming.
streamingKeyThe key of live streaming.
broadcastURLThe 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

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

The documentation for this class was generated from the following file: