com.aliyun.svideosdk.common.struct.project

## Class SubTitleTrack

- java.lang.Object
- - com.aliyun.svideosdk.common.struct.project.Track
  - - com.aliyun.svideosdk.common.struct.project.PasterTrack
    - - com.aliyun.svideosdk.common.struct.project.PhotoPasterTrack
      - - com.aliyun.svideosdk.common.struct.project.SubTitleTrack

- Direct Known Subclasses:
    BubbleCaptionTrack

      public class SubTitleTrack
      extends PhotoPasterTrack

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class com.aliyun.svideosdk.common.struct.project.PasterTrack

      `PasterTrack.Type`

  - ### Field Summary

    - ### Fields inherited from class com.aliyun.svideosdk.common.struct.project.PhotoPasterTrack

      `mNodeKey`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SubTitleTrack()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Source` | `getBackgroundImgPath()` Gets the text background image.
    `Source` | `getFont()` Gets The path of the text font resource.
    `float` | `getPreBegin()` Gets The preset time when the text appears on the stream timeline.
    `float` | `getPreEnd()` Gets the preset time when the text disappears on the stream timeline.
    `java.lang.String` | `getText()` Gets the text contents.
    `int` | `getTextAlignment()` Gets the text alignment method.
    `int` | `getTextBackgroundColor()` Gets the text background color.
    `java.lang.String` | `getTextBmpPath()` Gets the path of the image generated from the view of the text
    `int` | `getTextColor()` Gets the text color.
    `float` | `getTextHeight()` Gets the height of the view that displays the text.
    `int` | `getTextMaxLines()` Sets the maximum number of text lines.
    `float` | `getTextPaddingX()` Gets the x coordinate of the text relative to the origin in the upper left corner.
    `float` | `getTextPaddingY()` Gets the y coordinate of the text relative to the origin in the upper left corner.
    `float` | `getTextRotation()` Gets the rotation angle of the text.
    `float` | `getTextSize()` Gets the text size.
    `int` | `getTextStrokeColor()` Gets the text stroke color.
    `float` | `getTextWidth()` Gets the width of the view that displays the text.
    `void` | `setBackgroundImgPath(Source backgroundImgPath)` Sets the text background image.
    `void` | `setFont(Source font)` Sets The path of the text font resource.
    `void` | `setPreBegin(float preBegin)`
    `void` | `setPreEnd(float preEnd)`
    `void` | `setText(java.lang.String text)` Sets the text contents.
    `void` | `setTextAlignment(int textAlignment)` Sets the text alignment method.
    `void` | `setTextBackgroundColor(int textBackgroundColor)` Sets the text background color.
    `void` | `setTextBmpPath(java.lang.String textBmpPath)` Sets the path of the image generated from the view of the text.
    `void` | `setTextColor(int textColor)` Sets the text color.
    `void` | `setTextHeight(float textHeight)` Sets the height of the view that displays the text.
    `void` | `setTextMaxLines(int textMaxLines)` Sets the maximum number of text lines.
    `void` | `setTextPaddingX(float textPaddingX)` Sets the x coordinate of the text relative to the origin in the upper left corner.
    `void` | `setTextPaddingY(float textPaddingY)` Sets the y coordinate of the text relative to the origin in the upper left corner.
    `void` | `setTextRotation(float textRotation)` Sets the rotation angle of the text.
    `void` | `setTextSize(float textSize)` Sets the text size.
    `void` | `setTextStrokeColor(int textStrokeColor)` Sets the text stroke color.
    `void` | `setTextWidth(float textWidth)` Sets the width of the view that displays the text.

    - ### Methods inherited from class com.aliyun.svideosdk.common.struct.project.PhotoPasterTrack

      `getActions, getFrameArray, getHeight, getName, getNodeKey, getRotation, getSource, getTimeArray, getTimelineIn, getTimelineOut, getWidth, getX, getY, isMirror, setFrameArray, setHeight, setMirror, setName, setNodeKey, setRotation, setSource, setTimeArray, setTimelineIn, setTimelineOut, setWidth, setX, setY, toString`

    - ### Methods inherited from class com.aliyun.svideosdk.common.struct.project.PasterTrack

      `getType, setType`

    - ### Methods inherited from class com.aliyun.svideosdk.common.struct.project.Track

      `getId, setId`

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

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

- - ### Constructor Detail

    - #### SubTitleTrack

          public SubTitleTrack()

  - ### Method Detail

    - #### getText

          public java.lang.String getText()

      Gets the text contents.
      Returns:
        text contents

    - #### setText

          public void setText(java.lang.String text)

      Sets the text contents.
      Parameters:
        `text` - text contents

    - #### getTextColor

          public int getTextColor()

      Gets the text color.
      Returns:
        text color

    - #### setTextColor

          public void setTextColor(int textColor)

      Sets the text color.
      Parameters:
        `textColor` - text color

    - #### getTextStrokeColor

          public int getTextStrokeColor()

      Gets the text stroke color.
      Returns:
        text stroke color

    - #### setTextStrokeColor

          public void setTextStrokeColor(int textStrokeColor)

      Sets the text stroke color.
      Parameters:
        `textStrokeColor` - text stroke color

    - #### getFont

          public Source getFont()

      Gets The path of the text font resource.
      Returns:
        font resource

    - #### setFont

          public void setFont(Source font)

      Sets The path of the text font resource.
      Parameters:
        `font` - font resource

    - #### getTextBmpPath

          public java.lang.String getTextBmpPath()

      Gets the path of the image generated from the view of the text
      Returns:
        text image path

    - #### setTextBmpPath

          public void setTextBmpPath(java.lang.String textBmpPath)

      Sets the path of the image generated from the view of the text.
      Parameters:
        `textBmpPath` - text image path

    - #### getTextWidth

          public float getTextWidth()

      Gets the width of the view that displays the text.
      Returns:
        text width

    - #### setTextWidth

          public void setTextWidth(float textWidth)

      Sets the width of the view that displays the text.
      Parameters:
        `textWidth` - text width

    - #### getTextHeight

          public float getTextHeight()

      Gets the height of the view that displays the text.
      Returns:
        text height

    - #### setTextHeight

          public void setTextHeight(float textHeight)

      Sets the height of the view that displays the text.
      Parameters:
        `textHeight` - text height

    - #### getTextBackgroundColor

          public int getTextBackgroundColor()

      Gets the text background color.
      Returns:
        text background color

    - #### setTextBackgroundColor

          public void setTextBackgroundColor(int textBackgroundColor)

      Sets the text background color.
      Parameters:
        `textBackgroundColor` - text background color

    - #### getBackgroundImgPath

          public Source getBackgroundImgPath()

      Gets the text background image.
      Returns:
        background image

    - #### setBackgroundImgPath

          public void setBackgroundImgPath(Source backgroundImgPath)

      Sets the text background image.
      Parameters:
        `backgroundImgPath` - background image

    - #### getTextSize

          public float getTextSize()

      Gets the text size.
      Returns:
        text size

    - #### setTextSize

          public void setTextSize(float textSize)

      Sets the text size.
      Parameters:
        `textSize` - text size

    - #### getTextPaddingX

          public float getTextPaddingX()

      Gets the x coordinate of the text relative to the origin in the upper left corner.
      Returns:
        x coordinate

    - #### setTextPaddingX

          public void setTextPaddingX(float textPaddingX)

      Sets the x coordinate of the text relative to the origin in the upper left corner.
      Parameters:
        `textPaddingX` - x coordinate

    - #### getTextPaddingY

          public float getTextPaddingY()

      Gets the y coordinate of the text relative to the origin in the upper left corner.
      Returns:
        y coordinate

    - #### setTextPaddingY

          public void setTextPaddingY(float textPaddingY)

      Sets the y coordinate of the text relative to the origin in the upper left corner.
      Parameters:
        `textPaddingY` - y coordinate

    - #### getTextAlignment

          public int getTextAlignment()

      Gets the text alignment method.
      Returns:
        text alignment

    - #### setTextAlignment

          public void setTextAlignment(int textAlignment)

      Sets the text alignment method.
      Parameters:
        `textAlignment` - text alignment

    - #### getTextMaxLines

          public int getTextMaxLines()

      Sets the maximum number of text lines.
      Returns:
        max line

    - #### setTextMaxLines

          public void setTextMaxLines(int textMaxLines)

      Sets the maximum number of text lines.
      Parameters:
        `textMaxLines` - max line

    - #### getTextRotation

          public float getTextRotation()

      Gets the rotation angle of the text.
      Returns:
        otation angle

    - #### setTextRotation

          public void setTextRotation(float textRotation)

      Sets the rotation angle of the text.
      Parameters:
        `textRotation` - rotation angle

    - #### getPreBegin

          public float getPreBegin()

      Gets The preset time when the text appears on the stream timeline. This setting is configured in the configuration file.
      Returns:
        time

    - #### setPreBegin

          public void setPreBegin(float preBegin)

    - #### getPreEnd

          public float getPreEnd()

      Gets the preset time when the text disappears on the stream timeline. This setting is configured in the configuration file.
      Returns:
        time

    - #### setPreEnd

          public void setPreEnd(float preEnd)