topical media & game development
lib-flex-animation-code-10-org-as3lib-kitchensync-action-KSSoundController.ax
lib-flex-animation-code-10-org-as3lib-kitchensync-action-KSSoundController.ax
(swf
)
[ flash
]
flex
package org.as3lib.kitchensync.action
{
import flash.events.Event;
import flash.media.Sound;
import flash.media.SoundChannel;
import flash.net.URLRequest;
import org.as3lib.kitchensync.core.*;
A sound that will be played back at the specified delay.
public class @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-KSSoundController extends AbstractAction
{
A pointer to the sound object passed into the constructor or created based on the URL.
public function get sound():Sound { return _sound; }
public function set sound(sound:Sound):void { _sound = sound; }
protected var _sound:Sound;
A pointer to the sound channel created by the sound object when it is played.
public function get channel():SoundChannel { return _channel; }
public function set channel(channel:SoundChannel):void { _channel = channel; }
protected var _channel:SoundChannel;
The offset of the sound object when it is played. For example,
if this is 1000, the sound will play 1 second from the beginning of the audio file.
Uses the time parser so string values are okay too.
see: org.as3lib.kitchensync.util.ITimeStringParser
see: #delay
public function get soundOffset():int { return _soundOffset; }
public function set soundOffset(soundOffset:*):void {
if (!isNaN(soundOffset)) {
_soundOffset = soundOffset;
} else {
var timeString:String = soundOffset.toString();
_soundOffset = timeStringParser.parseTimeString(timeString);
}
// if < 0, make it equal to 0.
_soundOffset = Math.max(0, _soundOffset);
}
protected var _soundOffset:int = 0;
Used internally to track the paused time of the audio.
protected var _soundPauseTime:int = 0;
override public function set duration(duration:*):void {
throw new Error("duration is ignored for this type of action");
}
Constructor.
@throws TypeError - If the sound parameter is not the correct data type.
parameter: sound - The sound to be played.
Can be an object of type Sound, URLRequest, or the URL of the sound as a String.
parameter: delay - The delay before starting the sound.
parameter: soundOffset - The point at which to begin playing the sound in milliseconds.
public function @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-KSSoundController(sound:*, delay:* = 0, soundOffset:* = 0) {
super();
if (sound is Sound) {
_sound = Sound(sound);
} else if (sound is URLRequest) {
_sound = new Sound (URLRequest(sound));
} else if (sound is String) {
_sound = new Sound (new URLRequest(String(sound)));
} else {
throw new TypeError("The sound parameter must be of type Sound, URLRequest or String.");
}
this.delay = delay;
this.soundOffset = soundOffset;
_soundPauseTime = _soundOffset;
_duration = 0;
}
When the synchronizer updates, checks to see if start time has elapsed and the song is loaded.
If so, it starts playing the song from the soundOffset and unregisters itself.
If the sound hasn't loaded yet, it continues to check each frame until it is loaded, then it plays.
override public function update(currentTimestamp:Timestamp):void {
if (startTimeHasElapsed) {
if (_sound.bytesLoaded == _sound.bytesTotal && _channel == null) {
_channel = _sound.play(_soundOffset);
_channel.addEventListener(Event.SOUND_COMPLETE, onSoundComplete);
unregister();
}
}
}
The event is considered complete when the sound's SOUND_COMPLETE event is fired.
protected function onSoundComplete(event:Event):void {
complete();
}
Override the pause functions to pause the actual sound as well as the action.
override public function pause():void {
super.pause();
if (_channel) {
_soundPauseTime = _channel.position;
_channel.stop();
}
}
Override the pause functions to pause the actual sound as well as the action.
override public function unpause():void {
super.unpause();
if (_channel) {
_channel = _sound.play(_soundPauseTime);
_soundPauseTime = _soundOffset;
}
}
Override the pause functions to pause the actual sound as well as the action.
override public function stop():void {
super.stop();
if (_channel) {
_channel.stop();
_soundPauseTime = _soundOffset;
}
}
Override the kill method to remove references to the sound and channel objects.
override public function kill():void {
super.kill();
stop();
_channel = null;
_sound = null;
}
override public function clone():IAction {
var clone:@ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-KSSoundController = new @ax-lib-flex-animation-code-10-org-as3lib-kitchensync-action-KSSoundController(_sound, _delay, _soundOffset);
clone.autoDelete = _autoDelete;
return clone;
}
}
}
(C) Æliens
19/08/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.
