#include <ISmartTagHelper.h>

Public Member Functions
virtual	~ISmartTagHelper ()

virtual ZRCSDKError	RegisterSink (ISmartTagHelperSink *pSink)=0
	Register smart tag helper callback sink.

virtual ZRCSDKError	DeregisterSink (ISmartTagHelperSink *pSink)=0
	Deregister smart tag helper callback sink.

virtual ZRCSDKError	GetAllInstanceSpeakerTagList (int32_t userID, std::vector< SmartTagUser > &speakerTagList)=0
	Query all instance smart speaker tag list from participant list.

virtual ZRCSDKError	GetNamedNameTagList (int32_t userID, std::vector< SmartTagUser > &nameTagList)=0
	Query named smart name tag list from participant list.

virtual ZRCSDKError	GetUnnamedNameTagList (std::vector< SmartTagUser > &nameTagList)=0
	Query unnamed smart name tag list.

virtual ZRCSDKError	GetParticipantSmartTag (SmartTagType type, int32_t userID, int32_t tagID, SmartTagUser &tagUser)=0
	Query all instance speaker tag or named name tag from participant list.

virtual ZRCSDKError	GetSpeakerTagAvatarByJid (const std::string &jid, std::string &avatarUrl)=0
	Query smart speaker tag avatar by JID.

virtual ZRCSDKError	EnableSmartTag (SmartTagType type, bool enable)=0
	Enable smart name/speaker tag.

virtual ZRCSDKError	RequestSmartTagSuggestedAttendee (SmartTagType type)=0
	Request smart name/speaker tag suggested attendee.

virtual ZRCSDKError	RequestSmartNameTagAvatarData (int32_t tagID)=0
	Request smart name tag avatar data (screenshot of the user’s head).

virtual ZRCSDKError	RenameEditedSpeakerTag (const SmartTagUser &editedTag, const std::string &name, const std::string &messageID)=0
	Rename the edited smart speaker tag.

virtual ZRCSDKError	RenameGenericSpeakerTag (int32_t tagID, const std::string &name, const std::string &messageID)=0
	Rename the generic smart speaker tag.

virtual ZRCSDKError	RenameNameTag (int32_t tagID, const std::string &name)=0
	Rename the smart name tag.

virtual ZRCSDKError	BindEditedSpeakerTagToEmail (const SmartTagUser &editedTag, const std::string &email, const std::string &name, const std::string &jid, const std::string &messageID)=0
	Bind the edited smart speaker tag to email.

virtual ZRCSDKError	BindGenericSpeakerTagToEmail (int32_t tagID, const std::string &email, const std::string &name, const std::string &jid, const std::string &messageID)=0
	Bind the generic smart speaker tag to email.

virtual ZRCSDKError	BindNameTagToEmail (int32_t tagID, const std::string &email, const std::string &name, const std::string &jid)=0
	Bind the smart name tag to email.

virtual ZRCSDKError	BindEditedSpeakerTagToUserID (const SmartTagUser &editedTag, int32_t userID, const std::string &name, const std::string &messageID)=0
	Bind the edited smart speaker tag to companion user.

virtual ZRCSDKError	BindGenericSpeakerTagToUserID (int32_t tagID, int32_t userID, const std::string &name, const std::string &messageID)=0
	Bind the generic smart speaker tag to companion user.

virtual ZRCSDKError	BindNameTagToUserID (int32_t tagID, int32_t userID, const std::string &name)=0
	Bind smart name tag to companion user.

virtual ZRCSDKError	UnbindEditedSpeakerTag (const SmartTagUser &editedTag, const std::string &messageID)=0
	Unbind the edited smart speaker tag.

virtual ZRCSDKError	UnbindNameTag (int32_t tagID)=0
	Unbind smart name tag.

Detailed Description

Definition at line 141 of file ISmartTagHelper.h.

Constructor & Destructor Documentation

◆ ~ISmartTagHelper()

virtual ISmartTagHelper::~ISmartTagHelper ( )

inlinevirtual

Definition at line 144 of file ISmartTagHelper.h.

144{}

Member Function Documentation

◆ BindEditedSpeakerTagToEmail()

