Closed caption styling options

The PSDK allows you to specify several caption styling options. These settings override any style options in the original captions.

Format Description
Font

The font type. Can be set to values such as monospaced_with_serifs, cursive, and others. The value default refers to whatever font the caption originally specified. Valid values are defined by the TextFormat.Font enumeration.

Note that the specific fonts that are actually available on any particular device may vary. Substitutions are used when necessary. The MONOSPACED_WITH_SERIFS is typically the font that is used as a substitute; however, this, too, can be system specific.

Size

The caption's size. Valid values are defined by the TextFormat.Size enumeration.

Meanings are:
  • MEDIUM - The standard size
  • LARGE - Approximately 30% larger than medium
  • SMALL - Approximately 30% smaller than medium
  • DEFAULT - The default size for the caption; the same as medium
Font edge The effect used for the font edge, such as raised or none. Valid values are defined by the TextFormat.FontEdge enumeration.
Font color The font’s color. Can be set to any one of a wide variety of values, such as BLACK, RED, or DARK_CYAN. The value DEFAULT refers to whatever color the caption originally specified. Valid values are defined by the TextFormat.Color enumeration.
Edge color The color of the edge effect. Can be set to any of the values defined for the font color.
Background color The background character cell color. Can be set to any of the values defined for the font color.
Fill color The color of the background of the window that the text is in. Can be set to any of the values defined for the font color.
Font opacity The opacity of the text. Expressed as a percentage from 0 to 100 with 100 being fully opaque and 0 being fully transparent.
Background opacity The opacity of the background character cell. Expressed as a percentage from 0 to 100 with 100 being fully opaque and 0 being fully transparent.
Fill opacity The opacity of the background of the window that the text is in. Expressed as a percentage from 0 to 100 with 100 being fully opaque and 0 being fully transparent.