Package | com.distriqt.extension.webp.loader |
Interface | public interface WebPLoader extends flash.events.IEventDispatcher |
This class represents a WebP Loader.
It provides the ability to asynchronously load a WebP file and use the decoded bitmap data.
You should call dispose()
as soon as you are finished with the loader.
Method | Defined By | ||
---|---|---|---|
dispose():void
Dispose the loader, releasing any loaded data. | WebPLoader | ||
load(path:String):Boolean
Start the load of a WebP file. | WebPLoader |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the load operation is completed and the decoded WebP data is available. | WebPLoader | |||
Dispatched when an error occurred while loading a WebP file | WebPLoader |
dispose | () | method |
public function dispose():void
Dispose the loader, releasing any loaded data. You should call this function when you have finished processing any loaded data.
load | () | method |
public function load(path:String):Boolean
Start the load of a WebP file.
Parameters
path:String — The native path to the file
|
Boolean — true if the load was commenced successfully
and false if the load could not start,
most likely if another load process is in progress.
|
complete | Event |
com.distriqt.extension.webp.events.WebPLoaderEvent
com.distriqt.extension.webp.events.WebPLoaderEvent.COMPLETE
Dispatched when the load operation is completed and the decoded WebP data is available.
data
will contain valid information about the decoded file.
error | Event |
com.distriqt.extension.webp.events.WebPErrorEvent
com.distriqt.extension.webp.events.WebPErrorEvent.ERROR
Dispatched when an error occurred while loading a WebP file
var loader:WebPLoader = WebP.service.createLoader(); loader.addEventListener( WebPLoaderEvent.COMPLETE, loader_completeHandler ); loader.addEventListener( WebPErrorEvent.ERROR, loader_errorHandler ); var success:Boolean = loader.load( file.url ); ... private function loader_completeHandler( event:WebPLoaderEvent ):void { message( "loader complete" ); displayBitmapData( event.data.convertToBitmapData() ); var loader:WebPLoader = WebPLoader(event.currentTarget); loader.removeEventListener( WebPLoaderEvent.COMPLETE, loader_completeHandler ); loader.removeEventListener( WebPErrorEvent.ERROR, loader_errorHandler ); loader.dispose(); } private function loader_errorHandler( event:WebPErrorEvent ):void { message( "loader error ::["+event.code+"] "+event.error ); var loader:WebPLoader = WebPLoader(event.currentTarget); loader.removeEventListener( WebPLoaderEvent.COMPLETE, loader_completeHandler ); loader.removeEventListener( WebPErrorEvent.ERROR, loader_errorHandler ); loader.dispose(); }