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

Meeting Video helper event callback. More...

#include <IMeetingVideoHelper.h>

Public Member Functions

virtual ~IMeetingVideoHelperSink ()
 
virtual void OnUpdateMyVideoNotification (const VideoStatus &videoStatus)=0
 Zoom Room's video status changed callback.
 
virtual void OnMuteUserVideoNotification (int32_t userID, const VideoStatus &videoStatus)=0
 After mute user video, user video status changed callback.
 
virtual void OnAskStartVideoByHostNotification (int32_t userID)=0
 Notification from host ask to start video.
 
virtual void OnUpdateScreenStatusForPinNotification (const std::vector< ScreenStatusForPin > &pinStatusList, PinShareWarningType warningType)=0
 Meeting screen status for pin update notification.
 
virtual void OnSpotlightStatusNotification (const SpotlightStatus &spotlightStatus)=0
 Meeting spotlight status changed notification.
 
virtual void OnUpdateAllowAttendeesStartVideo (bool allow)=0
 Allow attendees start video update notification.
 
virtual void OnMyVideoSettingsNotification (const MyVideoSettings &settings)=0
 My video settings notification.
 
virtual void OnMyMeetingVideoSettingsNotification (const MyMeetingVideoSettings &settings)=0
 My video settings of the specific meeting notification.
 

Detailed Description

Meeting Video helper event callback.

Definition at line 112 of file IMeetingVideoHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingVideoHelperSink()

virtual IMeetingVideoHelperSink::~IMeetingVideoHelperSink ( )
inlinevirtual

Definition at line 115 of file IMeetingVideoHelper.h.

115{}

Member Function Documentation

◆ OnAskStartVideoByHostNotification()

virtual void IMeetingVideoHelperSink::OnAskStartVideoByHostNotification ( int32_t  userID)
pure virtual

Notification from host ask to start video.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
userIDThe user ID when requested.

◆ OnMuteUserVideoNotification()

virtual void IMeetingVideoHelperSink::OnMuteUserVideoNotification ( int32_t  userID,
const VideoStatus videoStatus 
)
pure virtual

After mute user video, user video status changed callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
userIDThe specific user ID.
videoStatusAssigned user's video status.

◆ OnMyMeetingVideoSettingsNotification()

virtual void IMeetingVideoHelperSink::OnMyMeetingVideoSettingsNotification ( const MyMeetingVideoSettings settings)
pure virtual

My video settings of the specific meeting notification.

Since
6.5.0
Zoom Rooms minimum version
6.5.0
Parameters
settingsMy meeting video settings.

◆ OnMyVideoSettingsNotification()

virtual void IMeetingVideoHelperSink::OnMyVideoSettingsNotification ( const MyVideoSettings settings)
pure virtual

My video settings notification.

Since
6.5.0
Zoom Rooms minimum version
6.5.0
Parameters
settingsMy video settings. If you use the APIs in IMeetingListHelper to set the settings for the specific meeting, the specific meeting will use the settings you set.

◆ OnSpotlightStatusNotification()

virtual void IMeetingVideoHelperSink::OnSpotlightStatusNotification ( const SpotlightStatus spotlightStatus)
pure virtual

Meeting spotlight status changed notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
spotlightStatusUpdated spotlight status.

◆ OnUpdateAllowAttendeesStartVideo()

virtual void IMeetingVideoHelperSink::OnUpdateAllowAttendeesStartVideo ( bool  allow)
pure virtual

Allow attendees start video update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
allowTRUE indicates attendees are allowed to start video.

◆ OnUpdateMyVideoNotification()

virtual void IMeetingVideoHelperSink::OnUpdateMyVideoNotification ( const VideoStatus videoStatus)
pure virtual

Zoom Room's video status changed callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
videoStatusUpdated video status.

◆ OnUpdateScreenStatusForPinNotification()

virtual void IMeetingVideoHelperSink::OnUpdateScreenStatusForPinNotification ( const std::vector< ScreenStatusForPin > &  pinStatusList,
PinShareWarningType  warningType 
)
pure virtual

Meeting screen status for pin update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
pinStatusListZoom Room screen status for pin.
warningTypePin share warning type, see PinShareWarningType enum.