com.aliyun.svideosdk.common.struct.effect

## Class EffectText

- java.lang.Object
- - com.aliyun.svideosdk.common.struct.effect.EffectBase
  - - com.aliyun.svideosdk.common.struct.effect.EffectPaster
    - - com.aliyun.svideosdk.common.struct.effect.EffectText

- Direct Known Subclasses:
    EffectCaption

      public class EffectText
      extends EffectPaster

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `float` | `bitmapScale`
    `int` | `breakStrategy`
    `int` | `dTextColor` The text color specified in the configuration file.
    `int` | `dTextStrokeColor` The text stroke color specified in the configuration file.
    `java.lang.String` | `font` Deprecated.
    `Source` | `fontSource` The path of the text font.
    `boolean` | `hasLabel` Whether the text has a background.
    `boolean` | `hasStroke` Whether the text is stroked.
    `Bitmap` | `mBackgroundBmp` The text background image.
    `java.lang.String` | `mBackgroundBmpPath` The path of the text background image.
    `boolean` | `mIncludePad`
    `float` | `mSpacingAdd`
    `float` | `mSpacingMult`
    `Layout.Alignment` | `mTextAlignment` The text alignment method.
    `int` | `mTextMaxLines` The maximum number of text lines.
    `int` | `mTextPaddingX` The x coordinate of the text relative to the origin in the upper left corner.
    `int` | `mTextPaddingY` The y coordinate of the text relative to the origin in the upper left corner.
    `int` | `mTextSize` The text size.
    `boolean` | `needSaveBmp` Whether to save the text image.
    `java.lang.String` | `text` The text contents.
    `Layout.Alignment` | `textAlignment` The text alignment method.
    `java.lang.String` | `textBmpPath` The path of the image generated from the view of the text.
    `int` | `textColor` The text color.
    `int` | `textHeight` The height of the view that displays the text.
    `int` | `textLabelColor` The text background color.
    `int` | `textStrokeColor` The text stroke color.
    `int` | `textWidth` The width of the view that displays the text.
    `boolean` | `useLineSpacingFromFallbacks`

    - ### Fields inherited from class com.aliyun.svideosdk.common.struct.effect.EffectPaster

      `action, displayHeight, displayWidth, duration, end, frameArry, height, isTrack, kernelFrame, mirror, name, PASTER_TYPE_CAPTION, PASTER_TYPE_GIF, PASTER_TYPE_TEXT, rotation, start, timeArry, width, x, y`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `EffectText(Source source)`
    `EffectText(java.lang.String path)` Deprecated.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `copy(EffectBase base)` Gets a copy of the parameters of an object.
    `java.lang.String` | `generateTextFinger()`
    `java.lang.String` | `getFontPath()`
    `Source` | `getFontSource()`
    `int` | `getPasterType()`
    `java.lang.String` | `toString()`

    - ### Methods inherited from class com.aliyun.svideosdk.common.struct.effect.EffectPaster

      `equals, getHeightRatio, getWidthRatio, getXRatio, getYRatio, isPasterReady, setHeightRatio, setWidthRatio, setXRatio, setYRatio`

    - ### Methods inherited from class com.aliyun.svideosdk.common.struct.effect.EffectBase

      `getAnimationType, getPath, getResId, getSource, getViewId, readString, setAnimationType, setPath, setResId, setSource, setViewId`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### textAlignment

          public Layout.Alignment textAlignment

      The text alignment method.

    - #### text

          public java.lang.String text

      The text contents.

    - #### textBmpPath

          public java.lang.String textBmpPath

      The path of the image generated from the view of the text.

    - #### textWidth

          public int textWidth

      The width of the view that displays the text.

    - #### textHeight

          public int textHeight

      The height of the view that displays the text.

    - #### textColor

          public int textColor

      The text color.

    - #### dTextColor

          public int dTextColor

      The text color specified in the configuration file.

    - #### textStrokeColor

          public int textStrokeColor

      The text stroke color.

    - #### dTextStrokeColor

          public int dTextStrokeColor

      The text stroke color specified in the configuration file.

    - #### font

          @Deprecated
          public java.lang.String font

      Deprecated.
      The path of the text font.

    - #### fontSource

          public Source fontSource

      The path of the text font.

    - #### hasStroke

          public boolean hasStroke

      Whether the text is stroked.

    - #### hasLabel

          public boolean hasLabel

      Whether the text has a background.

    - #### textLabelColor

          public int textLabelColor

      The text background color.

    - #### mBackgroundBmp

          public Bitmap mBackgroundBmp

      The text background image.

    - #### mBackgroundBmpPath

          public java.lang.String mBackgroundBmpPath

      The path of the text background image.

    - #### mTextSize

          public int mTextSize

      The text size.

    - #### mTextPaddingX

          public int mTextPaddingX

      The x coordinate of the text relative to the origin in the upper left corner.

    - #### mTextPaddingY

          public int mTextPaddingY

      The y coordinate of the text relative to the origin in the upper left corner.

    - #### mTextAlignment

          public Layout.Alignment mTextAlignment

      The text alignment method.

    - #### needSaveBmp

          public boolean needSaveBmp

      Whether to save the text image.

    - #### mTextMaxLines

          public int mTextMaxLines

      The maximum number of text lines.

    - #### bitmapScale

          public float bitmapScale

    - #### breakStrategy

          public int breakStrategy

    - #### useLineSpacingFromFallbacks

          public boolean useLineSpacingFromFallbacks

    - #### mSpacingMult

          public float mSpacingMult

    - #### mSpacingAdd

          public float mSpacingAdd

    - #### mIncludePad

          public boolean mIncludePad

  - ### Constructor Detail

    - #### EffectText

          @Deprecated
          public EffectText(java.lang.String path)

      Deprecated.

    - #### EffectText

          public EffectText(Source source)

  - ### Method Detail

    - #### generateTextFinger

          public java.lang.String generateTextFinger()

    - #### getPasterType

          public int getPasterType()

      Overrides:
        `getPasterType` in class `EffectPaster`

    - #### getFontPath

          public java.lang.String getFontPath()

    - #### getFontSource

          public Source getFontSource()

    - #### copy

          public void copy(EffectBase base)

      Description copied from class: `EffectBase`
      Gets a copy of the parameters of an object.
      Overrides:
        `copy` in class `EffectPaster`

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `EffectPaster`