Constructor Detail

Method Detail

• setFontColor

  @MainThread() abstract void setFontColor(@ColorInt() int color)

  Sets the text font color.

  Parameters:

  color - - font color

• getFontColor

  @MainThread()@ColorInt() abstract int getFontColor()

  Returns the current text font color.

  Returns:

  font color

• setBackgroundColor

  @MainThread() abstract void setBackgroundColor(@ColorInt() int color)

  Sets the background color.

  Parameters:

  color - - background color

• getBackgroundColor

  @MainThread()@ColorInt() abstract int getBackgroundColor()

  Returns the current background color.

  Returns:

  background color

• setWindowColor

  @MainThread() abstract void setWindowColor(@ColorInt() int color)

  Sets the window color.

  Parameters:

  color - - window color

• getWindowColor

  @MainThread()@ColorInt() abstract int getWindowColor()

  Returns the current window color.

  Returns:

  window color

• setEdgeColor

  @MainThread() abstract void setEdgeColor(@ColorInt() int color)

  Sets the edge color.

  Parameters:

  color - - edge color

• getEdgeColor

  @MainThread()@ColorInt() abstract int getEdgeColor()

  Returns the current edge color.

  Returns:

  edge color

• setEdgeType

  @MainThread() abstract void setEdgeType(@NonNull() TextTrackStyle.EdgeType type)

  Sets the edge type.

  Parameters:

  type - - edge type

• getEdgeType

  @MainThread()@NonNull() abstract TextTrackStyle.EdgeType getEdgeType()

  Returns the current edge type.

  Returns:

  edge type

• setFont

  @MainThread() abstract void setFont(@Nullable() Typeface font)

  Sets the font.

  Parameters:

  font - - font

• setFont

  @MainThread() abstract void setFont(@Nullable() TextTrackStyle.FontFamily fontFamily, @NonNull() TextTrackStyle.FontStyle fontStyle)

  Sets the font family and font style.

  This is equivalent to calling setFont with the result of create.

  Parameters:

  fontFamily - - font family value

  fontStyle - - font style value

• setFont

  @MainThread() abstract void setFont(@NonNull() String fontFile, @NonNull() TextTrackStyle.FontStyle fontStyle)

  Sets the font from the font file.

  This is equivalent to calling setFont with the result of createFromFile.

  Parameters:

  fontFile - - font file name

  fontStyle - - font style value

• getFont

  @MainThread()@Nullable() abstract Typeface getFont()

  Returns the current font.

  Returns:

  font

• getFontStyle

  @MainThread()@NonNull() abstract TextTrackStyle.FontStyle getFontStyle()

  Returns the current font style value.

  Returns:

  font style

• getFontFamily

  @MainThread()@Nullable() abstract TextTrackStyle.FontFamily getFontFamily()

  Returns the current font family value.

  Returns:

  font family

• getFontFile

  @MainThread()@Nullable() abstract String getFontFile()

  Returns the file name of the current font.

  Returns:

  file name of font

• setFontSize

  @MainThread() abstract void setFontSize(@IntRange(from = 50, to = 300) int fontSize)

  Sets the font size, as a percentage of the default font size.

  Parameters:

  fontSize - - font size, as a percentage between 50% - 300% of the default font size

• getFontSize

  @MainThread() abstract int getFontSize()

  Returns the current font size, as a percentage of the default font size.

  Returns:

  font size

• setMarginLeft

  @MainThread() abstract void setMarginLeft(@IntRange(from = 0, to = 100) int marginLeft)

  Sets the left margin of the subtitle drawing box, as a percentage of the player's width.

  Parameters:

  marginLeft - - left margin, as a percentage between 0% - 100% of the player's width

• setMarginRight

  @MainThread() abstract void setMarginRight(@IntRange(from = 0, to = 100) int marginRight)

  Sets the right margin of the subtitle drawing box, as a percentage of the player's width.

  Parameters:

  marginRight - - right margin, as a percentage between 0% - 100% of the player's width

• setMarginTop

  @MainThread() abstract void setMarginTop(@IntRange(from = 0, to = 100) int marginTop)

  Sets the top margin of the subtitle drawing box, as a percentage of the player's height.

  Parameters:

  marginTop - - top margin, as a percentage between 0% - 100% of the player's height

• setMarginBottom

  @MainThread() abstract void setMarginBottom(@IntRange(from = 0, to = 100) int marginBottom)

  Sets the bottom margin of the subtitle drawing box, as a percentage of the player's height.

  Parameters:

  marginBottom - - bottom margin, as a percentage between 0% - 100% of the player's height

• getMarginLeft

  @MainThread()@IntRange(from = 0, to = 100) abstract int getMarginLeft()

  Returns the left margin of the subtitle drawing box, as a percentage of the player's width.

  Returns:

  left margin

• getMarginRight

  @MainThread()@IntRange(from = 0, to = 100) abstract int getMarginRight()

  Returns the right margin of the subtitle drawing box, as a percentage of the player's width.

  Returns:

  right margin

• getMarginTop

  @MainThread()@IntRange(from = 0, to = 100) abstract int getMarginTop()

  Returns the top margin of the subtitle drawing box, as a percentage of the player's height.

  Returns:

  top margin

• getMarginBottom

  @MainThread()@IntRange(from = 0, to = 100) abstract int getMarginBottom()

  Returns the bottom margin of the subtitle drawing box, as a percentage of the player's height.

  Returns:

  bottom margin

• reset

  @MainThread() abstract void reset()

  Resets all properties to their default values.