Packagevegas.media
Classpublic class SoundLoader
InheritanceSoundLoader Inheritance CoreActionLoader Inheritance CoreAction Inheritance Task Inheritance Object
Implements Stoppable

This action process is an helper who launch the load of a CoreSound object.

Example : 

     import system.process.Action ;
     
     import vegas.media.CoreSound ;
     import vegas.media.SoundLoader ;
     
     import flash.net.URLRequest ;
     
     var start:Function = function( action:Action ):void
     {
         trace( "start" ) ;
     }
     
     var progress:Function = function( bytesLoaded:Number , bytesTotal:Number, action:Action ):void
     {
         trace( "progress loaded:" + bytesLoaded + " total:" + target.bytesTotal) ;
     }
     
     var finish:Function = function( action:Action ):void
     {
         trace( "finish" ) ;
         sound.play() ;
     }
     
     var url:String = "mp3/test.mp3" ;
     var sound:CoreSound = new CoreSound() ;
     
     var process:SoundLoader = new SoundLoader( sound ) ;
     
     process.addEventListener(ActionEvent.START     , start ) ;
     process.addEventListener(ActionEvent.PROGRESS  , progress ) ;
     process.addEventListener(ActionEvent.FINISH    , finish ) ;
     
     process.request = new URLRequest( url ) ;
     
     process.run() ;


Public Properties
 PropertyDefined By
  bytesLoaded : uint
[override] [read-only] Indicates the number of bytes that have been loaded thus far during the load operation.
SoundLoader
  bytesTotal : uint
[override] [read-only] Indicates the total number of bytes in the downloaded data.
SoundLoader
 Inheritedcache : Boolean
The cache flag of this resource (default is true).
CoreActionLoader
 InheritedcacheParameterName : String
The name of the uri query parameter when the cache attribute is true.
CoreActionLoader
 InheritedchangeIt : Signaler
This signal emit when the notifyChanged method is invoked.
CoreAction
 InheritedclearIt : Signaler
This signal emit when the notifyCleared method is invoked.
CoreAction
 Inheritedcomplete : Signaler
This signal emit when the notifyComplete method is invoked.
CoreActionLoader
  context : SoundLoaderContext
Minimum number of milliseconds of MP3 data to hold in the Sound object's buffer.
SoundLoader
 InheritedDEFAULT_CACHE_PARAMETER : String = random
[static] The name of the default cache uri query parameter ("random").
CoreActionLoader
 InheritedDEFAULT_DELAY : uint = 8000
[static] The default value of the delay before the ActionEvent.TIMEOUT event (defines in the constructor of the class).
CoreActionLoader
 InheritedDEFAULT_TIMEOUT_POLICY : TimeoutPolicy
[static] The default TimeoutPolicy value used to set the timeoutPolicy member of all new objects of this class.
CoreActionLoader
 Inheriteddelay : uint
[read-only] Indicates the timeout interval duration.
CoreActionLoader
 Inheritederror : Signaler
This signal emit when the notifyError method is invoked.
CoreActionLoader
 InheritedfinishIt : Signaler
This signal emit when the notifyFinished method is invoked.
Task
 InheritedhttpStatus : Signaler
This signal emit when the notifyHttpStatus method is invoked.
CoreActionLoader
  id3 : ID3Info
[read-only] (read-only) Provides access to the metadata that is part of an MP3 file.
SoundLoader
  id3It : Signaler
[read-only] This signal emit when the notifyId3 method is invoked.
SoundLoader
 InheritedinfoIt : Signaler
This signal emit when the notifyInfo method is invoked.
CoreAction
 Inheritedinit : Signaler
This signal emit when the notifyInit method is invoked.
CoreActionLoader
  isBuffering : Boolean
[read-only] (read-only) Returns the buffering state of external MP3 files.
SoundLoader
  length : Number
[read-only] (read-only) The length of the current sound in milliseconds.
SoundLoader
  loader : IEventDispatcher
[override] Indicates the loader object of this process.
SoundLoader
 Inheritedlogger : Logger
Determinates the internal Logger reference of this Loggable object.
Task
 Inheritedlooping : Boolean
The flag to determinate if the Action object is looped.
CoreAction
 InheritedloopIt : Signaler
