| Package | com.adobe.mediacore |
| Class | public class ClosedCaptionStyles |
| Inheritance | ClosedCaptionStyles  Object |
| Property | Defined By | ||
|---|---|---|---|
| backgroundColor : int [read-only]
The index of the background color used for closed captions rendering. | ClosedCaptionStyles | ||
| backgroundOpacity : String [read-only]
The background opacity used for closed captions rendering. | ClosedCaptionStyles | ||
| edgeColor : int [read-only]
The index of the edge color used for closed captions rendering. | ClosedCaptionStyles | ||
| fillColor : int [read-only]
The index of the fill color used for closed captions rendering. | ClosedCaptionStyles | ||
| fillOpacity : String [read-only]
The fill opacity used for closed captions rendering. | ClosedCaptionStyles | ||
| font : int [read-only]
The index of the font used for closed captions rendering. | ClosedCaptionStyles | ||
| fontColor : int [read-only]
The index of the font color used for closed captions rendering. | ClosedCaptionStyles | ||
| fontEdge : int [read-only]
The index of the font edge used for closed captions rendering. | ClosedCaptionStyles | ||
| fontOpacity : String [read-only]
The font opacity used for closed captions rendering. | ClosedCaptionStyles | ||
| size : int [read-only]
The index of the font size used for closed captions rendering. | ClosedCaptionStyles | ||
| Method | Defined By | ||
|---|---|---|---|
ClosedCaptionStyles(font:Number, fontColor:Number, edgeColor:Number, fontEdge:Number, backgroundColor:Number, fillColor:Number, size:Number, fontOpacity:String, backgroundOpacity:String, fillOpacity:String)
Default constructor. | ClosedCaptionStyles | ||
isEqual(other:ClosedCaptionStyles):Boolean
Checks if two closed caption styles are equal. | ClosedCaptionStyles | ||
| Constant | Defined By | ||
|---|---|---|---|
| COLOR : Array [static]
23 font color choices
| ClosedCaptionStyles | ||
| FONT : Array [static]
8 font choices
| ClosedCaptionStyles | ||
| FONT_EDGE : Array [static]
7 font edge choices
| ClosedCaptionStyles | ||
| FONT_SIZE : Array [static]
4 size values
| ClosedCaptionStyles | ||
| backgroundColor | property |
backgroundColor:int [read-only] The index of the background color used for closed captions rendering. The index must be within the bounds of the public COLOR array.
public function get backgroundColor():int| backgroundOpacity | property |
backgroundOpacity:String [read-only] The background opacity used for closed captions rendering. The value must be "default" or a string which can be converted to a number between 0 and 100.
public function get backgroundOpacity():String| edgeColor | property |
edgeColor:int [read-only] The index of the edge color used for closed captions rendering. The index must be within the bounds of the public COLOR array.
public function get edgeColor():int| fillColor | property |
fillColor:int [read-only] The index of the fill color used for closed captions rendering. The index must be within the bounds of the public COLOR array.
public function get fillColor():int| fillOpacity | property |
fillOpacity:String [read-only] The fill opacity used for closed captions rendering. The value must be "default" or a string which can be converted to a number between 0 and 100.
public function get fillOpacity():String| font | property |
font:int [read-only] The index of the font used for closed captions rendering. The index must be within the bounds of the public FONT array.
public function get font():int| fontColor | property |
fontColor:int [read-only] The index of the font color used for closed captions rendering. The index must be within the bounds of the public COLOR array.
public function get fontColor():int| fontEdge | property |
fontEdge:int [read-only] The index of the font edge used for closed captions rendering. The index must be within the bounds of the public FONT_EDGE array.
public function get fontEdge():int| fontOpacity | property |
fontOpacity:String [read-only] The font opacity used for closed captions rendering. The value must be "default" or a string which can be converted to a number between 0 and 100.
public function get fontOpacity():String| size | property |
size:int [read-only] The index of the font size used for closed captions rendering. The index must be within the bounds of the public FONT_SIZE array.
public function get size():int| ClosedCaptionStyles | () | Constructor |
public function ClosedCaptionStyles(font:Number, fontColor:Number, edgeColor:Number, fontEdge:Number, backgroundColor:Number, fillColor:Number, size:Number, fontOpacity:String, backgroundOpacity:String, fillOpacity:String)Default constructor.
Parametersfont:Number — font style expressed as an index in FONT array
| |
fontColor:Number — font color style expressed as an index in COLOR array
| |
edgeColor:Number — edge color style expressed as an index in COLOR array
| |
fontEdge:Number — font edge style expressed as an index in FONT_EDGE array
| |
backgroundColor:Number — font background color style expressed as an index in COLOR array
| |
fillColor:Number — fill color style expressed as an index in COLOR array
| |
size:Number — font size style expressed as an index in FONT_SIZE array
| |
fontOpacity:String — font opacity style expressed as an String that is either 'default', or can be converted to a number from 0-100
| |
backgroundOpacity:String — background opacity style expressed as an String that is either 'default', or can be converted to a number from 0-100
| |
fillOpacity:String — fill opacity style expressed as an String that is either 'default', or can be converted to a number from 0-100
|
| isEqual | () | method |
public function isEqual(other:ClosedCaptionStyles):BooleanChecks if two closed caption styles are equal.
Parameters
other:ClosedCaptionStyles — the closed caption style to be compared.
|
Boolean — true if are equal, false otherwise.
|
| COLOR | Constant |
public static const COLOR:Array23 font color choices
| FONT | Constant |
public static const FONT:Array8 font choices
| FONT_EDGE | Constant |
public static const FONT_EDGE:Array7 font edge choices
| FONT_SIZE | Constant |
public static const FONT_SIZE:Array4 size values