Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IMeetingWebinarHelperSink Class Referenceabstract

Meeting Webinar helper event callback. More...

#include <IMeetingWebinarHelper.h>

Public Member Functions

virtual ~IMeetingWebinarHelperSink ()
 
virtual void OnWebinarPracticeSessionNotification (bool inWebinarPracticeSession)=0
 Webinar practice session notification.
 
virtual void OnUpdateWebinarInfo (const WebinarInfo &info)=0
 Webinar info update notification.
 
virtual void OnWebinarRoleChangedNotification (WebinarRoleChangedState roleChangedState)=0
 Webinar role changed notification.
 
virtual void OnPanelistReachMaximumCapacityNotification (int32_t maximumCapacity)=0
 Panelist reach maximum capacity notification.
 
virtual void OnWebinarAttendeeBaseInfoNotification (const WebinarAttendeeBaseInfo &baseInfo)=0
 Webinar attendee base info notification.
 
virtual void OnDynamicWebinarAttendeeListResponse (const DynamicWebinarAttendeeListRes &response)=0
 Dynamic webinar attendee list response.
 
virtual void OnNeedPromoteAttendeeToAllowTalkingNotification (int32_t userID, const std::string &userName)=0
 Need promote attendee to allow talking notification.
 
virtual void OnAllowAttendeeViewParticipantCountNotification (bool allow)=0
 Allow attendee view participant count notification.
 
virtual void OnWebinarParticipantCountNotification (const WebinarParticipantCountInfo &countInfo)=0
 Webinar attendee count info notification.
 
virtual void OnWebinarUnencryptedInfoNotification (const WebinarUnencryptedInfo &unencryptedInfo)=0
 Webinar unencrypted info notification in end-to-end meeting.
 
virtual void OnBackstageNotification (const BackstageNotification &noti)=0
 Backstage notification.
 
virtual void OnBackstageInfoNotification (const BackstageInfo &info)=0
 Backstage info update notification.
 
virtual void OnProductionStudioNotification (bool isProducerPublishing)=0
 Production studio notification.
 

Detailed Description

Meeting Webinar helper event callback.

Definition at line 127 of file IMeetingWebinarHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingWebinarHelperSink()

virtual IMeetingWebinarHelperSink::~IMeetingWebinarHelperSink ( )
inlinevirtual

Definition at line 130 of file IMeetingWebinarHelper.h.

130{}

Member Function Documentation

◆ OnAllowAttendeeViewParticipantCountNotification()

virtual void IMeetingWebinarHelperSink::OnAllowAttendeeViewParticipantCountNotification ( bool  allow)
pure virtual

Allow attendee view participant count notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
allowTRUE indicates attendees are now allowed to view participant count.

◆ OnBackstageInfoNotification()

virtual void IMeetingWebinarHelperSink::OnBackstageInfoNotification ( const BackstageInfo info)
pure virtual

Backstage info update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
infoThe backstage info.

◆ OnBackstageNotification()

virtual void IMeetingWebinarHelperSink::OnBackstageNotification ( const BackstageNotification noti)
pure virtual

Backstage notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
notiThe notification.

◆ OnDynamicWebinarAttendeeListResponse()

virtual void IMeetingWebinarHelperSink::OnDynamicWebinarAttendeeListResponse ( const DynamicWebinarAttendeeListRes response)
pure virtual

Dynamic webinar attendee list response.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
responseThe dynamic webinar attendee list response.

◆ OnNeedPromoteAttendeeToAllowTalkingNotification()

virtual void IMeetingWebinarHelperSink::OnNeedPromoteAttendeeToAllowTalkingNotification ( int32_t  userID,
const std::string &  userName 
)
pure virtual

Need promote attendee to allow talking notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0

This happens when the user is using an older version of Zoom.

Parameters
userIDThe attendee userID
userNameThe attendee userName.

◆ OnPanelistReachMaximumCapacityNotification()

virtual void IMeetingWebinarHelperSink::OnPanelistReachMaximumCapacityNotification ( int32_t  maximumCapacity)
pure virtual

Panelist reach maximum capacity notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
maximumCapacityThe maximum capacity.

◆ OnProductionStudioNotification()

virtual void IMeetingWebinarHelperSink::OnProductionStudioNotification ( bool  isProducerPublishing)
pure virtual

Production studio notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
isProducerPublishingTRUE indicates is producer publishing, can change confidence monitor layout to "Production Studio".

◆ OnUpdateWebinarInfo()

virtual void IMeetingWebinarHelperSink::OnUpdateWebinarInfo ( const WebinarInfo info)
pure virtual

Webinar info update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
infoWebinar info.

◆ OnWebinarAttendeeBaseInfoNotification()

virtual void IMeetingWebinarHelperSink::OnWebinarAttendeeBaseInfoNotification ( const WebinarAttendeeBaseInfo baseInfo)
pure virtual

Webinar attendee base info notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
baseInfoThe webinar attendee base info.

◆ OnWebinarParticipantCountNotification()

virtual void IMeetingWebinarHelperSink::OnWebinarParticipantCountNotification ( const WebinarParticipantCountInfo countInfo)
pure virtual

Webinar attendee count info notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
countInfoThe webinar attendee count info.

◆ OnWebinarPracticeSessionNotification()

virtual void IMeetingWebinarHelperSink::OnWebinarPracticeSessionNotification ( bool  inWebinarPracticeSession)
pure virtual

Webinar practice session notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
inWebinarPracticeSessionTRUE indicates you are in webinar practice session.

◆ OnWebinarRoleChangedNotification()

virtual void IMeetingWebinarHelperSink::OnWebinarRoleChangedNotification ( WebinarRoleChangedState  roleChangedState)
pure virtual

Webinar role changed notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
roleChangedStateRole changed state, see WebinarRoleChangedState enum.

◆ OnWebinarUnencryptedInfoNotification()

virtual void IMeetingWebinarHelperSink::OnWebinarUnencryptedInfoNotification ( const WebinarUnencryptedInfo unencryptedInfo)
pure virtual

Webinar unencrypted info notification in end-to-end meeting.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
unencryptedInfoThe webinar unencrypted info.