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>
captionElementsHash:Dictionary
[read-only]
Returns a dictionary of CaptionElements indexed by a TimeCode string in the format "00:00:00:00", 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 captionElementsHash():Dictionary
captionRegions:Vector.<CaptionRegion>
[read-only]
Returns a vector of CaptionRegions indexed by integer.
Implementation public function get captionRegions():Vector.<CaptionRegion>
captionRegionsHash:Dictionary
[read-only]
Returns a dictionary of CaptionRegions indexed by region id.
Implementation public function get captionRegionsHash():Dictionary
copyright:String
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The copyright, if it was found in the metadata in the header.
Implementation public function get copyright():String
public function set copyright(value:String):void
description:String
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The description, if it was found in the metadata in the header.
Implementation public function get description():String
public function set description(value:String):void
numTimelineMarkerEvents:int
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the number of root TimelineMarker events in this class'
internal collection.
Implementation public function get numTimelineMarkerEvents():int
title:String
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The title, if it was found in the metadata in the header.
Implementation public function get title():String
public function set title(value:String):void
totalCaptionElements:int
[read-only]
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the total number of root CaptionElements from the internal collection,
including captions that are triggered by the same TimelineMarker event.
Implementation public function get totalCaptionElements():int
public function CaptioningDocument()
public function addCaptionElement(caption:CaptionElement):void
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Add a caption object.
Parameters
public function addCaptionRegion(region:CaptionRegion):void
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Add a region object.
Parameters
public function getActiveCaptionsElements(time:Number):Vector.<CaptionElement>
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns a flattened Vector.<CaptionElement> of root CaptionElements active at a given time.
Parameters
Returns public function getCaptionElementAt(index:int):CaptionElement
Language Version : | ActionScript 3.0 |
Product Version : | OSMF 1.6 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the caption object at the index specified.
Parameters
ReturnsThrows | IllegalOperationError — If index argument is out of range.
|
Fri May 6 2016, 10:06 AM +05:30