|
Agora Java API Reference for Android
|
Provides methods to manage and configure video effects, such as beauty, style makeup, and filter. More...
#include <IAgoraRtcEngine.h>
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 |
Provides methods to manage and configure video effects, such as beauty, style makeup, and filter.
|
strong |
|
pure virtual |
Adds or updates video effects with specified node ID and template.
| nodeId | The unique identifier or combination of video effect nodes. See VIDEO_EFFECT_NODE_ID Example:
|
STYLE_MAKEUP node takes precedence over FILTER parameters.FILTER parameters, first remove the STYLE_MAKEUP node: | templateName | The name of the effect template. If set to null or an empty string, the SDK loads the default configuration from the resource bundle. |
|
pure virtual |
Removes a video effect with specified node ID.
| nodeId | The unique identifier of the video effect node to remove. See VIDEO_EFFECT_NODE_ID |
|
pure virtual |
Performs an action on a specified video effect node.
| nodeId | The unique identifier of the video effect node. See VIDEO_EFFECT_NODE_ID |
| actionId | The action to perform on the video effect. See VIDEO_EFFECT_ACTION |
|
pure virtual |
Sets a float parameter for the video effect.
| option | The option category of the parameter. |
| key | The key name of the parameter. |
| param | The float value to set. |
|
pure virtual |
Sets an integer parameter for the video effect.
| option | The option category of the parameter. |
| key | The key name of the parameter. |
| param | The integer value to set. |
|
pure virtual |
Sets a boolean parameter for the video effect.
| option | The option category of the parameter. |
| key | The key name of the parameter. |
| param | The boolean value to set.
|
|
pure virtual |
Gets a float parameter from the video effect.
| option | The option category of the parameter. |
| key | The key name of the parameter. |
|
pure virtual |
Gets an integer parameter from the video effect.
| option | The option category of the parameter. |
| key | The key name of the parameter. |
|
pure virtual |
Gets a boolean parameter from the video effect.
| option | The option category of the parameter. |
| key | The key name of the parameter. |
1.8.18