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

Smart Tag helper event callback. More...

#include <ISmartTagHelper.h>

Public Member Functions

virtual ~ISmartTagHelperSink ()
 
virtual void OnSmartTagStatusUpdated (SmartTagType type, bool enabled, bool isSupported)=0
 Smart tag status updated notification.
 
virtual void OnSmartTagSuggestedAttendeeUpdated (SmartTagType type, const std::vector< SmartTagUser > &attendees)=0
 Smart tag suggested attendee updated notification.
 
virtual void OnUnnamedSmartNameTagListUpdated (const std::vector< SmartTagUser > &unnamedTagList)=0
 Unnamed smart name tag list updated notification.
 
virtual void OnNameTagAvatarUpdated (int32_t tagID, const std::string &avatarData)=0
 Smart name tag avata data updated (screenshot of the user’s head in the video) notification.
 
virtual void OnAllInstanceSpeakerTagListUpdated (const std::vector< SmartTagUser > &smartSpeakerTagList)=0
 All instance smart speaker tag list updated notification.
 
virtual void OnSpeakerTagAvatarUpdated (const std::string &jid, const std::string &avatarUrl)=0
 Smart speaker tag avatar updated notification.
 
virtual void OnNameTagUnsupportedReasonUpdated (UnsupportSmartNameTagReason reason)=0
 Smart name tag unsupported reason updated notification.
 

Detailed Description

Smart Tag helper event callback.

Definition at line 57 of file ISmartTagHelper.h.

Constructor & Destructor Documentation

◆ ~ISmartTagHelperSink()

virtual ISmartTagHelperSink::~ISmartTagHelperSink ( )
inlinevirtual

Definition at line 61 of file ISmartTagHelper.h.

61{}

Member Function Documentation

◆ OnAllInstanceSpeakerTagListUpdated()

virtual void ISmartTagHelperSink::OnAllInstanceSpeakerTagListUpdated ( const std::vector< SmartTagUser > &  smartSpeakerTagList)
pure virtual

All instance smart speaker tag list updated notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
smartSpeakerTagListSmart speaker tag list, see SmartTagUser struct.

◆ OnNameTagAvatarUpdated()

virtual void ISmartTagHelperSink::OnNameTagAvatarUpdated ( int32_t  tagID,
const std::string &  avatarData 
)
pure virtual

Smart name tag avata data updated (screenshot of the user’s head in the video) notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
tagIDSmart name tag ID.
avatarDataThe binary data of avatar image.

◆ OnNameTagUnsupportedReasonUpdated()

virtual void ISmartTagHelperSink::OnNameTagUnsupportedReasonUpdated ( UnsupportSmartNameTagReason  reason)
pure virtual

Smart name tag unsupported reason updated notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
reasonSmart name tag unsupported reason, see UnsupportSmartNameTagReason enum.

◆ OnSmartTagStatusUpdated()

virtual void ISmartTagHelperSink::OnSmartTagStatusUpdated ( SmartTagType  type,
bool  enabled,
bool  isSupported 
)
pure virtual

Smart tag status updated notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
typeSmart tag type, see SmartTagType enum.
enabledTRUE indicates that smart tag is enabled. Otherwise not.
isSupportedTRUE indicates that smart tag is supported. Otherwise not.

◆ OnSmartTagSuggestedAttendeeUpdated()

virtual void ISmartTagHelperSink::OnSmartTagSuggestedAttendeeUpdated ( SmartTagType  type,
const std::vector< SmartTagUser > &  attendees 
)
pure virtual

Smart tag suggested attendee updated notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
typeSmart tag type, see SmartTagType enum.
attendeesSuggested meeting invatation attendees, include companion mode users, bound smart tag users and invitation sttendees.

◆ OnSpeakerTagAvatarUpdated()

virtual void ISmartTagHelperSink::OnSpeakerTagAvatarUpdated ( const std::string &  jid,
const std::string &  avatarUrl 
)
pure virtual

Smart speaker tag avatar updated notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
jidSmart speaker tag bind JID.
avatarUrlSmart speaker tag bind JID user avatar URL.

◆ OnUnnamedSmartNameTagListUpdated()

virtual void ISmartTagHelperSink::OnUnnamedSmartNameTagListUpdated ( const std::vector< SmartTagUser > &  unnamedTagList)
pure virtual

Unnamed smart name tag list updated notification.

Since
6.3.5
Zoom Rooms minimum version
6.2.0
Parameters
unnamedTagListUnnamed smart name tag list, see SmartTagUser struct.