Agora Java API Reference for Android
Public Types | Public Member Functions | List of all members
agora::rtc::IVideoEffectObject Class Referenceabstract

Provides methods to manage and configure video effects, such as beauty, style makeup, and filter. More...

#include <IAgoraRtcEngine.h>

Inheritance diagram for agora::rtc::IVideoEffectObject:
agora::RefCountInterface

Public Types

enum  VIDEO_EFFECT_NODE_ID : uint32_t { VIDEO_EFFECT_NODE_ID::BEAUTY = 1U << 0, VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP = 1U << 1, VIDEO_EFFECT_NODE_ID::FILTER = 1U << 2 }
 Types of video effect nodes that can be applied. More...
 
enum  VIDEO_EFFECT_ACTION { SAVE = 1, RESET = 2 }
 Actions that can be performed on video effect nodes. More...
 

Public Member Functions

virtual int addOrUpdateVideoEffect (uint32_t nodeId, const char *templateName)=0
 Adds or updates video effects with specified node ID and template. More...
 
virtual int removeVideoEffect (uint32_t nodeId)=0
 Removes a video effect with specified node ID. More...
 
virtual int performVideoEffectAction (uint32_t nodeId, VIDEO_EFFECT_ACTION actionId)=0
 Performs an action on a specified video effect node. More...
 
virtual int setVideoEffectFloatParam (const char *option, const char *key, float param)=0
 Sets a float parameter for the video effect. More...
 
virtual int setVideoEffectIntParam (const char *option, const char *key, int param)=0
 Sets an integer parameter for the video effect. More...
 
virtual int setVideoEffectBoolParam (const char *option, const char *key, bool param)=0
 Sets a boolean parameter for the video effect. More...
 
virtual float getVideoEffectFloatParam (const char *option, const char *key)=0
 Gets a float parameter from the video effect. More...
 
virtual int getVideoEffectIntParam (const char *option, const char *key)=0
 Gets an integer parameter from the video effect. More...
 
virtual bool getVideoEffectBoolParam (const char *option, const char *key)=0
 Gets a boolean parameter from the video effect. More...
 
- Public Member Functions inherited from agora::RefCountInterface
virtual void AddRef () const =0
 
virtual RefCountReleaseStatus Release () const =0
 
virtual bool HasOneRef () const =0
 

Detailed Description

Provides methods to manage and configure video effects, such as beauty, style makeup, and filter.

Since
v4.6.0

Member Enumeration Documentation

◆ VIDEO_EFFECT_NODE_ID

Types of video effect nodes that can be applied.

Since
v4.6.0
Enumerator
BEAUTY 

Beauty effect node.

STYLE_MAKEUP 

Style makeup effect node.

FILTER 

Filter effect node.

◆ VIDEO_EFFECT_ACTION

Actions that can be performed on video effect nodes.

Since
v4.6.0
Enumerator
SAVE 

Save the current parameters of the video effect.

RESET 

Reset the video effect to its default parameters.

Member Function Documentation

◆ addOrUpdateVideoEffect()

virtual int agora::rtc::IVideoEffectObject::addOrUpdateVideoEffect ( uint32_t  nodeId,
const char *  templateName 
)
pure virtual

Adds or updates video effects with specified node ID and template.

Since
v4.6.0
Parameters
nodeIdThe unique identifier or combination of video effect nodes. See VIDEO_EFFECT_NODE_ID Example:
Note
Priority Rules:
Parameters
templateNameThe name of the effect template. If set to null or an empty string, the SDK loads the default configuration from the resource bundle.
Returns
  • 0: Success.
  • < 0: Failure. The specific error code can provide more details about the failure.

◆ removeVideoEffect()

virtual int agora::rtc::IVideoEffectObject::removeVideoEffect ( uint32_t  nodeId)
pure virtual

Removes a video effect with specified node ID.

Since
v4.6.0
Parameters
nodeIdThe unique identifier of the video effect node to remove. See VIDEO_EFFECT_NODE_ID
Returns
  • 0: Success.
  • < 0: Failure.

◆ performVideoEffectAction()

virtual int agora::rtc::IVideoEffectObject::performVideoEffectAction ( uint32_t  nodeId,
VIDEO_EFFECT_ACTION  actionId 
)
pure virtual

Performs an action on a specified video effect node.

Since
v4.6.0
Parameters
nodeIdThe unique identifier of the video effect node. See VIDEO_EFFECT_NODE_ID
actionIdThe action to perform on the video effect. See VIDEO_EFFECT_ACTION
Returns
  • 0: Success.
  • < 0: Failure.

◆ setVideoEffectFloatParam()

virtual int agora::rtc::IVideoEffectObject::setVideoEffectFloatParam ( const char *  option,
const char *  key,
float  param 
)
pure virtual

Sets a float parameter for the video effect.

Since
v4.6.0
Parameters
optionThe option category of the parameter.
keyThe key name of the parameter.
paramThe float value to set.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setVideoEffectIntParam()

virtual int agora::rtc::IVideoEffectObject::setVideoEffectIntParam ( const char *  option,
const char *  key,
int  param 
)
pure virtual

Sets an integer parameter for the video effect.

Since
v4.6.0
Parameters
optionThe option category of the parameter.
keyThe key name of the parameter.
paramThe integer value to set.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setVideoEffectBoolParam()

virtual int agora::rtc::IVideoEffectObject::setVideoEffectBoolParam ( const char *  option,
const char *  key,
bool  param 
)
pure virtual

Sets a boolean parameter for the video effect.

Since
v4.6.0
Parameters
optionThe option category of the parameter.
keyThe key name of the parameter.
paramThe boolean value to set.
  • true: Enable the option.
  • false: Disable the option.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getVideoEffectFloatParam()

virtual float agora::rtc::IVideoEffectObject::getVideoEffectFloatParam ( const char *  option,
const char *  key 
)
pure virtual

Gets a float parameter from the video effect.

Since
v4.6.0
Parameters
optionThe option category of the parameter.
keyThe key name of the parameter.
Returns
  • The float value of the parameter if it exists.
  • 0.0f if the parameter does not exist or an error occurs.

◆ getVideoEffectIntParam()

virtual int agora::rtc::IVideoEffectObject::getVideoEffectIntParam ( const char *  option,
const char *  key 
)
pure virtual

Gets an integer parameter from the video effect.

Since
v4.6.0
Parameters
optionThe option category of the parameter.
keyThe key name of the parameter.
Returns
  • The integer value of the parameter if it exists.
  • 0 if the parameter does not exist or an error occurs.

◆ getVideoEffectBoolParam()

virtual bool agora::rtc::IVideoEffectObject::getVideoEffectBoolParam ( const char *  option,
const char *  key 
)
pure virtual

Gets a boolean parameter from the video effect.

Since
v4.6.0
Parameters
optionThe option category of the parameter.
keyThe key name of the parameter.
Returns
  • true: The parameter is enabled.
  • false: The parameter is disabled or does not exist.
agora::rtc::IVideoEffectObject::VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP
@ STYLE_MAKEUP
agora::rtc::IVideoEffectObject::VIDEO_EFFECT_NODE_ID::FILTER
@ FILTER
agora::rtc::IVideoEffectObject::addOrUpdateVideoEffect
virtual int addOrUpdateVideoEffect(uint32_t nodeId, const char *templateName)=0
Adds or updates video effects with specified node ID and template.
agora::rtc::IVideoEffectObject::removeVideoEffect
virtual int removeVideoEffect(uint32_t nodeId)=0
Removes a video effect with specified node ID.