Packageorg.openvideoplayer.cc
Classpublic class Caption
InheritanceCaption Inheritance Object

Represents a caption, including text and style formatting information, as well as when to show the caption and when to hide it.



Public Properties
 PropertyDefined By
  endTime : Number
[read-only] End time in seconds.
Caption
  id : uint
[read-only] The ID supplied to the constructor when the Caption was created.
Caption
  startTime : Number
[read-only] Start time in seconds.
Caption
  text : String
[read-only] Caption text.
Caption
Public Methods
 MethodDefined By
  
Caption(id:uint, start:Number, end:Number, text:String)
Creates a Caption.
Caption
  
Adds a caption format object for this caption.
Caption
  
A caption can contain several format objects, this method returns the count of format objects for this particual caption.
Caption
  
Returns the CaptionFormat object at the specified index or null if not found.
Caption
Property Detail
endTimeproperty
endTime:Number  [read-only]

End time in seconds.


Implementation
    public function get endTime():Number
idproperty 
id:uint  [read-only]

The ID supplied to the constructor when the Caption was created.


Implementation
    public function get id():uint
startTimeproperty 
startTime:Number  [read-only]

Start time in seconds.


Implementation
    public function get startTime():Number
textproperty 
text:String  [read-only]

Caption text. This could contain html display tags, such as <br/>, so best to assign to a control's htmlText property.


Implementation
    public function get text():String
Constructor Detail
Caption()Constructor
public function Caption(id:uint, start:Number, end:Number, text:String)

Creates a Caption.

Parameters
id:uint
 
start:Number
 
end:Number
 
text:String
Method Detail
addCaptionFormat()method
public function addCaptionFormat(cf:CaptionFormat):void

Adds a caption format object for this caption.

Parameters

cf:CaptionFormat

captionFormatCount()method 
public function captionFormatCount():uint

A caption can contain several format objects, this method returns the count of format objects for this particual caption.

Returns
uint
getCaptionFormatAt()method 
public function getCaptionFormatAt(index:uint):CaptionFormat

Returns the CaptionFormat object at the specified index or null if not found.

Parameters

index:uint

Returns
CaptionFormat