Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_live_stream_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_LIVE_STREAM_INTERFACE_H_
6#define _MEETING_LIVE_STREAM_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
10
30
36{
38 unsigned int userId;
44 {
45 userId = 0;
46 broadcastUrl = nullptr;
47 broadcastName = nullptr;
48 }
49};
50
56{
57public:
59
64 virtual const zchar_t* GetRequestId() = 0;
65
70 virtual unsigned int GetRequesterId() = 0;
71
76 virtual const zchar_t* GetRequesterName() = 0;
77
82 virtual const zchar_t* GetBroadcastUrl() = 0;
83
88 virtual const zchar_t* GetBroadcastName() = 0;
89
94
99};
100
106{
107public:
113
118 virtual void onRawLiveStreamPrivilegeChanged(bool bHasPrivilege) = 0;
119
124
130 virtual void onUserRawLiveStreamPrivilegeChanged(unsigned int userid, bool bHasPrivilege) = 0;
131
137
143
148 virtual void onLiveStreamReminderStatusChanged(bool enable) = 0;
149
154
160 virtual void onUserThresholdReachedForLiveStream(int percent) = 0;
161};
162
168{
169public:
174 virtual const zchar_t* GetLiveStreamURL() = 0;
175
181
186 virtual const zchar_t* GetLiveStreamViewerURL() = 0;
187
189};
190
196{
197public:
204
210
217
226 virtual SDKError StartLiveStreamWithSteamingURL(const zchar_t* streamingURL, const zchar_t* streamingKey, const zchar_t* broadcastURL) = 0;
227
233
240
246
252
258
263 virtual bool IsRawLiveStreamSupported() = 0;
264
270
277 virtual SDKError RequestRawLiveStreaming(const zchar_t* broadcastURL, const zchar_t* broadcastName) = 0;
278
285 virtual SDKError StartRawLiveStreaming(const zchar_t* broadcastURL, const zchar_t* broadcastName) = 0;
286
292
298 virtual SDKError RemoveRawLiveStreamPrivilege(unsigned int userid) = 0;
299
305
311
317 virtual bool IsLiveStreamReminderEnabled() = 0;
318
323 virtual bool CanEnableLiveStreamReminder() = 0;
324
330 virtual SDKError EnableLiveStreamReminder(bool enable) = 0;
331};
333#endif
Live stream meeting controller interface.
virtual SDKError RemoveRawLiveStreamPrivilege(unsigned int userid)=0
Remove the raw live stream privilege.
virtual SDKError StartLiveStream(IMeetingLiveStreamItem *item_)=0
Start live streaming.
virtual SDKError StartRawLiveStreaming(const zchar_t *broadcastURL, const zchar_t *broadcastName)=0
Start raw live streaming.
virtual IList< IMeetingLiveStreamItem * > * GetSupportLiveStreamURL()=0
Get the list of URL and associated information used by live streaming in the current meeting.
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 CanStartLiveStream()=0
Determine if it is able to start live streaming.
virtual IList< unsigned int > * GetRawLiveStreamPrivilegeUserList()=0
Get the list of users'IDs who have raw live stream privileges.
virtual IList< IMeetingLiveStreamItem * > * GetSupportLiveStreamItems()=0
Get the list of live stream information items in the current meeting.
virtual SDKError StopLiveStream()=0
Stop live streaming.
virtual bool IsRawLiveStreamSupported()=0
Query Whether the meeting supports raw live streams.
virtual SDKError SetEvent(IMeetingLiveStreamCtrlEvent *pEvent)=0
Set live stream meeting callback event handler.
virtual IList< RawLiveStreamInfo > * GetRawLiveStreamingInfoList()=0
Get a list of current active raw live streams.
virtual bool CanEnableLiveStreamReminder()=0
Check if the current user can enable/disable the live stream reminder.
virtual SDKError StartLiveStreamWithSteamingURL(const zchar_t *streamingURL, const zchar_t *streamingKey, const zchar_t *broadcastURL)=0
Start live streaming.
virtual bool IsLiveStreamReminderEnabled()=0
Check if the live stream reminder is enabled.
virtual LiveStreamStatus GetCurrentLiveStreamStatus()=0
Get live stream status of current meeting.
virtual SDKError StopRawLiveStream()=0
Stop raw live streaming.
virtual SDKError EnableLiveStreamReminder(bool enable)=0
Enable or disable the live stream reminder.
virtual IMeetingLiveStreamItem * GetCurrentLiveStreamItem()=0
Get the current live stream object.
virtual SDKError CanStartRawLiveStream()=0
Whether if the current user is able to start raw live streaming.
Live stream meeting controller callback event.
virtual void onLiveStreamReminderStatusChangeFailed()=0
Callback event when the live stream reminder enable status change fails.
virtual void onUserThresholdReachedForLiveStream(int percent)=0
Callback event when the meeting or webinar user has nearly reached the meeting capacity,...
virtual void onRawLiveStreamPrivilegeChanged(bool bHasPrivilege)=0
Callback event when the current user's raw live streaming privilege changes.
virtual void onRawLiveStreamPrivilegeRequestTimeout()=0
Callback event when the current user's request has time out.
virtual void onRawLiveStreamPrivilegeRequested(IRequestRawLiveStreamPrivilegeHandler *handler)=0
Callback event when a user requests raw live streaming privilege.
virtual void onUserRawLiveStreamingStatusChanged(IList< RawLiveStreamInfo > *liveStreamList)=0
Callback event when users start/stop raw live streaming.
virtual void onLiveStreamStatusChange(LiveStreamStatus status)=0
Callback event when live stream status changes.
virtual void onLiveStreamReminderStatusChanged(bool enable)=0
Callback event when the live stream reminder enable status changes.
virtual void onUserRawLiveStreamPrivilegeChanged(unsigned int userid, bool bHasPrivilege)=0
Callback event when another user's raw live streaming privilege has changed.
Live stream of current meeting.
virtual const zchar_t * GetLiveStreamURL()=0
Get URL of the live stream meeting.
virtual const zchar_t * GetLiveStreamViewerURL()=0
Get the viewer URL of the live stream meeting.
virtual const zchar_t * GetLiveStreamURLDescription()=0
Get the descriptions of live stream.
Process after the host receives the requirement from the user to give the raw live stream privilege.
virtual const zchar_t * GetRequesterName()=0
Get the user name who requested privileges.
virtual const zchar_t * GetBroadcastName()=0
Get the broadcast name.
virtual const zchar_t * GetBroadcastUrl()=0
Get the broadcast URL.
virtual unsigned int GetRequesterId()=0
Get the user ID who requested privilege.
virtual const zchar_t * GetRequestId()=0
Get the request ID.
virtual SDKError GrantRawLiveStreamPrivilege()=0
Allows the user to start raw live stream and finally self-destroy.
virtual SDKError DenyRawLiveStreamPrivilege()=0
Denies the user permission to start raw live stream and finally self-destroy.
LiveStreamStatus
Status of live stream. Here are more detailed structural descriptions.
@ LiveStreamStatus_Start_Failed
@ LiveStreamStatus_Start_Failed_Timeout
information of raw live stream info. Here are more detailed structural descriptions....
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
Definition zoom_sdk_def.h:9
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.