Packageorg.osmf.smpte.tt.parsing
Classpublic class SMPTETTParser
InheritanceSMPTETTParser Inheritance flash.events.EventDispatcher
Implements flash.events.IEventDispatcher, ISMPTETTParser
Subclasses SMPTETTParserAsync


Public Properties
 PropertyDefined By
  ASYNC_THREAD : AsyncThread
[static]
SMPTETTParser
  captionElements : Vector.<CaptionElement>
[read-only] Returns a vector of CaptionElements, one for each unique timeline event in the file.
SMPTETTParser
  captionRegionsHash : Dictionary
[read-only]
SMPTETTParser
  document : CaptioningDocument
[read-only]
SMPTETTParser
  endTime : TimeCode
SMPTETTParser
  m608 : Namespace
[static]
SMPTETTParser
  ns : Namespace
[static]
SMPTETTParser
  regionElementsHash : Dictionary
[read-only]
SMPTETTParser
  REMAINING_NODE_COUNT : uint
[static]
SMPTETTParser
  rootNamespace : Namespace
[static]
SMPTETTParser
  smpte : Namespace
[static]
SMPTETTParser
  startTime : TimeCode
SMPTETTParser
  ttElement : TtElement
[read-only]
SMPTETTParser
  ttm : Namespace
[static]
SMPTETTParser
  ttp : Namespace
[static]
SMPTETTParser
  tts : Namespace
[static]
SMPTETTParser
Protected Properties
 PropertyDefined By
  _captionElements : Vector.<CaptionElement>
SMPTETTParser
  _document : CaptioningDocument
SMPTETTParser
  parseTime : uint
SMPTETTParser
  remainingNodeCount : int
SMPTETTParser
Public Methods
 MethodDefined By
  
SMPTETTParser()
SMPTETTParser
  
parse(i_rawData:String):CaptioningDocument
SMPTETTParser
Protected Methods
 MethodDefined By
  
buildCaptions(timedTextElement:TimedTextElementBase, regionElementsHash:Dictionary, captionRegionsHash:Dictionary, timelineEventsHash:Dictionary):void
SMPTETTParser
  
buildRegions(document:TtElement):void
SMPTETTParser
  
createParseEventData(i_timedTextElement:TimedTextElementBase = null, i_regionElementsHash:Dictionary = null, i_captionRegionsHash:Dictionary = null, i_timelineEventsHash:Dictionary = null):ParseEventData
SMPTETTParser
  
mapToCaption(pElement:PElement, region:RegionElement):CaptionElement
SMPTETTParser
  
mapToCaptionRegion(regionElement:RegionElement):CaptionRegion
SMPTETTParser
Events
 Event Summary Defined By
  
begin
SMPTETTParser
  
complete
SMPTETTParser
  
progress
SMPTETTParser
Property Detail
_captionElementsproperty
protected var _captionElements:Vector.<CaptionElement>

_documentproperty 
protected var _document:CaptioningDocument

ASYNC_THREADproperty 
public static var ASYNC_THREAD:AsyncThread

captionElementsproperty 
captionElements:Vector.<CaptionElement>  [read-only]

Returns a vector of CaptionElements, one for each unique timeline event in the file.

Additional CaptionsElements that occur at the same TimelineMarker are stored in each CaptionElements siblings Vector.<CaptionElements>.


Implementation
    public function get captionElements():Vector.<CaptionElement>
captionRegionsHashproperty 
captionRegionsHash:Dictionary  [read-only]


Implementation
    public function get captionRegionsHash():Dictionary
documentproperty 
document:CaptioningDocument  [read-only]


Implementation
    public function get document():CaptioningDocument
endTimeproperty 
endTime:TimeCode


Implementation
    public function get endTime():TimeCode
    public function set endTime(value:TimeCode):void
m608property 
public static var m608:Namespace

nsproperty 
public static var ns:Namespace

parseTimeproperty 
protected var parseTime:uint

regionElementsHashproperty 
regionElementsHash:Dictionary  [read-only]


Implementation
    public function get regionElementsHash():Dictionary
REMAINING_NODE_COUNTproperty 
public static var REMAINING_NODE_COUNT:uint

remainingNodeCountproperty 
remainingNodeCount:int


Implementation
    protected function get remainingNodeCount():int
    protected function set remainingNodeCount(value:int):void
rootNamespaceproperty 
public static var rootNamespace:Namespace

smpteproperty 
public static var smpte:Namespace

startTimeproperty 
startTime:TimeCode


Implementation
    public function get startTime():TimeCode
    public function set startTime(value:TimeCode):void
ttElementproperty 
ttElement:TtElement  [read-only]


Implementation
    public function get ttElement():TtElement
ttmproperty 
public static var ttm:Namespace

ttpproperty 
public static var ttp:Namespace

ttsproperty 
public static var tts:Namespace

Constructor Detail
SMPTETTParser()Constructor
public function SMPTETTParser()



Method Detail
buildCaptions()method
protected function buildCaptions(timedTextElement:TimedTextElementBase, regionElementsHash:Dictionary, captionRegionsHash:Dictionary, timelineEventsHash:Dictionary):void

Parameters

timedTextElement:TimedTextElementBase
 
regionElementsHash:Dictionary
 
captionRegionsHash:Dictionary
 
timelineEventsHash:Dictionary

buildRegions()method 
protected function buildRegions(document:TtElement):void

Parameters

document:TtElement

createParseEventData()method 
protected function createParseEventData(i_timedTextElement:TimedTextElementBase = null, i_regionElementsHash:Dictionary = null, i_captionRegionsHash:Dictionary = null, i_timelineEventsHash:Dictionary = null):ParseEventData

Parameters

i_timedTextElement:TimedTextElementBase (default = null)
 
i_regionElementsHash:Dictionary (default = null)
 
i_captionRegionsHash:Dictionary (default = null)
 
i_timelineEventsHash:Dictionary (default = null)

Returns
ParseEventData
mapToCaption()method 
protected function mapToCaption(pElement:PElement, region:RegionElement):CaptionElement

Parameters

pElement:PElement
 
region:RegionElement

Returns
CaptionElement
mapToCaptionRegion()method 
protected function mapToCaptionRegion(regionElement:RegionElement):CaptionRegion

Parameters

regionElement:RegionElement

Returns
CaptionRegion
parse()method 
public function parse(i_rawData:String):CaptioningDocument

Parameters

i_rawData:String

Returns
CaptioningDocument
Event Detail
begin Event
Event Object Type: org.osmf.smpte.tt.events.ParseEvent

complete Event  
Event Object Type: org.osmf.smpte.tt.events.ParseEvent

progress Event  
Event Object Type: org.osmf.smpte.tt.events.ParseEvent




Generated by Flexmojos

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