This signal emit when the notifyLooped method is invoked.
CoreAction
 Inheritedopen : Signaler
This signal emit when the notifyOpen method is invoked.
CoreActionLoader
 InheritedpauseIt : Signaler
This signal emit when the notifyPause method is invoked.
CoreAction
 Inheritedphase : String
[read-only] The current phase of the action.
Task
  position : Number
[read-only] The current position of the playhead within the sound.
SoundLoader
 InheritedprogressIt : Signaler
This signal emit when the notifyProgress method is invoked.
CoreAction
 Inheritedrequest : URLRequest
Indicates the URLRequest object who captures all of the information in a single HTTP request.
CoreActionLoader
 InheritedresumeIt : Signaler
This signal emit when the notifyResumed method is invoked.
CoreAction
 Inheritedrunning : Boolean
[read-only] Indicates true if the process is in progress.
Task
 InheritedstartIt : Signaler
This signal emit when the notifyStarted method is invoked.
Task
 InheritedstopIt : Signaler
This signal emit when the notifyStopped method is invoked.
CoreAction
 InheritedtimeoutIt : Signaler
This signal emit when the notifyTimeOut method is invoked.
CoreAction
 InheritedtimeoutPolicy : TimeoutPolicy
Indicates the timeout policy of the loader.
CoreActionLoader
  url : String
[read-only] (read-only) The URL from which this sound was loaded.
SoundLoader
Public Methods
 MethodDefined By
  
SoundLoader(sound:CoreSound = null)
Creates a new SoundLoader instance.
SoundLoader
 Inherited
clone():*
[override] Returns a shallow copy of this object.
CoreActionLoader
  
close():void
[override] Cancels a load() method operation that is currently in progress for the Loader instance.
SoundLoader
 Inherited
isLocked():Boolean
Returns true if the object is locked.
Task
 Inherited
lock():void
Locks the object.
Task
 Inherited
notifyChanged():void
Notify when the process is changed.
CoreAction
 Inherited
notifyCleared():void
Notify when the process is cleared.
CoreAction
 Inherited
notifyComplete():void
Notify when the process is complete.
CoreActionLoader
 Inherited
notifyError(error:Object = null):void
Notify when the process failed.
CoreActionLoader
 Inherited
notifyFinished():void
[override] Notify an ActionEvent when the process is finished.
CoreActionLoader
 Inherited
notifyHttpStatus(status:Object = null):void
Notify when the loading process httpstatus is changed..
CoreActionLoader
  
notifyId3():void
Notify when the process is initialize.
SoundLoader
 Inherited
notifyInfo(info:*):void
Notify a specific information when the process is changed.
CoreAction
 Inherited
notifyInit():void
Notify when the process is initialize.
CoreActionLoader
 Inherited
notifyLooped():void
Notify when the process is looped.
CoreAction
 Inherited
notifyOpen():void
Notify when the process is open.
CoreActionLoader
 Inherited
notifyPaused():void
Notify when the process is paused.
CoreAction
 Inherited
notifyProgress():void
Notify when the process is in progress.
CoreAction
 Inherited
notifyResumed():void
Notify when the process is resumed.
CoreAction
 Inherited
notifyStarted():void
[override] Notify an ActionEvent when the process is started.
CoreActionLoader
 Inherited
notifyStopped():void
Notify when the process is stopped.
CoreAction
 Inherited
notifyTimeOut():void
Notify when the process is out of time.
CoreAction
  
register(dispatcher:IEventDispatcher):void
[override] Register the loader object.
SoundLoader
 Inherited
run(... arguments):void
[override] Run the process.
CoreActionLoader
 Inherited
setDelay(time:uint, useSeconds:Boolean = false):void
Sets the timeout interval duration.
CoreActionLoader
  
stop():void
Stops the process if is running
SoundLoader
 Inherited
unlock():void
Unlocks the display.
Task
  
unregister(dispatcher:IEventDispatcher):void
[override] Unregister the loader object.
SoundLoader
Protected Methods
 MethodDefined By
 Inherited
_complete(e:Event):void
Invoked when the loading is complete.
CoreActionLoader
 Inherited
