Packagecom.akamai.net.f4f.hds
Classpublic class CaptionUtils
InheritanceCaptionUtils Inheritance Object


Public Methods
 MethodDefined By
  
CaptionUtils()
CaptionUtils
  
captionFormatForDFXPCaption(caption:Caption = null, index:int = -1):CaptionFormat
[static] Returns the CaptionFormat object for a DFXP CaptionElement.
CaptionUtils
  
textFormatForDFXPCaption(caption:Caption = null, formatIndex:int = -1):TextFormat
[static] Returns the TextFormat object for the caption text of a DFXP CaptionElement.
CaptionUtils
  
textFormatForSMPTETTCaption(element:CaptionElement):TextFormat
[static] Returns the TextFormat object for the caption text of a SMPTETT CaptionElement.
CaptionUtils
  
textForSMPTETTCaption(element:CaptionElement):String
[static] Retrieves the text from a SMPTETT CaptionElement.
CaptionUtils
Constructor Detail
CaptionUtils()Constructor
public function CaptionUtils()



Method Detail
captionFormatForDFXPCaption()method
public static function captionFormatForDFXPCaption(caption:Caption = null, index:int = -1):CaptionFormat

Returns the CaptionFormat object for a DFXP CaptionElement. If null, it creates a new format with a default CaptionStyle at that index.

Parameters

caption:Caption (default = null)
 
index:int (default = -1)

Returns
CaptionFormat
textFormatForDFXPCaption()method 
public static function textFormatForDFXPCaption(caption:Caption = null, formatIndex:int = -1):TextFormat

Returns the TextFormat object for the caption text of a DFXP CaptionElement.

Parameters

caption:Caption (default = null)
 
formatIndex:int (default = -1)

Returns
TextFormat
textFormatForSMPTETTCaption()method 
public static function textFormatForSMPTETTCaption(element:CaptionElement):TextFormat

Returns the TextFormat object for the caption text of a SMPTETT CaptionElement.

Parameters

element:CaptionElement

Returns
TextFormat
textForSMPTETTCaption()method 
public static function textForSMPTETTCaption(element:CaptionElement):String

Retrieves the text from a SMPTETT CaptionElement. Checks for two types of sub-elements. TimedTextElementType.Text and TimedTextElementType.SupParagraphGroupElement

Parameters

element:CaptionElement

Returns
String



Generated by Flexmojos

Fri May 6 2016, 10:06 AM +05:30