| Package | com.adobe.mediacore |
| Class | public class MediaPlayerItemLoader |
| Inheritance | MediaPlayerItemLoader  flash.events.EventDispatcher |
| Subclasses | DefaultMediaPlayerItemLoader |
| Property | Defined By | ||
|---|---|---|---|
| item : MediaPlayerItem [read-only]
The current media player item successfully loaded. | MediaPlayerItemLoader | ||
| Method | Defined By | ||
|---|---|---|---|
Default constructor. | MediaPlayerItemLoader | ||
cancel():void
Cancels a pending loading process. | MediaPlayerItemLoader | ||
Starts the loading process of specified media resource. | MediaPlayerItemLoader | ||
| Method | Defined By | ||
|---|---|---|---|
doCancel():void
Actual media player item loaders should override this method to
implement their actual cancel mechanism. | MediaPlayerItemLoader | ||
Actual media player item loaders should override this method to
implement their actual load mechanism. | MediaPlayerItemLoader | ||
handleLoadCompleted(item:MediaPlayerItem):void
Callback method invoked by subclasses to notify a successful load operation. | MediaPlayerItemLoader | ||
handleLoadFailed(error:MediaError):void
Callback method invoked by subclasses to notify an failed load operation. | MediaPlayerItemLoader | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Event dispatched by the MediaPlayerItemLoader once the loading operation completes successfully. | MediaPlayerItemLoader | |||
| Event dispatched by the MediaPlayerItemLoader once the loading operation has failed. | MediaPlayerItemLoader | |||
| item | property |
item:MediaPlayerItem [read-only] The current media player item successfully loaded.
public function get item():MediaPlayerItem| MediaPlayerItemLoader | () | Constructor |
public function MediaPlayerItemLoader()Default constructor.
| cancel | () | method |
public final function cancel():voidCancels a pending loading process.
| doCancel | () | method |
protected function doCancel():voidActual media player item loaders should override this method to implement their actual cancel mechanism.
| doLoad | () | method |
protected function doLoad(resource:MediaResource, resourceId:int, config:MediaPlayerItemConfig):voidActual media player item loaders should override this method to implement their actual load mechanism.
Parameters
resource:MediaResource — Media resource to be loaded.
| |
resourceId:int — Associated media resource id.
| |
config:MediaPlayerItemConfig — Media player item configuration to be used with this resource. The configuration
parameter can be null and in that scenario the media player item loader should
use a default configuration.
|
| handleLoadCompleted | () | method |
protected function handleLoadCompleted(item:MediaPlayerItem):voidCallback method invoked by subclasses to notify a successful load operation.
Parameters
item:MediaPlayerItem — Media player item obtained after loading.
|
| handleLoadFailed | () | method |
protected function handleLoadFailed(error:MediaError):voidCallback method invoked by subclasses to notify an failed load operation.
Parameters
error:MediaError — Media error which occurred during loading process.
|
| load | () | method |
public final function load(resource:MediaResource, resourceId:int, config:MediaPlayerItemConfig = null):voidStarts the loading process of specified media resource.
Parameters
resource:MediaResource — Media resource to be loaded.
| |
resourceId:int — Associated media resource id.
| |
config:MediaPlayerItemConfig (default = null) |
| completed | Event |
com.adobe.mediacore.events.MediaPlayerItemLoaderEventEvent dispatched by the MediaPlayerItemLoader once the loading operation completes successfully. The newly created MediaPlayerItem instance is available as item property of the event.
| failed | Event |
com.adobe.mediacore.events.MediaPlayerItemLoaderEventEvent dispatched by the MediaPlayerItemLoader once the loading operation has failed. The MediaError instance containing additional information about what went wrong is available as error property of the event.