Packagecom.adobe.mediacore
Classpublic final class ClosedCaptionStylesBuilder
InheritanceClosedCaptionStylesBuilder Inheritance Object

Helper class used for creating valid ClosedCaptionStyle instances. This allow setting each CC control parameter individually.



Public Properties
 PropertyDefined By
  backgroundColor : int
The index of the background color used for closed captions rendering.
ClosedCaptionStylesBuilder
  backgroundOpacity : String
The background opacity used for closed captions rendering.
ClosedCaptionStylesBuilder
  edgeColor : int
The index of the color used for closed caption edge rendering.
ClosedCaptionStylesBuilder
  fillColor : int
The index of the fill color used for closed captions rendering.
ClosedCaptionStylesBuilder
  fillOpacity : String
The fill opacity used for closed captions rendering.
ClosedCaptionStylesBuilder
  font : int
The index of the font used for closed captions rendering.
ClosedCaptionStylesBuilder
  fontColor : int
The index of the font color used for closed captions rendering.
ClosedCaptionStylesBuilder
  fontEdge : int
The index of the closed captions edge.
ClosedCaptionStylesBuilder
  fontOpacity : String
The font opacity used for closed captions rendering.
ClosedCaptionStylesBuilder
  size : int
The index of the font size used for closed captions rendering.
ClosedCaptionStylesBuilder
Public Methods
 MethodDefined By
  
Default constructor.
ClosedCaptionStylesBuilder
  
Builder method for an ClosedCaptionStyle instance.
ClosedCaptionStylesBuilder
Property Detail
backgroundColorproperty
backgroundColor:int

The index of the background color used for closed captions rendering. The index must be within the bounds of the public COLOR property.


Implementation
    public function get backgroundColor():int
    public function set backgroundColor(value:int):void
backgroundOpacityproperty 
backgroundOpacity:String

The background opacity used for closed captions rendering.


Implementation
    public function get backgroundOpacity():String
    public function set backgroundOpacity(value:String):void
edgeColorproperty 
edgeColor:int

The index of the color used for closed caption edge rendering. The index must be within the bounds of the public COLOR array.


Implementation
    public function get edgeColor():int
    public function set edgeColor(value:int):void
fillColorproperty 
fillColor:int

The index of the fill color used for closed captions rendering. The index must be within the bounds of public COLOR property.


Implementation
    public function get fillColor():int
    public function set fillColor(value:int):void
fillOpacityproperty 
fillOpacity:String

The fill opacity used for closed captions rendering.


Implementation
    public function get fillOpacity():String
    public function set fillOpacity(value:String):void
fontproperty 
font:int

The index of the font used for closed captions rendering. The index must be within the bounds of the public FONT array.


Implementation
    public function get font():int
    public function set font(value:int):void
fontColorproperty 
fontColor:int

The index of the font color used for closed captions rendering. The index must be within the bounds of the public COLOR array.


Implementation
    public function get fontColor():int
    public function set fontColor(value:int):void
fontEdgeproperty 
fontEdge:int

The index of the closed captions edge. The index must be within the bounds of the public EDGE array.


Implementation
    public function get fontEdge():int
    public function set fontEdge(value:int):void
fontOpacityproperty 
fontOpacity:String

The font opacity used for closed captions rendering.


Implementation
    public function get fontOpacity():String
    public function set fontOpacity(value:String):void
sizeproperty 
size:int

The index of the font size used for closed captions rendering. The index must be within the bounds of the FONT_SIZE property.


Implementation
    public function get size():int
    public function set size(value:int):void
Constructor Detail
ClosedCaptionStylesBuilder()Constructor
public function ClosedCaptionStylesBuilder()

Default constructor.

Method Detail
toClosedCaptionStyles()method
public function toClosedCaptionStyles():ClosedCaptionStyles

Builder method for an ClosedCaptionStyle instance.

Returns
ClosedCaptionStyles — a valid ClosedCaptionStyle instance.