virtual ZRCSDKError ISmartTagHelper::BindEditedSpeakerTagToEmail	(	const SmartTagUser &	editedTag,
		const std::string &	email,
		const std::string &	name,
		const std::string &	jid,
		const std::string &	messageID
	)

pure virtual

Bind the edited smart speaker tag to email.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

editedTag	Edited smartspeaker tag, see SmartTagUser struct.
email	Smart speaker tag bind email.
name	Smart speaker tag bind name.
jid	Smart speaker tag bind JID.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BindEditedSpeakerTagToUserID()

virtual ZRCSDKError ISmartTagHelper::BindEditedSpeakerTagToUserID	(	const SmartTagUser &	editedTag,
		int32_t	userID,
		const std::string &	name,
		const std::string &	messageID
	)

pure virtual

Bind the edited smart speaker tag to companion user.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

editedTag	Edited smartspeaker tag, see SmartTagUser struct.
userID	Zoom Room companion user ID.
name	Smart speaker tag bind name.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BindGenericSpeakerTagToEmail()

virtual ZRCSDKError ISmartTagHelper::BindGenericSpeakerTagToEmail	(	int32_t	tagID,
		const std::string &	email,
		const std::string &	name,
		const std::string &	jid,
		const std::string &	messageID
	)

pure virtual

Bind the generic smart speaker tag to email.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID	Smart speaker tag ID.
email	Smart speaker tag bind email.
name	Smart speaker tag bind name.
jid	Smart speaker tag bind JID.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BindGenericSpeakerTagToUserID()

virtual ZRCSDKError ISmartTagHelper::BindGenericSpeakerTagToUserID	(	int32_t	tagID,
		int32_t	userID,
		const std::string &	name,
		const std::string &	messageID
	)

pure virtual

Bind the generic smart speaker tag to companion user.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID	Generic smart speaker tag ID.
userID	Zoom Room companion user ID.
name	Smart speaker tag bind name.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BindNameTagToEmail()

virtual ZRCSDKError ISmartTagHelper::BindNameTagToEmail	(	int32_t	tagID,
		const std::string &	email,
		const std::string &	name,
		const std::string &	jid
	)

pure virtual

Bind the smart name tag to email.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID	Smart name tag ID.
email	Smart name tag bind email.
name	Smart name tag bind name.
jid	Smart name tag bind JID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BindNameTagToUserID()

virtual ZRCSDKError ISmartTagHelper::BindNameTagToUserID	(	int32_t	tagID,
		int32_t	userID,
		const std::string &	name
	)

pure virtual

Bind smart name tag to companion user.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID	Smart name tag ID.
userID	Zoom Room companion user ID.
name	Smart name tag bind name.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError ISmartTagHelper::DeregisterSink ( ISmartTagHelperSink * pSink )

pure virtual

Deregister smart tag helper callback sink.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

pSink A pointer to the ISmartTagHelperSink that receives the smart tag helper callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EnableSmartTag()

virtual ZRCSDKError ISmartTagHelper::EnableSmartTag	(	SmartTagType	type,
		bool	enable
	)

pure virtual

Enable smart name/speaker tag.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

type	The smart tag type, see SmartTagType enum.
enable	TRUE indicates to enable smart tag. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetAllInstanceSpeakerTagList()

virtual ZRCSDKError ISmartTagHelper::GetAllInstanceSpeakerTagList	(	int32_t	userID,
		std::vector< SmartTagUser > &	speakerTagList
	)

pure virtual

Query all instance smart speaker tag list from participant list.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out]	speakerTagList	All instance smart speaker tag list, see SmartTagUser struct.
[in]	userID	Participant userID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetNamedNameTagList()

virtual ZRCSDKError ISmartTagHelper::GetNamedNameTagList	(	int32_t	userID,
		std::vector< SmartTagUser > &	nameTagList
	)

pure virtual

Query named smart name tag list from participant list.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out]	nameTagList	Named smart name tag list, see SmartTagUser struct.
[in]	userID	Participant userID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetParticipantSmartTag()

virtual ZRCSDKError ISmartTagHelper::GetParticipantSmartTag	(	SmartTagType	type,
		int32_t	userID,
		int32_t	tagID,
		SmartTagUser &	tagUser
	)

pure virtual

