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 identifiers for the video effect node. See `VIDEO_EFFECT_NODE_ID`.
      templateName - The name of the effect template. If set to null or an empty string, the SDK loads the default parameter configuration from the resource package.
      Returns:
      - 0: Success. - < 0: Failure. See the error codes in `AgoraBaseConstants`.
      Since:
      v4.6.0

    • removeVideoEffect

      int removeVideoEffect(int nodeId)
      Parameters:
      nodeId - The unique identifier of the video effect node to remove.
      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.
      actionId - The action to perform on the video effect node. 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 identifier of the parameter category.
      key - The key name of the parameter.
      value - The float parameter value to set.
      Returns:
      - 0: Success. - < 0: Failure.
      Since:
      v4.6.0

    • setVideoEffectIntParam

      int setVideoEffectIntParam(String option, String key, int value)
      Parameters:
      option - The identifier of the parameter category.
      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 identifier of the parameter category.
      key - The key name of the parameter.
      value - The boolean value to set. - `true`: Set to enabled. - `false`: Set to disabled.
      Returns:
      - 0: Success. - < 0: Failure.
      Since:
      v4.6.0

    • getVideoEffectFloatParam

      float getVideoEffectFloatParam(String option, String key)
      Parameters:
      option - The identifier of the parameter category.
      key - The key name of the parameter.
      Returns:
      - If the method call succeeds, returns the current float value. - If the method call fails, returns 0.0f.
      Since:
      v4.6.0

    • getVideoEffectIntParam

      int getVideoEffectIntParam(String option, String key)
      Parameters:
      option - The identifier of the parameter category.
      key - The key name of the parameter.
      Returns:
      - If the method call succeeds, returns the current parameter value. - If the method call fails, returns 0.
      Since:
      v4.6.0

    • getVideoEffectBoolParam

      boolean getVideoEffectBoolParam(String option, String key)
      Parameters:
      option - The identifier of the parameter category.
      key - The key name of the parameter.
      Returns:
      - `true`: The parameter is enabled. - `false`: The parameter is not enabled or does not exist.
      Since:
      v4.6.0