EventSound

Kind of class:class
Inherits from:Sound
Implements:
Version:02/06/07
Author:Aaron Clinger
Classpath:org.casaframework.sound.EventSound
File last modified:Wednesday, 07 March 2007, 14:18:35
Base Sound object that includes org.casaframework.event.EventDispatcher and implements org.casaframework.core.CoreInterface. All Sound classes implementing EventDispatcher should inherent from this class.
Example:
function onSoundLoad(sender:EventSound, success:Boolean):Void {
    if (success) {
        sender.start();
    }
}

function onSoundId3(sender:EventSound, id3:Object):Void {
    for (var i:String in id3) {
        trace(i + ": " + id3[i]);
    }
}

var eventSound:EventSound = new EventSound(this);
this.eventSound.addEventObserver(this, EventSound.EVENT_LOAD, "onSoundLoad");
this.eventSound.addEventObserver(this, EventSound.EVENT_ID3, "onSoundId3");
this.eventSound.loadSound("test.mp3");
Events broadcast to listeners:
onID3 = function (sender:EventSound, id3:Object) {}
onLoad = function (sender:EventSound, success:Boolean) {}
onSoundComplete = function (sender:EventSound) {}

Constructor

EventSound

function EventSound (
target_mc:MovieClip)
Creates an EventSound object.
Parameters:
target_mc:
The MovieClip instance on which the Sound object operates.

Class properties

EVENT_ID3

static EVENT_ID3:String = 'onID3'
(read,write)

EVENT_LOAD

static EVENT_LOAD:String = 'onLoad'
(read,write)

EVENT_SOUND_COMPLETE

static EVENT_SOUND_COMPLETE:String = 'onSoundComplete'
(read,write)

Instance methods

addEventObserver

function addEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Registers a function to receive notification when a event handler is invoked.
#
Parameters:
scope :
The target or object in which to subscribe.
#
eventName :
Event name to subscribe to.
#
eventHandler:
[optional] Name of function to recieve the event. If undefined class assumes eventHandler matches eventName.
#
Returns:
Returns true if the observer was established successfully; otherwise false.
#

destroy

function destroy (
) : Void
Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Always call destroy() before deleting last object pointer.
#

dispatchEvent

function dispatchEvent (
eventName:String) : Boolean
Reports event to all subscribed objects.
#
Parameters:
eventName:
Event name.
#
param(s) :
[optional] Parameters passed to the function specified by "eventName". Multiple parameters are allowed and should be separated by commas: param1,param2, ...,paramN
#
Returns:
Returns true if observer(s) listening to specifed event were found; otherwise false.
#

removeAllEventObservers

function removeAllEventObservers (
) : Boolean
Removes all observers regardless of scope or event.
#
Returns:
Returns true if observers were successfully removed; otherwise false.
#

removeEventObserver

function removeEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Removes specific observer for event.
#
Parameters:
scope :
The target or object in which subscribed.
#
eventName :
Event name to unsubscribe to.
#
eventHandler:
[optional] Name of function that recieved the event. If undefined class assumes eventHandler matched eventName.
#
Returns:
Returns true if the observer was successfully found and removed; otherwise false.
#

removeEventObserversForEvent

function removeEventObserversForEvent (
eventName:String) : Boolean
Removes all observers for a specified event.
#
Parameters:
eventName:
Event name to unsubscribe to.
#
Returns:
Returns true if observers were successfully found for specified eventName and removed; otherwise false.
#

removeEventObserversForScope

function removeEventObserversForScope (
scope:Object) : Boolean
Removes all observers in a specified scope.
#
Parameters:
scope:
The target or object in which to unsubscribe.
#
Returns:
Returns true if observers were successfully found in scope and removed; otherwise false.
#

toString

function toString (
) : String
Returns class description name.
#
Returns:
Returns class path.
#