| Package | org.openvideoplayer.cc |
| Class | public class Caption |
| Inheritance | Caption  Object |
| Property | Defined 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 | ||
| Method | Defined By | ||
|---|---|---|---|
Caption(id:uint, start:Number, end:Number, text:String)
Creates a Caption. | Caption | ||
addCaptionFormat(cf:CaptionFormat):void
Adds a caption format object for this caption. | Caption | ||
captionFormatCount():uint
A caption can contain several format objects, this method returns the count of format objects
for this particual caption. | Caption | ||
getCaptionFormatAt(index:uint):CaptionFormat
Returns the CaptionFormat object at the specified index or null if not found. | Caption | ||
| endTime | property |
endTime:Number [read-only] End time in seconds.
public function get endTime():Number| id | property |
id:uint [read-only] The ID supplied to the constructor when the Caption was created.
public function get id():uint| startTime | property |
startTime:Number [read-only] Start time in seconds.
public function get startTime():Number| text | property |
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.
public function get text():String| Caption | () | Constructor |
public function Caption(id:uint, start:Number, end:Number, text:String)Creates a Caption.
Parametersid:uint | |
start:Number | |
end:Number | |
text:String |
| addCaptionFormat | () | method |
public function addCaptionFormat(cf:CaptionFormat):voidAdds a caption format object for this caption.
Parameters
cf:CaptionFormat |
| captionFormatCount | () | method |
public function captionFormatCount():uintA caption can contain several format objects, this method returns the count of format objects for this particual caption.
Returnsuint |
| getCaptionFormatAt | () | method |
public function getCaptionFormatAt(index:uint):CaptionFormatReturns the CaptionFormat object at the specified index or null if not found.
Parameters
index:uint |
CaptionFormat |