org.osmf.smpte.tt.captions.TimedTextElement

	Property	Defined By
		animations : Vector.<TimedTextElement> [read-only] Gets or sets the list of animations to be applied to this element.	TimedTextElement
		begin : Number [read-only] The start time in seconds.	TimedTextElement
		captionElementType : TimedTextElementType Gets or sets the type of this caption element.	TimedTextElement
		children : Vector.<TimedTextElement> [read-only]	TimedTextElement
		content : * Gets or sets the text associated with this marker.	TimedTextElement
		currentStyle : TimedTextStyle Gets or sets the current style of this element.	TimedTextElement
		end : Number [read-only] The end time in seconds.	TimedTextElement
		hasAnimations : Boolean [read-only]	TimedTextElement
		id : String Gets or sets a unique identifier for the marker.	TimedTextElement
		parentElement : * Gets or sets the text associated with this marker.	TimedTextElement
		siblings : Vector.<TimedTextElement> [read-only]	TimedTextElement
		style : TimedTextStyle Gets or sets the Style to be applied to this element.	TimedTextElement
		type : String Gets or sets the type to be applied to this element.	TimedTextElement

	Method	Defined By
		TimedTextElement(start:Number, end:Number, id:String = null)	TimedTextElement
		calculateCurrentStyle(position:Number):void	TimedTextElement
		isActiveAtPosition(position:Number, round:Boolean = false):Boolean	TimedTextElement
		IsActiveAtPosition(tte:TimedTextElement, position:Number, round:Boolean = false):Boolean [static]	TimedTextElement
		isActiveInRange(rangeStart:Number, rangeEnd:Number):Boolean	TimedTextElement
		IsActiveInRange(tte:TimedTextElement, rangeStart:Number, rangeEnd:Number):Boolean [static]	TimedTextElement
		isContainedByRange(rangeStart:Number, rangeEnd:Number):Boolean	TimedTextElement
		IsContainedByRange(tte:TimedTextElement, rangeStart:Number, rangeEnd:Number):Boolean [static]	TimedTextElement
		whereActiveAtPosition(vector:Vector.<TimedTextElement>, position:Number):Vector.<TimedTextElement> [static]	TimedTextElement

Property Detail

animations

property

animations:Vector.<TimedTextElement> [read-only]

Gets or sets the list of animations to be applied to this element.

Implementation
public function get animations():Vector.<TimedTextElement>

begin

property

begin:Number [read-only]

Language Version :

ActionScript 3.0

Product Version :

OSMF 1.6

Runtime Versions :

Flash Player 10, AIR 1.5

The start time in seconds.

Implementation
public function get begin():Number

captionElementType

property

captionElementType:TimedTextElementType

Gets or sets the type of this caption element.

Implementation
public function get captionElementType():TimedTextElementType
public function set captionElementType(value:TimedTextElementType):void

children

property

children:Vector.<TimedTextElement> [read-only]

Implementation
public function get children():Vector.<TimedTextElement>

content

property

content:*

Gets or sets the text associated with this marker.

Implementation
public function get content():*
public function set content(value:any):void

currentStyle

property

currentStyle:TimedTextStyle

Gets or sets the current style of this element.

Implementation
public function get currentStyle():TimedTextStyle
public function set currentStyle(value:TimedTextStyle):void

end

property

end:Number [read-only]

Language Version :

ActionScript 3.0

Product Version :

OSMF 1.6

Runtime Versions :

Flash Player 10, AIR 1.5

The end time in seconds.

Implementation
public function get end():Number

hasAnimations

property

hasAnimations:Boolean [read-only]

Implementation
public function get hasAnimations():Boolean

property

id:String

Gets or sets a unique identifier for the marker.

The id is used to determine which markers are new each time polling occurs.

Implementation
public function get id():String
public function set id(value:String):void

parentElement

property

parentElement:*

Gets or sets the text associated with this marker.

Implementation
public function get parentElement():*
public function set parentElement(value:any):void

siblings

property

siblings:Vector.<TimedTextElement> [read-only]

Implementation
public function get siblings():Vector.<TimedTextElement>

style

property

style:TimedTextStyle

Gets or sets the Style to be applied to this element.

Implementation
public function get style():TimedTextStyle
public function set style(value:TimedTextStyle):void

type

property

type:String

Gets or sets the type to be applied to this element.

Implementation
public function get type():String
public function set type(value:String):void

Constructor Detail

TimedTextElement

()

Constructor

public function TimedTextElement(start:Number, end:Number, id:String = null)

Parameters

	`start:Number`

	`end:Number`

	`id:String` (default = `null`)

Method Detail

calculateCurrentStyle

()

method

public function calculateCurrentStyle(position:Number):void

Parameters

position:Number

isActiveAtPosition

()

method

public function isActiveAtPosition(position:Number, round:Boolean = false):Boolean

Parameters

	`position:Number`

	`round:Boolean` (default = `false`)

Returns

Boolean

IsActiveAtPosition

()

method

public static function IsActiveAtPosition(tte:TimedTextElement, position:Number, round:Boolean = false):Boolean

Parameters

	`tte:TimedTextElement`

	`position:Number`

	`round:Boolean` (default = `false`)

Returns

Boolean

isActiveInRange

()

method

public function isActiveInRange(rangeStart:Number, rangeEnd:Number):Boolean

Parameters

	`rangeStart:Number`

	`rangeEnd:Number`

Returns

Boolean

IsActiveInRange

()

method

public static function IsActiveInRange(tte:TimedTextElement, rangeStart:Number, rangeEnd:Number):Boolean

Parameters

	`tte:TimedTextElement`

	`rangeStart:Number`

	`rangeEnd:Number`

Returns

Boolean

isContainedByRange

()

method

public function isContainedByRange(rangeStart:Number, rangeEnd:Number):Boolean

Parameters

	`rangeStart:Number`

	`rangeEnd:Number`

Returns

Boolean

IsContainedByRange

()

method

public static function IsContainedByRange(tte:TimedTextElement, rangeStart:Number, rangeEnd:Number):Boolean

Parameters

	`tte:TimedTextElement`

	`rangeStart:Number`

	`rangeEnd:Number`

Returns

Boolean

whereActiveAtPosition

()

method

 public static function whereActiveAtPosition(vector:Vector.<TimedTextElement>, position:Number):Vector.<TimedTextElement>

Parameters

	`vector:Vector.<TimedTextElement>`

	`position:Number`

Returns

Vector.<TimedTextElement>

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

HDCore Documentation	All Packages \| All Classes \| Index \| Frames No Frames
TimedTextElement	Properties \| Methods

Package	org.osmf.smpte.tt.captions
Class	public class TimedTextElement
Inheritance	TimedTextElement org.osmf.metadata.TimelineMarker
Subclasses	CaptionElement, CaptionRegion, TimedTextAnimation