Package io.agora.rtc2

Interface IVideoEffectObject


public interface IVideoEffectObject
Since:
v4.6.0
  • Method Details

    • addOrUpdateVideoEffect

      int addOrUpdateVideoEffect(int nodeId, String templateName)
      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_MAKEUP
      templateName - 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

      int performVideoEffectAction(int nodeId, IVideoEffectObject.VIDEO_EFFECT_ACTION actionId)
      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

      int setVideoEffectFloatParam(String option, String key, float value)
      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

      int setVideoEffectIntParam(String option, String key, int value)
      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

      int setVideoEffectBoolParam(String option, String key, boolean value)
      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

      float getVideoEffectFloatParam(String option, String key)
      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

      int getVideoEffectIntParam(String option, String key)
      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

      boolean getVideoEffectBoolParam(String option, String key)
      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