ISmartTagHelper.h File Reference

Smart tag interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
class	ISmartTagHelperSink
	Smart Tag helper event callback. More...
class	ISmartTagHelper

Enumerations
enum	SmartTagType { SmartTagTypeUnknown = -1 , SmartTagTypeNameTag = 0 , SmartTagTypeSpeakerTag = 1 }
	Smart tag type. Here are more detailed structural descriptions. More...
enum	UnsupportSmartNameTagReason {   UnsupportSmartNameTagReasonNone = -1 , UnsupportSmartNameTagReasonUnknown = 0 , UnsupportSmartNameTagReasonHardware = 1 , UnsupportSmartNameTagReasonOptionDisabled = 2 ,   UnsupportSmartNameTagReasonMultiFocus = 3 , UnsupportSmartNameTagReasonSmartGallery = 4 , UnsupportSmartNameTagReasonIntelligentDirector = 5 }
	Smart name tag unsuppoeted reason. Here are more detailed structural descriptions. More...
enum	UnsupportAutomaticReason { UnsupportAutomaticReasonNone = -1 , UnsupportAutomaticReasonExceedInviteeMaximum = 0 , UnsupportAutomaticReasonExceedEnrollMaximum = 1 , UnsupportAutomaticReasonWebOptionDisabled = 2 }
	Unsupport automatic smart tag reason. Here are more detailed structural descriptions. More...

Detailed Description

Smart tag interfaces.

Since

Added in ZRC SDK 6.3.5

Smart Speaker Tags: There are two types:

1. All Instance Smart Speaker Tag: Bind to smart speaker tag for participant in the meeting.
2. Instance Only Smart Speaker Tag: Bind to smart speaker tag for individual LTT caption message.

Smart Name Tags: There are two types:

1. Unnamed Smart Name Tag, e.g.''Participant 1". This tag is visible only to yourself in the meeting.
2. Named Smart Name Tag. This tag is visible to all participants in the meeting.

Suggested User List for Smart Tag Binding:

1. Companion mode users (Zoom client user pair to Zoom Rooms).
2. User bound to the smart tag. Suggested binding smart speaker tag users are named smart name tags. Suggested binding smart name tag users are edited smart speaker tags.
3. Meeting invitation attendees.
4. Contact user. Call IContactHelper::RequestContactsDynamically to get contact list.

Definition in file ISmartTagHelper.h.

Enumeration Type Documentation

SmartTagType

enum SmartTagType

Smart tag type. Here are more detailed structural descriptions.

Enumerator
SmartTagTypeUnknown	Unknown.
SmartTagTypeNameTag	Smart name tag.
SmartTagTypeSpeakerTag	Smart speaker tag.

Definition at line 33 of file ISmartTagHelper.h.

{
    SmartTagTypeUnknown       = -1,     
    SmartTagTypeNameTag       = 0,      
    SmartTagTypeSpeakerTag    = 1,      
};

UnsupportAutomaticReason

enum UnsupportAutomaticReason

Unsupport automatic smart tag reason. Here are more detailed structural descriptions.

Enumerator
UnsupportAutomaticReasonNone	None.
UnsupportAutomaticReasonExceedInviteeMaximum	The number of invitees has reached the maximum limit.
UnsupportAutomaticReasonExceedEnrollMaximum	The number of enrollments has reached the maximum limit.
UnsupportAutomaticReasonWebOptionDisabled	The web option "Automatic smart name tags for video/voice" is disabled.

Definition at line 59 of file ISmartTagHelper.h.

{
    UnsupportAutomaticReasonNone = -1,                   
    UnsupportAutomaticReasonExceedInviteeMaximum = 0,    
    UnsupportAutomaticReasonExceedEnrollMaximum = 1,     
    UnsupportAutomaticReasonWebOptionDisabled = 2,       
};

UnsupportSmartNameTagReason

enum UnsupportSmartNameTagReason

Smart name tag unsuppoeted reason. Here are more detailed structural descriptions.

Enumerator
UnsupportSmartNameTagReasonNone	None.
UnsupportSmartNameTagReasonUnknown	Unknown.
UnsupportSmartNameTagReasonHardware	Hardware unsupported.
UnsupportSmartNameTagReasonOptionDisabled	Feature option disabled.
UnsupportSmartNameTagReasonMultiFocus	Multi focus mode.
UnsupportSmartNameTagReasonSmartGallery	Smart gallery mode.
UnsupportSmartNameTagReasonIntelligentDirector	Intelligent director mode.

Definition at line 44 of file ISmartTagHelper.h.

{
    UnsupportSmartNameTagReasonNone = -1,                   
    UnsupportSmartNameTagReasonUnknown = 0,                 
    UnsupportSmartNameTagReasonHardware = 1,                
    UnsupportSmartNameTagReasonOptionDisabled = 2,          
    UnsupportSmartNameTagReasonMultiFocus = 3,              
    UnsupportSmartNameTagReasonSmartGallery = 4,            
    UnsupportSmartNameTagReasonIntelligentDirector = 5,     
};