Constructor Detail

Method Detail

• anchorPoint

   final Optional<OverlayPosition.AnchorPoint> anchorPoint()

  Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is top_left. Maps to lap in the URL. Can only be used with one or more of x, y, xCenter, or yCenter.

• focus

   final Optional<OverlayPosition.Focus> focus()

  Specifies the position of the overlay relative to the parent image or video. If one or more of x, y, xCenter, or yCenter parameters are specified, this parameter is ignored. Maps to lfo in the URL.

• x

   final Optional<OverlayPosition.X> x()

  Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as bw_mul_0.4 or bw_sub_cw. Maps to lx in the URL. Learn about Arithmetic expressions.

• xCenter

   final Optional<OverlayPosition.XCenter> xCenter()

  Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as bw_mul_0.4 or bw_sub_cw. Maps to lxc in the URL. Cannot be used together with x, but can be used with y. Learn about Arithmetic expressions.

• y

   final Optional<OverlayPosition.Y> y()

  Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as bh_mul_0.4 or bh_sub_ch. Maps to ly in the URL. Learn about Arithmetic expressions.

• yCenter

   final Optional<OverlayPosition.YCenter> yCenter()

  Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as bh_mul_0.4 or bh_sub_ch. Maps to lyc in the URL. Cannot be used together with y, but can be used with x. Learn about Arithmetic expressions.

• _anchorPoint

   final JsonField<OverlayPosition.AnchorPoint> _anchorPoint()

  Returns the raw JSON value of anchorPoint.

  Unlike anchorPoint, this method doesn't throw if the JSON field has an unexpected type.

• _focus

   final JsonField<OverlayPosition.Focus> _focus()

  Returns the raw JSON value of focus.

  Unlike focus, this method doesn't throw if the JSON field has an unexpected type.

• _x

   final JsonField<OverlayPosition.X> _x()

  Returns the raw JSON value of x.

  Unlike x, this method doesn't throw if the JSON field has an unexpected type.

• _xCenter

   final JsonField<OverlayPosition.XCenter> _xCenter()

  Returns the raw JSON value of xCenter.

  Unlike xCenter, this method doesn't throw if the JSON field has an unexpected type.

• _y

   final JsonField<OverlayPosition.Y> _y()

  Returns the raw JSON value of y.

  Unlike y, this method doesn't throw if the JSON field has an unexpected type.

• _yCenter

   final JsonField<OverlayPosition.YCenter> _yCenter()

  Returns the raw JSON value of yCenter.

  Unlike yCenter, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final OverlayPosition.Builder toBuilder()

• validate

   final OverlayPosition validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static OverlayPosition.Builder builder()

  Returns a mutable builder for constructing an instance of OverlayPosition.