Query all instance speaker tag or named name tag from participant list.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out]	tagUser	Smart tag user, see SmartTagUser struct.
[in]	type	The smart tag type, see SmartTagType enum.
[in]	userID	Participant userID.
[in]	tagID	Smart tag ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetSpeakerTagAvatarByJid()

virtual ZRCSDKError ISmartTagHelper::GetSpeakerTagAvatarByJid	(	const std::string &	jid,
		std::string &	avatarUrl
	)

pure virtual

Query smart speaker tag avatar by JID.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out]	avatarUrl	Smart speaker tag user avatar URL.
[in]	jid	Smart speaker tag user JID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetUnnamedNameTagList()

virtual ZRCSDKError ISmartTagHelper::GetUnnamedNameTagList ( std::vector< SmartTagUser > & nameTagList )

pure virtual

Query unnamed smart name tag list.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

[out] nameTagList Unnamed smart name tag list, see SmartTagUser struct.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError ISmartTagHelper::RegisterSink ( ISmartTagHelperSink * pSink )

pure virtual

Register smart tag helper callback sink.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

pSink A pointer to the ISmartTagHelperSink that receives the smart tag helper callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RenameEditedSpeakerTag()

virtual ZRCSDKError ISmartTagHelper::RenameEditedSpeakerTag	(	const SmartTagUser &	editedTag,
		const std::string &	name,
		const std::string &	messageID
	)

pure virtual

Rename the edited smart speaker tag.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

editedTag	Edited smartspeaker tag, see SmartTagUser struct.
name	Smart speaker tag name.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RenameGenericSpeakerTag()

virtual ZRCSDKError ISmartTagHelper::RenameGenericSpeakerTag	(	int32_t	tagID,
		const std::string &	name,
		const std::string &	messageID
	)

pure virtual

Rename the generic smart speaker tag.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID	Smart speaker tag ID.
name	Smart speaker tag name.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RenameNameTag()

virtual ZRCSDKError ISmartTagHelper::RenameNameTag	(	int32_t	tagID,
		const std::string &	name
	)

pure virtual

Rename the smart name tag.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID	Smart name tag ID.
name	Smart speaker tag name.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RequestSmartNameTagAvatarData()

virtual ZRCSDKError ISmartTagHelper::RequestSmartNameTagAvatarData ( int32_t tagID )

pure virtual

Request smart name tag avatar data (screenshot of the user’s head).

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID Smart name tag ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RequestSmartTagSuggestedAttendee()

virtual ZRCSDKError ISmartTagHelper::RequestSmartTagSuggestedAttendee ( SmartTagType type )

pure virtual

Request smart name/speaker tag suggested attendee.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

type	The smart tag type, see SmartTagType enum.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UnbindEditedSpeakerTag()

virtual ZRCSDKError ISmartTagHelper::UnbindEditedSpeakerTag	(	const SmartTagUser &	editedTag,
		const std::string &	messageID
	)

pure virtual

Unbind the edited smart speaker tag.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

editedTag	Edited smart speaker tag, see SmartTagUser struct.
messageID	LTT caption message ID. If provided, the instance only speaker tag is edited. If empty, all instance speaker tag is edited.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UnbindNameTag()

virtual ZRCSDKError ISmartTagHelper::UnbindNameTag ( int32_t tagID )

pure virtual

Unbind smart name tag.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

Parameters

tagID Smart name tag ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ISmartTagHelper()

Member Function Documentation

◆ BindEditedSpeakerTagToEmail()

◆ BindEditedSpeakerTagToUserID()

◆ BindGenericSpeakerTagToEmail()

◆ BindGenericSpeakerTagToUserID()

◆ BindNameTagToEmail()

◆ BindNameTagToUserID()

◆ DeregisterSink()

◆ EnableSmartTag()

◆ GetAllInstanceSpeakerTagList()

◆ GetNamedNameTagList()

◆ GetParticipantSmartTag()

◆ GetSpeakerTagAvatarByJid()

◆ GetUnnamedNameTagList()

◆ RegisterSink()

◆ RenameEditedSpeakerTag()

◆ RenameGenericSpeakerTag()

◆ RenameNameTag()

◆ RequestSmartNameTagAvatarData()

◆ RequestSmartTagSuggestedAttendee()

◆ UnbindEditedSpeakerTag()

◆ UnbindNameTag()