_error(e:ErrorEvent):void
Dispatch an ErrorEvent if a call to load() attempts a server problem (IOErrorEvent or SecurityErrorEvent).
CoreActionLoader
 Inherited
_httpStatus(e:HTTPStatusEvent):void
Dispatch HTTPStatusEvent if a call to load() attempts to access data over HTTP and the current Flash Player environment is able to detect and return the status code for the request.
CoreActionLoader
  
_id3(e:Event):void
Invoked when the Event.ID3 event is fired.
SoundLoader
 Inherited
_init(e:Event):void
Invoked when the loading is init.
CoreActionLoader
 Inherited
_open(e:Event):void
Dispatch Event.OPEN event when the download operation commences following a call to the load() method.
CoreActionLoader
 Inherited
_progress(e:ProgressEvent):void
Invoked when the loading is in complete.
CoreActionLoader
  
_run():void
[override] This protected method contains the invokation of the load method of the current loader of this process.
SoundLoader
 Inherited
resolveRequest():void
Resolves the request of the loader with the cache query parameter if the cache attribute is true.
CoreActionLoader
 Inherited
setRunning(b:Boolean):void
Changes the running property value.
Task
Property Detail
bytesLoadedproperty
bytesLoaded:uint  [read-only] [override]

Indicates the number of bytes that have been loaded thus far during the load operation.


Implementation
    public function get bytesLoaded():uint
bytesTotalproperty 
bytesTotal:uint  [read-only] [override]

Indicates the total number of bytes in the downloaded data.


Implementation
    public function get bytesTotal():uint
contextproperty 
context:SoundLoaderContext

Minimum number of milliseconds of MP3 data to hold in the Sound object's buffer. The Sound object waits until it has at least this much data before beginning playback and before resuming playback after a network stall. The default value is 1000 (one second).


Implementation
    public function get context():SoundLoaderContext
    public function set context(value:SoundLoaderContext):void
id3property 
id3:ID3Info  [read-only]

(read-only) Provides access to the metadata that is part of an MP3 file.


Implementation
    public function get id3():ID3Info
id3Itproperty 
id3It:Signaler  [read-only]

This signal emit when the notifyId3 method is invoked.


Implementation
    public function get id3It():Signaler
isBufferingproperty 
isBuffering:Boolean  [read-only]

(read-only) Returns the buffering state of external MP3 files. If the value is true, any playback is currently suspended while the object waits for more data.


Implementation
    public function get isBuffering():Boolean
lengthproperty 
length:Number  [read-only]

(read-only) The length of the current sound in milliseconds.


Implementation
    public function get length():Number
loaderproperty 
loader:IEventDispatcher[override]

Indicates the loader object of this process.


Implementation
    public function get loader():IEventDispatcher
    public function set loader(value:IEventDispatcher):void
positionproperty 
position:Number  [read-only]

The current position of the playhead within the sound. If the value is NaN, the internal SoundChannel is 'null'.


Implementation
    public function get position():Number
urlproperty 
url:String  [read-only]

(read-only) The URL from which this sound was loaded. This property is applicable only to Sound objects that were loaded using the Sound.load() method. For Sound objects that are associated with a sound asset from a SWF's library, the value of the url property is null.


Implementation
    public function get url():String
Constructor Detail
SoundLoader()Constructor
public function SoundLoader(sound:CoreSound = null)

Creates a new SoundLoader instance.

Parameters
sound:CoreSound (default = null) — The Sound object to load.
Method Detail
_id3()method
protected function _id3(e:Event):void

Invoked when the Event.ID3 event is fired.

Parameters

e:Event

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

This protected method contains the invokation of the load method of the current loader of this process.

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

Cancels a load() method operation that is currently in progress for the Loader instance.

notifyId3()method 
public function notifyId3():void

Notify when the process is initialize.

register()method 
override public function register(dispatcher:IEventDispatcher):void

Register the loader object.

Parameters

dispatcher:IEventDispatcher

stop()method 
public function stop():void

Stops the process if is running

unregister()method 
override public function unregister(dispatcher:IEventDispatcher):void

Unregister the loader object.

Parameters

dispatcher:IEventDispatcher





Mardi Août 16 2011, 02:33 PM +02:00