| Package | org.osmf.smpte.tt.media |
| Class | public class CaptioningMediaElement |
| Inheritance | CaptioningMediaElement  org.osmf.media.MediaElement |
| Property | Defined By | ||
|---|---|---|---|
| mediaElement : MediaElement | CaptioningMediaElement | ||
| showCaptions : Boolean | CaptioningMediaElement | ||
| Method | Defined By | ||
|---|---|---|---|
| CaptioningMediaElement | |||
addCaption(value:CaptionElement):void | CaptioningMediaElement | ||
| CaptioningMediaElement | |||
clear():void | CaptioningMediaElement | ||
getRegionById(id:String):RegionLayoutTargetSprite | CaptioningMediaElement | ||
removeCaption(value:CaptionElement = null):void | CaptioningMediaElement | ||
removeRegionById(id:String):void | CaptioningMediaElement | ||
setIntrinsicDimensions(width:Number, height:Number, fireEvent:Boolean = true):void | CaptioningMediaElement | ||
validateCaptions():void | CaptioningMediaElement | ||
| mediaElement | property |
mediaElement:MediaElement public function get mediaElement():MediaElement public function set mediaElement(value:MediaElement):void| showCaptions | property |
showCaptions:Boolean public function get showCaptions():Boolean public function set showCaptions(value:Boolean):void| CaptioningMediaElement | () | Constructor |
public function CaptioningMediaElement()| addCaption | () | method |
| addRegion | () | method |
public function addRegion(value:CaptionRegion):RegionLayoutTargetSpriteParameters
value:CaptionRegion |
RegionLayoutTargetSprite |
| clear | () | method |
public function clear():void| getRegionById | () | method |
public function getRegionById(id:String):RegionLayoutTargetSpriteParameters
id:String |
RegionLayoutTargetSprite |
| removeCaption | () | method |
public function removeCaption(value:CaptionElement = null):voidParameters
value:CaptionElement (default = null) |
| removeRegionById | () | method |
public function removeRegionById(id:String):voidParameters
id:String |
| setIntrinsicDimensions | () | method |
public function setIntrinsicDimensions(width:Number, height:Number, fireEvent:Boolean = true):voidParameters
width:Number | |
height:Number | |
fireEvent:Boolean (default = true) |
| validateCaptions | () | method |
public function validateCaptions():void