Packagecom.gestureworks.cml.factories
Classpublic class MP3Factory
InheritanceMP3Factory Inheritance ElementFactory Inheritance flash.display.Sprite

The MP3Factory is the base class for all MP3s. It is an abstract class that is not meant to be called directly.

See also

com.gestureworks.cml.factories.Graphic
com.gestureworks.cml.factories.ElementFactory
com.gestureworks.cml.factories.ObjectFactory


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
[override] [write-only] sets the alpha for display objects
ElementFactory
  autoLoad : Boolean
Indicates whether the mp3 file is loaded when the src property is set
MP3Factory
  autoplay : Boolean
Indicates whether the mp3 file plays upon load
MP3Factory
 Inheritedblur : Boolean
Sets the drop shadow effect
ElementFactory
 Inheritedbottom : Number
sets the bottom value
ElementFactory
 Inheritedclass_ : String
Object's css class;
ElementFactory
 InheritedclassName : String
sets the class name of displayobject
ElementFactory
 InheritedcmlIndex : int
sets the cml index
ElementFactory
 InheriteddebugStyle : *
sets the debug style
ElementFactory
  display : String
MP3Factory
 InheriteddisplayEvents : String
Use for dispatch completes.
ElementFactory
 InheriteddropShadow : Boolean
Sets the drop shadow effect
ElementFactory
  duration : Number
[read-only]
MP3Factory
  height : Number
[override] Sets the height
MP3Factory
 InheritedheightPercent : String
sets the height percent of display object
ElementFactory
 InheritedhorizontalCenter : Number
sets the horizontal center of display object
ElementFactory
 Inheritedid : String
sets the id of child
ElementFactory
  id3Album : String
[read-only] returns the album id
MP3Factory
  id3Author : String
[read-only] returns the author id
MP3Factory
  id3Comment : String
[read-only] returns the comment
MP3Factory
  id3Copyright : String
[read-only] returns the copyright id
MP3Factory
  id3Title : String
[read-only] returns the title
MP3Factory
  id3Year : String
[read-only]
MP3Factory
 Inheritedindex : int
sets the index of display object
ElementFactory
 Inheritedleft : Number
sets left value
ElementFactory
  loop : Boolean
Mp3 loop play
MP3Factory
  pan : Number
Sets the pan
MP3Factory
  percentLoaded : Number
[read-only]
MP3Factory
  position : Number
[read-only]
MP3Factory
 InheritedpropertyStates : Array
Deprecated: Please Use state
ElementFactory
 Inheritedright : Number
sets the right value
ElementFactory
 Inheritedscale : Number
Sets both the x and y scale values
ElementFactory
 InheritedscaleX : Number
[override] Sets width of the display object in pixels
ElementFactory
 InheritedscaleY : Number
[override] Sets width of the display object in pixels
ElementFactory
  src : String
Sets the mp3 file path
MP3Factory
 Inheritedstate : Array
property states array
ElementFactory
  time : String
[read-only] update timer
MP3Factory
  TIME : String = Time
[static] time variable
MP3Factory
  timer : Timer
defines timer variable
MP3Factory
 Inheritedtop : Number
sets top value
ElementFactory
  useId3 : String
sets the id of mp3
MP3Factory
 InheritedverticalCenter : Number
sets the vertical center of display object
ElementFactory
  volume : Number
Sets the volume
MP3Factory
  waveColor : int
sets the wave color
MP3Factory
  width : Number
[override] Sets the width
MP3Factory
 InheritedwidthPercent : String
sets the percent of width of display object
ElementFactory
Public Methods
 MethodDefined By
  
Constructor
MP3Factory
 Inherited
clone():*
Returns clone of self
ElementFactory
  
close():void
Closes mp3
MP3Factory
 Inherited
CML callback
ElementFactory
  
dispose():void
[override] Disposal method
MP3Factory
 Inherited
init():void
Initialization function
ElementFactory
  
open(file:String):void
Sets the src property and loads the mp3
MP3Factory
 Inherited
parseCML(cml:XMLList):XMLList
parses cml file
ElementFactory
  
pause():void
Pauses mp3
MP3Factory
  
play():void
Plays the mp3 from the beginning
MP3Factory
 Inherited
postparseCML(cml:XMLList):void
post parses the cml file
ElementFactory
  
resume():void
Resumes mp3 playback from paused position
MP3Factory
  
seek(offset:Number):void
Sets the mp3 playhead position
MP3Factory
  
stop():void
Pauses mp3 and returns to the beginning
MP3Factory
 Inherited
updateProperties(state:Number = 0):void
this method updates the properties
ElementFactory
Property Detail
autoLoadproperty
autoLoad:Boolean

Indicates whether the mp3 file is loaded when the src property is set


Implementation
    public function get autoLoad():Boolean
    public function set autoLoad(value:Boolean):void
autoplayproperty 
autoplay:Boolean

Indicates whether the mp3 file plays upon load


Implementation
    public function get autoplay():Boolean
    public function set autoplay(value:Boolean):void
displayproperty 
display:String


Implementation
    public function get display():String
    public function set display(value:String):void
durationproperty 
duration:Number  [read-only]


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

Sets the height


Implementation
    public function get height():Number
    public function set height(value:Number):void
id3Albumproperty 
id3Album:String  [read-only]

returns the album id


Implementation
    public function get id3Album():String
id3Authorproperty 
id3Author:String  [read-only]

returns the author id


Implementation
    public function get id3Author():String
id3Commentproperty 
id3Comment:String  [read-only]

returns the comment


Implementation
    public function get id3Comment():String
id3Copyrightproperty 
id3Copyright:String  [read-only]

returns the copyright id


Implementation
    public function get id3Copyright():String
id3Titleproperty 
id3Title:String  [read-only]

returns the title


Implementation
    public function get id3Title():String
id3Yearproperty 
id3Year:String  [read-only]


Implementation
    public function get id3Year():String
loopproperty 
loop:Boolean

Mp3 loop play


Implementation
    public function get loop():Boolean
    public function set loop(value:Boolean):void
panproperty 
pan:Number

Sets the pan


Implementation
    public function get pan():Number
    public function set pan(value:Number):void
percentLoadedproperty 
percentLoaded:Number  [read-only]


Implementation
    public function get percentLoaded():Number
positionproperty 
position:Number  [read-only]


Implementation
    public function get position():Number
srcproperty 
src:String

Sets the mp3 file path


Implementation
    public function get src():String
    public function set src(value:String):void
timeproperty 
time:String  [read-only]

update timer


Implementation
    public function get time():String
TIMEproperty 
public static var TIME:String = Time

time variable

timerproperty 
public var timer:Timer

defines timer variable

useId3property 
useId3:String

sets the id of mp3


Implementation
    public function get useId3():String
    public function set useId3(value:String):void
volumeproperty 
volume:Number

Sets the volume


Implementation
    public function get volume():Number
    public function set volume(value:Number):void
waveColorproperty 
waveColor:int

sets the wave color


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

Sets the width


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

Constructor

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

Closes mp3

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

Disposal method

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

Sets the src property and loads the mp3

Parameters

file:String

pause()method 
public function pause():void

Pauses mp3

play()method 
public function play():void

Plays the mp3 from the beginning

resume()method 
public function resume():void

Resumes mp3 playback from paused position

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

Sets the mp3 playhead position

Parameters

offset:Number

stop()method 
public function stop():void

Pauses mp3 and returns to the beginning