Zoom Rooms Controller SDK Reference 7.1.0
Loading...
Searching...
No Matches
IProAVServiceSink Class Referenceabstract

Pro AV Service event callback. More...

#include <IProAVService.h>

Public Member Functions

virtual ~IProAVServiceSink ()
 
virtual void OnProAVVideoOverlaySettingsNotification (const ProAVVideoOverlaySettings &settings)=0
 Pro AV video overlay setting notification callback.
 
virtual void OnProAVUnassignedBehaviorNotification (const ProAVUnassignedBehavior &behavior)=0
 Pro AV unassigned behavior notification callback.
 
virtual void OnProAVVideoLossBehaviorNotification (const ProAVVideoLossBehavior &behavior)=0
 Pro AV video loss behavior notification callback.
 
virtual void OnProAVNonPersistentAssignedGalleryUpdate (const ProAVAssignedGalleryInfo &info)=0
 Pro AV non-persistent assigned gallery update notification callback. This notification is triggered when the non-persistent assigned gallery configuration is updated during a meeting.
 
virtual void OnProAVPersistentAssignedGalleryUpdate (const std::vector< ProAVAssignedGalleryInfo > &infos)=0
 Pro AV persistent assigned galleries update notification callback. This notification is triggered when the persistent assigned gallery configurations are updated.
 
virtual void OnProAVAssignedGalleryStatusUpdate (const ProAVAssignedGalleryStatus &status, const std::vector< uint32_t > &deleteIndices)=0
 Pro AV assigned gallery status update callback. This callback is triggered when:
 
virtual void OnProAVDeleteAssignedGallerySeatFailed (const std::vector< uint32_t > &deleteIndices)=0
 Pro AV assigned gallery seat deletion failure callback. This callback is triggered when DeleteProAVAssignedGallerySeat() fails to delete one or more seats.
 
virtual void OnProAVAssignedGalleryHideOptionsUpdate (const ProAVAssignedGalleryHideOptions &options)=0
 Pro AV assigned gallery hide options update callback. This callback is triggered when the ZR pushes an update to the assigned gallery hide options configuration.
 

Detailed Description

Pro AV Service event callback.

Definition at line 170 of file IProAVService.h.

Constructor & Destructor Documentation

◆ ~IProAVServiceSink()

virtual IProAVServiceSink::~IProAVServiceSink ( )
inlinevirtual

Definition at line 173 of file IProAVService.h.

173{}

Member Function Documentation

◆ OnProAVAssignedGalleryHideOptionsUpdate()

virtual void IProAVServiceSink::OnProAVAssignedGalleryHideOptionsUpdate ( const ProAVAssignedGalleryHideOptions options)
pure virtual

Pro AV assigned gallery hide options update callback. This callback is triggered when the ZR pushes an update to the assigned gallery hide options configuration.

Since
7.1.0
Zoom Rooms minimum version
7.1.0
Parameters
optionsThe updated hide options, see ProAVAssignedGalleryHideOptions struct.

◆ OnProAVAssignedGalleryStatusUpdate()

virtual void IProAVServiceSink::OnProAVAssignedGalleryStatusUpdate ( const ProAVAssignedGalleryStatus status,
const std::vector< uint32_t > &  deleteIndices 
)
pure virtual

Pro AV assigned gallery status update callback. This callback is triggered when:

Since
7.0.0
Zoom Rooms minimum version
7.0.0
  • Receiving a successful response to RequestProAVAssignedGalleryStatus()
  • Receiving a successful response to DeleteProAVAssignedGallerySeat()
  • ZR pushes updated status (e.g., when status changes)
Parameters
statusThe updated assigned gallery status, see ProAVAssignedGalleryStatus struct.
deleteIndicesThe indices of seats that were successfully deleted. Empty if this is not a delete operation response.

◆ OnProAVDeleteAssignedGallerySeatFailed()

virtual void IProAVServiceSink::OnProAVDeleteAssignedGallerySeatFailed ( const std::vector< uint32_t > &  deleteIndices)
pure virtual

Pro AV assigned gallery seat deletion failure callback. This callback is triggered when DeleteProAVAssignedGallerySeat() fails to delete one or more seats.

Since
7.0.0
Zoom Rooms minimum version
7.0.0
Parameters
deleteIndicesThe indices of seats that failed to be deleted.

◆ OnProAVNonPersistentAssignedGalleryUpdate()

virtual void IProAVServiceSink::OnProAVNonPersistentAssignedGalleryUpdate ( const ProAVAssignedGalleryInfo info)
pure virtual

Pro AV non-persistent assigned gallery update notification callback. This notification is triggered when the non-persistent assigned gallery configuration is updated during a meeting.

Since
7.0.0
Zoom Rooms minimum version
7.0.0
Parameters
infopro AV assigned gallery info, see ProAVAssignedGalleryInfo struct.

◆ OnProAVPersistentAssignedGalleryUpdate()

virtual void IProAVServiceSink::OnProAVPersistentAssignedGalleryUpdate ( const std::vector< ProAVAssignedGalleryInfo > &  infos)
pure virtual

Pro AV persistent assigned galleries update notification callback. This notification is triggered when the persistent assigned gallery configurations are updated.

Since
7.0.0
Zoom Rooms minimum version
7.0.0
Parameters
infospro AV assigned gallery infos, see ProAVAssignedGalleryInfo struct.

◆ OnProAVUnassignedBehaviorNotification()

virtual void IProAVServiceSink::OnProAVUnassignedBehaviorNotification ( const ProAVUnassignedBehavior behavior)
pure virtual

Pro AV unassigned behavior notification callback.

Since
6.5.0
Zoom Rooms minimum version
6.5.0
Parameters
behaviorpro AV unassigned behavior settings, see ProAVVideoOverlaySettings struct.

◆ OnProAVVideoLossBehaviorNotification()

virtual void IProAVServiceSink::OnProAVVideoLossBehaviorNotification ( const ProAVVideoLossBehavior behavior)
pure virtual

Pro AV video loss behavior notification callback.

Since
6.6.0
Zoom Rooms minimum version
6.6.0
Parameters
behaviorpro AV video loss behavior settings, see ProAVVideoLossBehavior struct.

◆ OnProAVVideoOverlaySettingsNotification()

virtual void IProAVServiceSink::OnProAVVideoOverlaySettingsNotification ( const ProAVVideoOverlaySettings settings)
pure virtual

Pro AV video overlay setting notification callback.

Since
6.2.0
Zoom Rooms minimum version
6.2.0
Parameters
settingspro AV video overlay settings, see ProAVVideoOverlaySettings struct.