Meeting Reaction Emoji helper interface. More...

#include <IMeetingReactionEmojiHelper.h>

Public Member Functions
virtual	~IMeetingReactionEmojiHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingReactionEmojiHelperSink *pSink)=0
	Register meeting reaction emoji helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingReactionEmojiHelperSink *pSink)=0
	Deregister meeting reaction emoji helper callback sink.

virtual ZRCSDKError	IsReactionEmojiEnabled (bool &enabled)=0
	Query if reaction emoji enabled.

virtual ZRCSDKError	IsReactionFeedbackEnabled (bool &enabled)=0
	Query if reaction feedback enabled.

virtual ZRCSDKError	IsAnimatedReactionEnabled (bool &enabled)=0
	Query if animated reaction enabled.

virtual ZRCSDKError	SendEmoji (const std::string &emoji)=0
	Send emoji.

virtual ZRCSDKError	SendReactionFeedback (ReactionFeedback feedback)=0
	Send reaction feedback.

virtual ZRCSDKError	EnableReactionInWebinar (bool enable)=0
	Enable reaction in webinar meeting.

virtual ZRCSDKError	SendWebinarEmojiReaction (WebinarEmojiReactionType type)=0
	Send emoji reaction in webinar meeting.

virtual ZRCSDKError	ChangeSkinTone (HandSkinTone skinTone)=0
	Change skin tone.

virtual ZRCSDKError	ChangeReactionIntensity (ReactionIntensity intensity)=0
	Change reaction intensity in webinar meeting.

virtual ZRCSDKError	ClearAllFeedback ()=0
	Clear all feedback.

virtual ZRCSDKError	GetSupportedEmojisForMeeting (std::string &emojis)=0
	Get supported emoji list.

virtual ZRCSDKError	GetSupportedEmojiSkinsForMeeting (std::string &emojiSkins)=0
	Get supported emoji skins example.

virtual ZRCSDKError	GetSupportedEmojisBySkinTone (std::string &emojis, HandSkinTone skinTone)=0
	Get supported emojis by skin tone.

Detailed Description

Meeting Reaction Emoji helper interface.

Definition at line 103 of file IMeetingReactionEmojiHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingReactionEmojiHelper()

virtual IMeetingReactionEmojiHelper::~IMeetingReactionEmojiHelper ( )

inlinevirtual

Definition at line 106 of file IMeetingReactionEmojiHelper.h.

106{}

Member Function Documentation

◆ ChangeReactionIntensity()

virtual ZRCSDKError IMeetingReactionEmojiHelper::ChangeReactionIntensity ( ReactionIntensity intensity )

pure virtual

Change reaction intensity in webinar meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

intensity The reaction intensity, this changes how you see the reactions on screen.

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

◆ ChangeSkinTone()

virtual ZRCSDKError IMeetingReactionEmojiHelper::ChangeSkinTone ( HandSkinTone skinTone )

pure virtual

Change skin tone.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

skinTone The skin tone, see different HandSkinTone example emojis with GetSupportedEmojiSkinsForMeeting.

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

◆ ClearAllFeedback()

virtual ZRCSDKError IMeetingReactionEmojiHelper::ClearAllFeedback ( )

pure virtual

Clear all feedback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ DeregisterSink()

virtual ZRCSDKError IMeetingReactionEmojiHelper::DeregisterSink ( IMeetingReactionEmojiHelperSink * pSink )

pure virtual

Deregister meeting reaction emoji helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingReactionEmojiHelperSink that receives the meeting reaction emoji helper event callback.

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

◆ EnableReactionInWebinar()

virtual ZRCSDKError IMeetingReactionEmojiHelper::EnableReactionInWebinar ( bool enable )

pure virtual

Enable reaction in webinar meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates enable. Otherwise not.

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

◆ GetSupportedEmojisBySkinTone()

virtual ZRCSDKError IMeetingReactionEmojiHelper::GetSupportedEmojisBySkinTone	(	std::string &	emojis,
		HandSkinTone	skinTone
	)

pure virtual

Get supported emojis by skin tone.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out]	emojis	The emoji list, non-skinTone, default emoji, stored as a json style list.
[in]	skinTone	The skin tone, see HandSkinTone enum.

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

◆ GetSupportedEmojisForMeeting()

virtual ZRCSDKError IMeetingReactionEmojiHelper::GetSupportedEmojisForMeeting ( std::string & emojis )

pure virtual

Get supported emoji list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] emojis The emoji list, non-skinTone, default emoji, stored as a json style list.

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

◆ GetSupportedEmojiSkinsForMeeting()

virtual ZRCSDKError IMeetingReactionEmojiHelper::GetSupportedEmojiSkinsForMeeting ( std::string & emojiSkins )

pure virtual

Get supported emoji skins example.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Default emoji takes one single character unicode while emoji with skin tones takes two, first is the base emoji and the second is the skin tone unicode.

Parameters

[out] emojiSkins The supported emoji skin tone list, stored as a json style list.

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

◆ IsAnimatedReactionEnabled()

virtual ZRCSDKError IMeetingReactionEmojiHelper::IsAnimatedReactionEnabled ( bool & enabled )

pure virtual

Query if animated reaction enabled.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[out] enabled TRUE indicates animated reaction is enabled.

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

◆ IsReactionEmojiEnabled()

virtual ZRCSDKError IMeetingReactionEmojiHelper::IsReactionEmojiEnabled ( bool & enabled )

pure virtual

Query if reaction emoji enabled.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] enabled TRUE indicates reaction emoji is enabled.

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

◆ IsReactionFeedbackEnabled()

virtual ZRCSDKError IMeetingReactionEmojiHelper::IsReactionFeedbackEnabled ( bool & enabled )

pure virtual

Query if reaction feedback enabled.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] enabled TRUE indicates reaction feedback is enabled.

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

◆ RegisterSink()

virtual ZRCSDKError IMeetingReactionEmojiHelper::RegisterSink ( IMeetingReactionEmojiHelperSink * pSink )

pure virtual

Register meeting reaction emoji helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingReactionEmojiHelperSink that receives the meeting reaction emoji helper event callback.

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

◆ SendEmoji()

virtual ZRCSDKError IMeetingReactionEmojiHelper::SendEmoji ( const std::string & emoji )

pure virtual

Send emoji.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

emoji The emoji in unicode. Get the supported emoji list with GetSupportedEmojisForMeeting.

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

◆ SendReactionFeedback()

virtual ZRCSDKError IMeetingReactionEmojiHelper::SendReactionFeedback ( ReactionFeedback feedback )

pure virtual

Send reaction feedback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

feedback The reaction feedback, see ReactionFeedback.

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

◆ SendWebinarEmojiReaction()

virtual ZRCSDKError IMeetingReactionEmojiHelper::SendWebinarEmojiReaction ( WebinarEmojiReactionType type )

pure virtual

Send emoji reaction in webinar meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	Webinar reaction emoji type, see WebinarEmojiReactionType enum.

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

◆ ~IMeetingReactionEmojiHelper()

Member Function Documentation

◆ ChangeReactionIntensity()

◆ ChangeSkinTone()

◆ ClearAllFeedback()

◆ DeregisterSink()

◆ EnableReactionInWebinar()

◆ GetSupportedEmojisBySkinTone()

◆ GetSupportedEmojisForMeeting()

◆ GetSupportedEmojiSkinsForMeeting()

◆ IsAnimatedReactionEnabled()

◆ IsReactionEmojiEnabled()

◆ IsReactionFeedbackEnabled()

◆ RegisterSink()

◆ SendEmoji()

◆ SendReactionFeedback()

◆ SendWebinarEmojiReaction()