Packagecom.gestureworks.cml.elements
Classpublic class Sound
InheritanceSound Inheritance com.gestureworks.cml.utils.MP3Factory



Public Properties
 PropertyDefined By
  eventlessNotification : Boolean
This is a property for setting if the sound has no specific gesture or event attached to it, so it will be processed into the SoundManager's dictionary but will not interfere with other events.
Sound
  importance : int
This property determines the sound's play heirarchy in reference to other sounds.
Sound
  stopOnRelease : Boolean
This is a special property to set the sound file to stop on release.
Sound
  target : *
Sets the target object that will trigger the sound playing when touched by the triggering event.
Sound
  trigger : String
Sets the touch events that will play the sound.
Sound
  triggerArray : Array
[read-only]
Sound
Public Methods
 MethodDefined By
  
Sound
  
dispose():void
[override] Disposal method
Sound
  
init():void
[override]
Sound
  
play():void
[override]
Sound
Protected Methods
 MethodDefined By
  
soundLoaded(e:Event = null):void
[override]
Sound
Property Detail
eventlessNotificationproperty
eventlessNotification:Boolean

This is a property for setting if the sound has no specific gesture or event attached to it, so it will be processed into the SoundManager's dictionary but will not interfere with other events.


Implementation
    public function get eventlessNotification():Boolean
    public function set eventlessNotification(value:Boolean):void
importanceproperty 
importance:int

This property determines the sound's play heirarchy in reference to other sounds. If the sound's heirarchy is lower than a sound that's currently playing, it will not play. If the sound's heirarchy is the same as a sound that is currently playing, they will play at the same time, and if it is higher, than the other sound will be stopped for this sound to play. Setting importance to a negative number will exclude the sound from the comparison so it will always play without interrupting any other sounds. So -1 should be used for a background sound that always plays.

The default value is 0.


Implementation
    public function get importance():int
    public function set importance(value:int):void
stopOnReleaseproperty 
stopOnRelease:Boolean

This is a special property to set the sound file to stop on release. Looping will automatically cause a sound file to stop on release, this variable will allow specification for long sound files to stop when the user releases. Don't set this to 'true' for sounds that are supposed to play on "up".


Implementation
    public function get stopOnRelease():Boolean
    public function set stopOnRelease(value:Boolean):void
targetproperty 
target:*

Sets the target object that will trigger the sound playing when touched by the triggering event. This can accept an ID or take a direct display object.


Implementation
    public function get target():*
    public function set target(value:any):void
triggerproperty 
trigger:String

Sets the touch events that will play the sound.

The default value is down.


Implementation
    public function get trigger():String
    public function set trigger(value:String):void
triggerArrayproperty 
triggerArray:Array  [read-only]


Implementation
    public function get triggerArray():Array
Constructor Detail
Sound()Constructor
public function Sound()



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

Disposal method

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

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

soundLoaded()method 
override protected function soundLoaded(e:Event = null):void

Parameters

e:Event (default = null)