Package io.agora.rtc2
Interface IVideoEffectObject
public interface IVideoEffectObject
- Since:
- v4.6.0
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumstatic enum -
Method Summary
Modifier and TypeMethodDescriptionintaddOrUpdateVideoEffect(int nodeId, String templateName) booleangetVideoEffectBoolParam(String option, String key) floatgetVideoEffectFloatParam(String option, String key) intgetVideoEffectIntParam(String option, String key) intperformVideoEffectAction(int nodeId, IVideoEffectObject.VIDEO_EFFECT_ACTION actionId) intremoveVideoEffect(int nodeId) intsetVideoEffectBoolParam(String option, String key, boolean value) intsetVideoEffectFloatParam(String option, String key, float value) intsetVideoEffectIntParam(String option, String key, int value)
-
Method Details
-
addOrUpdateVideoEffect
- Parameters:
nodeId- The unique identifier or combination of video effect nodes. See VIDEO_EFFECT_NODE_ID. Example: - Single effect: VIDEO_EFFECT_NODE_ID.BEAUTY - Combined effects: VIDEO_EFFECT_NODE_ID.BEAUTY | VIDEO_EFFECT_NODE_ID.STYLE_MAKEUPtemplateName- The name of the effect template. If set to null or empty string, the SDK loads the default parameter configuration from the resource bundle.- Since:
- v4.6.0
-
removeVideoEffect
int removeVideoEffect(int nodeId) - Parameters:
nodeId- The unique identifier of the video effect node to remove. See VIDEO_EFFECT_NODE_ID.- Returns:
- - 0: Success - <0: Failure
- Since:
- v4.6.0
-
performVideoEffectAction
- Parameters:
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.- Returns:
- - 0: Success - <0: Failure
- Since:
- v4.6.0
-
setVideoEffectFloatParam
- Parameters:
option- The category identifier of the parameter.key- The key name of the parameter.value- The float value to set.- Returns:
- - 0: Success - <0: Failure
- Since:
- v4.6.0
-
setVideoEffectIntParam
- Parameters:
option- The category identifier of the parameter.key- The key name of the parameter.value- The integer value to set.- Returns:
- - 0: Success - <0: Failure
- Since:
- v4.6.0
-
setVideoEffectBoolParam
- Parameters:
option- The category identifier of the parameter.key- The key name of the parameter.value- The boolean value to set.- Returns:
- - 0: Success - <0: Failure
- Since:
- v4.6.0
-
getVideoEffectFloatParam
- Parameters:
option- The category identifier of the parameter.key- The key name of the parameter.- Returns:
- The current parameter value or 0.0f on failure.
- Since:
- v4.6.0
-
getVideoEffectIntParam
- Parameters:
option- The category identifier of the parameter.key- The key name of the parameter.- Returns:
- The current parameter value or 0 on failure.
- Since:
- v4.6.0
-
getVideoEffectBoolParam
- Parameters:
option- The category identifier of the parameter.key- The key name of the parameter.- Returns:
- The current parameter value or false on failure.
- Since:
- v4.6.0
-