Packagecom.gestureworks.cml.elements
Classpublic class Media
InheritanceMedia Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Media class is a wrapper for media elements including the ImageElement, VideoElement, and the MP3Element. It auto-selects the correct media element based on the input file extension. It suppports the following file extensions: png, gif, jpg, mpeg-4, mp4, m4v, 3gpp, mov, flv, f4v, and mp3.

See also

Image
Video
MP3
WAV


Public Properties
 PropertyDefined By
  autoplay : Boolean
Indicates whether the file plays upon load
Media
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
  current : *
[read-only] Returns a reference to the current media object
Media
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Sets media height
Media
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  loop : Boolean
Indicates whether the media will re-play when it has reached the end
Media
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  resample : Boolean
Specifies whether a loaded image is resampled to the provided width and/or height.
Media
 Inheritedsound : String
TouchContainer
  src : String
Sets the media file source
Media
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  width : Number
[override] Sets media width
Media
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
Media
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
close():void
Closes the currently open media file
Media
  
dispose():void
[override] Dispose method
Media
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialisation method
Media
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
  
open(file:String):void
Opens the file specified in the argument
Media
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
  
pause():void
Pauses media playback
Media
  
play():void
Plays the media file from the beginning
Media
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
  
resume():void
Resumes media playback from paused position
Media
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
  
seek(offset:Number):void
Sets the media playhead position
Media
 Inherited
method sets the dimensions of each child
TouchContainer
  
stop():void
Pauses the media file and returns to the playhead to the beginning
Media
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
autoplayproperty
autoplay:Boolean

Indicates whether the file plays upon load

The default value is false.


Implementation
    public function get autoplay():Boolean
    public function set autoplay(value:Boolean):void
currentproperty 
current:*  [read-only]

Returns a reference to the current media object

The default value is null.


Implementation
    public function get current():*
heightproperty 
height:Number[override]

Sets media height

The default value is 0.


Implementation
    public function get height():Number
    public function set height(value:Number):void
loopproperty 
loop:Boolean

Indicates whether the media will re-play when it has reached the end

The default value is false.


Implementation
    public function get loop():Boolean
    public function set loop(value:Boolean):void
resampleproperty 
resample:Boolean

Specifies whether a loaded image is resampled to the provided width and/or height. In order for resampling to work, this must be set to true, and a width and/or height must be set prior to calling open.

The default value is false.


Implementation
    public function get resample():Boolean
    public function set resample(value:Boolean):void
srcproperty 
src:String

Sets the media file source

The default value is null.


Implementation
    public function get src():String
    public function set src(value:String):void
widthproperty 
width:Number[override]

Sets media width

The default value is 0.


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
Media()Constructor
public function Media()

Constructor

Method Detail
close()method
public function close():void

Closes the currently open media file

dispose()method 
override public function dispose():void

Dispose method

init()method 
override public function init():void

Initialisation method

open()method 
public function open(file:String):void

Opens the file specified in the argument

Parameters

file:String

pause()method 
public function pause():void

Pauses media playback

play()method 
public function play():void

Plays the media file from the beginning

resume()method 
public function resume():void

Resumes media playback from paused position

seek()method 
public function seek(offset:Number):void

Sets the media playhead position

Parameters

offset:Number

stop()method 
public function stop():void

Pauses the media file and returns to the playhead to the beginning