Packagecom.rosettastone.library.taskmanager
Classpublic class PlaySoundTask
InheritancePlaySoundTask Inheritance InterruptibleTask Inheritance Task Inheritance flash.events.EventDispatcher

Task that plays a Sound and completes when the sound has finished playing. This Task expects that the Sound object provided has already been loaded. This task supports interruption as well as resume. Upon resuming an interrupted Sound this Task can either re-start playback at the beginning or resume from the interrupted point. This behavior can be controlled via the constructor parameter "restartSoundAfterInterruption".


Public Properties
 PropertyDefined By
 Inheriteddata : *
[read-only] Optional data parameter passed to the Task complete/error/interruption method.
Task
 Inheritedid : Number
[read-only]
Task
 Inheritedinterruptible : Boolean
[override] [read-only] The current Task can be interrupted.
InterruptibleTask
 InheritedinterruptingTask : ITask
[read-only] The Task currently interrupting the composite Task's execution (or NULL if no such Task exists).
Task
 InheritedisComplete : Boolean
[read-only] The current task has successfully completed execution.
Task
 InheritedisErrored : Boolean
[read-only] The current task failed.
Task
 InheritedisInterrupted : Boolean
[read-only]
Task
 InheritedisRunning : Boolean
[read-only] The task is currently running.
Task
 Inheritedmessage : String
[read-only] Optional message parameter passed to the task complete/error/interruption method.
Task
 InheritednumInternalOperations : int
[read-only] Number of internal operations conducted by this task.
Task
 InheritednumInternalOperationsCompleted : int
[read-only] Number of internal operations that have completed.
Task
 InheritednumInternalOperationsPending : int
[read-only] Number of internal operations not yet completed.
Task
 InheritednumTimesCompleted : int
[read-only] Number of times this task has completed.
Task
 InheritednumTimesErrored : int
[read-only] Number of times this task has errored.
Task
 InheritednumTimesInterrupted : int
[read-only] Number of times this task has been interrupted.
Task
 InheritednumTimesReset : int
[read-only] Number of times this task has been reset.
Task
 InheritednumTimesStarted : int
[read-only] Number of times this task has been started.
Task
 Inheritedrunning : Boolean
[read-only] The task is currently running.
Task
  sound : Sound
[read-only]
PlaySoundTask
  soundChannel : SoundChannel
[read-only]
PlaySoundTask
 Inheritedsynchronous : Boolean
[read-only] The current task can be executed synchronously.
Task
 InheritedtaskIdentifier : String
(Optional) human-readable label for task.
Task
 InheriteduniqueID : Number
[read-only] Unique ID for a task.
Task
Protected Properties
 PropertyDefined By
  _interruptedPosition : int
PlaySoundTask
 Inheritedlogger : ILogger
[read-only] Instance of ILogger to be used for any custom Task logging.
Task
  _restartSoundAfterInterruption : Boolean
PlaySoundTask
  _sound : Sound
PlaySoundTask
  _soundChannel : SoundChannel
PlaySoundTask
Public Methods
 MethodDefined By
  
PlaySoundTask(sound:Sound, restartSoundAfterInterruption:Boolean = true, taskIdentifier:String = null)
Constructor.
PlaySoundTask
 Inherited
and(... chainedTasks):ITask
Executes the specified tasks when the current task is executed.
Task
 Inherited
disconnectFromInterruptingTask():void
Task
 Inherited
interrupt():Boolean
[override] Interrupt the current Task.
InterruptibleTask
 Inherited
interruptForTask(interruptingTask:ITask):Boolean
Interrupts the current Task to wait on the Task specified.
Task
 Inherited
or(... chainedTasks):ITask
Executes the specified tasks if the current task fails.
Task
 Inherited
reset():void
Resets the task to it's pre-run state.
Task
 Inherited
run():ITask
Starts a task.
Task
 Inherited
then(... chainedTasks):ITask
Executes the specified tasks once the current task has completed successfully.
Task
 Inherited
withCompleteHandler(completeHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate completion, this method may also be used for notification purposes.
Task
 Inherited
withErrorHandler(errorHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate failure, this method may also be used for notification purposes.
Task
 Inherited
withFinalHandler(finalHandler:Function):ITask
This handler is invoked upon either success or failure of the Task.
Task
 Inherited
withInterruptionHandler(interruptionHandler:Function):ITask
Task
 Inherited
withStartedHandler(startedHandler:Function):ITask
Although tasks dispatch TaskEvents to indicate starting, this method may also be used for notification purposes.
Task
Protected Methods
 MethodDefined By
  
customInterrupt():void
[override] Sub-classes should override this method to implement interruption behavior (removing event listeners, pausing objects, etc.).
PlaySoundTask
 Inherited
customReset():void
Override this method to perform any custom reset operations.
Task
  
customRun():void
[override] Override this method to give your Task functionality.
PlaySoundTask
 Inherited
dispatchProgressEvent():void
Task
 Inherited
getLoggerString(string:String):String
Returns a string for logging the specified task-state event.
Task
 Inherited
taskComplete(message:String, data:* = null):void
This method should be called upon Task completion.
Task
 Inherited
taskError(message:String, data:* = null):void
This method should be called upon Task failure.
Task
 Inherited
taskInterrupted(message:String, data:* = null):void
Call this method to interrupt the currently running Task.
Task
 Inherited
throwErrorIfAnyObjectInArrayIsNotATask(tasks:Array):void
Task
Events
 Event Summary Defined By
 Inherited
progress
Task
 Inherited
taskEventComplete
Task
 Inherited
taskEventError
Task
 Inherited
taskEventFinal
Task
 Inherited
taskEventInterrupted
Task
 Inherited
taskEventStarted
Task
Property Detail
_interruptedPositionproperty
protected var _interruptedPosition:int

_restartSoundAfterInterruptionproperty 
protected var _restartSoundAfterInterruption:Boolean

_soundproperty 
protected var _sound:Sound

_soundChannelproperty 
protected var _soundChannel:SoundChannel

soundproperty 
sound:Sound  [read-only]


Implementation
    public function get sound():Sound
soundChannelproperty 
soundChannel:SoundChannel  [read-only]


Implementation
    public function get soundChannel():SoundChannel
Constructor Detail
PlaySoundTask()Constructor
public function PlaySoundTask(sound:Sound, restartSoundAfterInterruption:Boolean = true, taskIdentifier:String = null)

Constructor.

Parameters
sound:Sound — Loaded Sound object to be played
 
restartSoundAfterInterruption:Boolean (default = true) — Specifies the resume-after-interruption behavior
 
taskIdentifier:String (default = null)
Method Detail
customInterrupt()method
override protected function customInterrupt():void

Sub-classes should override this method to implement interruption behavior (removing event listeners, pausing objects, etc.).

customRun()method 
override protected function customRun():void

Override this method to give your Task functionality.





Tue Sep 24 2013, 09:21 AM -04:00