com.adobe.mediacore
Interface TextFormat


public interface TextFormat

The TextFormat class is used to encapsulate different attributes describing a text style (for example the closed captions style).


Nested Class Summary
static class TextFormat.Color
          The Color enum is used encapsulate the accepted colors for the different TextFormat attributes, such as the text color, the background color or the fill color.
static class TextFormat.Font
          The Font enum is used to provide a text font.
static class TextFormat.FontEdge
          This enum is used to specify the desired font edge.
static class TextFormat.Size
          The Size enum is used to provide a value for the font size.
 
Field Summary
static int DEFAULT_OPACITY
           
 
Method Summary
 TextFormat.Color getBackgroundColor()
           
 int getBackgroundOpacity()
           
 TextFormat.Color getEdgeColor()
           
 TextFormat.Color getFillColor()
           
 int getFillOpacity()
           
 TextFormat.Font getFont()
           
 TextFormat.Color getFontColor()
           
 TextFormat.FontEdge getFontEdge()
           
 int getFontOpacity()
           
 TextFormat.Size getSize()
           
 

Field Detail

DEFAULT_OPACITY

static final int DEFAULT_OPACITY
See Also:
Constant Field Values
Method Detail

getFontColor

TextFormat.Color getFontColor()
Returns:
the font color.

getBackgroundColor

TextFormat.Color getBackgroundColor()
Returns:
the color behind the text.

getFillColor

TextFormat.Color getFillColor()
Returns:
the fill color.

getEdgeColor

TextFormat.Color getEdgeColor()
Returns:
the color used to draw the text edges.

getSize

TextFormat.Size getSize()
Returns:
the text size.

getFontEdge

TextFormat.FontEdge getFontEdge()
Returns:
the font edge.

getFont

TextFormat.Font getFont()
Returns:
the text font.

getFontOpacity

int getFontOpacity()
Returns:
The text opacity. This value can be from 0 to 100 or DEFAULT_OPACITY. Expressed as a percentage, with 100 being fully opaque and 0 being fully transparent.

getBackgroundOpacity

int getBackgroundOpacity()
Returns:
the background opacity. This value can be from 0 to 100 or DEFAULT_OPACITY. Expressed as a percentage, with 100 being fully opaque and 0 being fully transparent.

getFillOpacity

int getFillOpacity()
Returns:
the fill opacity. This value can be from 0 to 100 or DEFAULT_OPACITY. Expressed as a percentage, with 100 being fully opaque and 0 being fully transparent.