Packagevn.karaokeplayer.parsers
Classpublic class TimedTextParser
ImplementsILyricsParser

This parser parses the default timed-text based lyrics XML file



Public Properties
 PropertyDefined by
  kar : Namespace
TimedTextParser
  tt : Namespace
TimedTextParser
  ttm : Namespace
TimedTextParser
  tts : Namespace
TimedTextParser
Public Methods
 MethodDefined by
  
parseXML(xml:XML):SongInfo
parse the TimedText XML data into SongInfo
TimedTextParser
Public Constants
 ConstantDefined by
  VERSION : String = "0.8.71"
[static]
TimedTextParser
Property detail
karproperty
public var kar:Namespace
ttproperty 
public var tt:Namespace
ttmproperty 
public var ttm:Namespace
ttsproperty 
public var tts:Namespace
Method detail
getExtraMetadata()method
karplayer_internal function getExtraMetadata(metadata:XML):ObjectParameters
metadata:XML

Returns
Object
getValueFromSet()method 
karplayer_internal function getValueFromSet(value:Object, valueSet:Array):Object

get value from set of predefined value.
for e.g: style must match one of "b", "m" or "f"

Parameters
value:Object
 
valueSet:Array

Returns
Object — value if value is in set; else return default value (first one)
parseMetadata()method 
karplayer_internal function parseMetadata(metadata:XML, songInfo:SongInfo):void

parse metadata part of song XML

Parameters
metadata:XML — metadata part of the XML
 
songInfo:SongInfo — value object to put data to
parseSongHead()method 
karplayer_internal function parseSongHead(head:XML, songInfo:SongInfo):void

parse head part of song XML

Parameters
head:XML
 
songInfo:SongInfo
parseSongLyrics()method 
karplayer_internal function parseSongLyrics(body:XML, songInfo:SongInfo):void

Parameters
body:XML
 
songInfo:SongInfo
parseTimeAttribute()method 
karplayer_internal function parseTimeAttribute(parentNode:XML, attr:String, req:Boolean):Number

Modified from FLVPlayBackCaptioning's TimedTextManager

Parameters
parentNode:XML
 
attr:String
 
req:Boolean

Returns
Number
parseXML()method 
public function parseXML(xml:XML):SongInfo

parse the TimedText XML data into SongInfo

Parameters
xml:XML — TimedText xml data

Returns
SongInfo
Constant detail
VERSIONconstant
public static const VERSION:String = "0.8.71"