| Package | sekati.ui |
| Class | public class MP3Player |
| Inheritance | MP3Player  AbstractMediaPlayer LiquidSprite CoreSprite flash.display.Sprite |
To implement pass references to UI controller instances to the MP3Player
constructor & instantiate the MP3Player instance.
var player : MP3Player = new MP3Player( playBtn, progressBar, bufferBar, gutterBar, volumeBtn ); player.init( 'path/to/my.mp3' );
See also
| Property | Defined by | ||
|---|---|---|---|
| audio : MP3
[read-only]
The
MP3 being played. | MP3Player | ||
 | bufferBarPercent : Number
Buffer bar scale percent (0-1).
| AbstractMediaPlayer | |
| currentID3 : Object [read-only]
Returns reference to current ID3 data object.
| MP3Player | ||
| enabled : Boolean
Enabled property defines whether liquid eventing is available or not.
| LiquidSprite | |
| interactiveMode : Boolean
Specifies the mouse cursors modal state in the object as an interactive
target via:
buttonMode, mouseChildren & tabChildren. | CoreSprite | |
| media : IProgressiveMedia
The
IProgressiveMedia being played. | AbstractMediaPlayer | |
| progressBarPercent : Number
Progress bar scale percent (0-1).
| AbstractMediaPlayer | |
| scale : Number
The
scale value. | CoreSprite | |
| sound : Sound [read-only]
The
Sound instance. | MP3Player | ||
| Property | Defined by | ||
|---|---|---|---|
| _bufferBar : Sprite | AbstractMediaPlayer | |
| _defaultPan : Number | MP3Player | ||
| _defaultVolume : Number | MP3Player | ||
| _gutterBar : Sprite | AbstractMediaPlayer | |
| _id3 : Object | MP3Player | ||
| _isBufferPaused : Boolean | AbstractMediaPlayer | |
| _isDrag : Boolean | AbstractMediaPlayer | |
| _isSeeking : Boolean | AbstractMediaPlayer | |
| _media : IProgressiveMedia | AbstractMediaPlayer | |
| _playBtn : MovieClip | AbstractMediaPlayer | |
| _progressBar : Sprite | AbstractMediaPlayer | |
| _volumeBtn : Sprite | AbstractMediaPlayer | |
| _wasPlaying : Boolean | AbstractMediaPlayer | |
| Method | Defined by | ||
|---|---|---|---|
|
MP3Player(playBtn:MovieClip, progressBar:Sprite, bufferBar:Sprite, gutterBar:Sprite, volumeBtn:Sprite, volume:Number = 1, pan:Number = 0)
MP3Player Constructor
| MP3Player | ||
|
addChildren(... args):void
Add multiple child
DisplayObject's. | CoreSprite | |
|
destroy():void
Clean up after thy self.
| AbstractMediaPlayer | |
|
init(url:String, buffer:uint = 4):void
load audio and initialize MP3Player UI and MP3.
| MP3Player | ||
|
pause():void
Pause playback
| AbstractMediaPlayer | |
|
remove():void
Remove the
IProgressiveMedia from player. | AbstractMediaPlayer | |
|
reset():void
Reset the interface.
| AbstractMediaPlayer | |
|
resume():void
Resume playback
| AbstractMediaPlayer | |
|
setVolume(percent:Number):void
Core video volume driver.
| AbstractMediaPlayer | |
|
toString():String
Return reflective output.
| CoreSprite | |
| Method | Defined by | ||
|---|---|---|---|
|
addMediaListeners():void
Add
MediaEvent.PROGRESS & other IProgressiveMedia events. | MP3Player | ||
|
addUIListeners():void
Add UI listers.
| AbstractMediaPlayer | |
|
bufferBarDown(e:MouseEvent):void
_bufferBar pressed: being seeking. | AbstractMediaPlayer | |
|
bufferBarMove(e:MouseEvent):void
_bufferBar scrubbing: seek. | AbstractMediaPlayer | |
|
bufferBarUp(e:MouseEvent):void
_bufferBar released: stop seeking. | AbstractMediaPlayer | |
|
bufferPause(e:MediaEvent):void
When playhead enters area that needs buffering, pause the
IProgressiveMedia if playing. | AbstractMediaPlayer | |
|
bufferResume(e:MediaEvent):void
When
IProgressiveMedia has finished buffering check to see if media was paused to allow for buffering
if it was restart, if not, do nothing. | AbstractMediaPlayer | |
|
configListeners(isAdd:Boolean = false):void
Event listener management.
| LiquidSprite | |
|
createMedia():void
Instantiate
IProgressiveMedia (stub). | MP3Player | ||
|
fullscreen(e:StageEvent = null):void
Stub: fires when
StageDisplay dispatches a FULLSCREEN event. | LiquidSprite | |
|
invalidate():void
Request a redraw, use for deferred rendering.
| CoreSprite | |
|
offStage(e:Event = null):void
Stub: Sprite has been removed from stage.
| LiquidSprite | |
|
onStage(e:Event = null):void
Stub: Sprite has been added to stage.
| LiquidSprite | |
|
pauseMemory():void
Pause video in memory and track state.
| AbstractMediaPlayer | |
|
playBtnClick(e:MouseEvent = null):void
Toggle the framed
_playBtn icon and pause/resume playback. | AbstractMediaPlayer | |
|
progressHandler(e:MediaEvent):void
Handle
MediaEvent.PROGRESS event: update the buffer and progress bars. | AbstractMediaPlayer | |
|
removeMediaListeners():void
Remove
MediaEvent.PROGRESS & other IProgressiveMedia events. | MP3Player | ||
|
removeUIListeners():void
Remove UI listers.
| AbstractMediaPlayer | |
|
resize(e:StageEvent = null):void
Stub: fires when
StageDisplay dispatches a RESIZE event. | AbstractMediaPlayer | |
|
resizeComplete(e:StageEvent = null):void
Stub: fires when
StageDisplay dispatches a RESIZE_COMPLETE event. | LiquidSprite | |
|
resumeMemory():void
Resume video from member and release state.
| AbstractMediaPlayer | |
|
seekUI():void
Use guttBar to prevent seek offset inaccuracy while still buffering.
| AbstractMediaPlayer | |
|
setPauseIcon():void
Set the
_playBtn icon "paused". | AbstractMediaPlayer | |
|
setPlayIcon():void
Set the
_playBtn icon "played". | AbstractMediaPlayer | |
|
statusHandler(e:MediaEvent):void
Handle & re-dispatch the
MediaEvent status events (since
AbstractMediaPlayer subclasses have the option of being added to
stage and bubbling these events unlike IProgressiveMedia classes). | MP3Player | ||
|
volumeBtnDown(e:MouseEvent):void
_volumeBtn pressed: begin volume control. | AbstractMediaPlayer | |
|
volumeBtnMove(e:MouseEvent):void
_volumeBtn scrubbing: change volume. | AbstractMediaPlayer | |
|
volumeBtnUp(e:MouseEvent):void
_volumeBtn released: end volume control. | AbstractMediaPlayer | |
| audio | property |
| currentID3 | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescurrentID3:Object [read-only]Returns reference to current ID3 data object.
Implementation public function get currentID3():Object
| _defaultPan | property |
protected var _defaultPan:Number
| _defaultVolume | property |
protected var _defaultVolume:Number
| _id3 | property |
protected var _id3:Object
| sound | property |
sound:Sound [read-only]
The Sound instance.
public function get sound():Sound
| MP3Player | () | constructor |
public function MP3Player(playBtn:MovieClip, progressBar:Sprite, bufferBar:Sprite, gutterBar:Sprite, volumeBtn:Sprite, volume:Number = 1, pan:Number = 0)MP3Player Constructor
ParametersplayBtn:MovieClip — reference to play UI control.
|
|
progressBar:Sprite — reference to progress UI to control.
|
|
bufferBar:Sprite — reference to buffer UI control.
|
|
gutterBar:Sprite — reference to gutter UI to control.
|
|
volumeBtn:Sprite — reference to volume UI to control.
|
|
volume:Number (default = 1) |
|
pan:Number (default = 0) |
| addMediaListeners | () | method |
protected override function addMediaListeners():void
Add MediaEvent.PROGRESS & other IProgressiveMedia events.
| createMedia | () | method |
protected override function createMedia():void
Instantiate IProgressiveMedia (stub).
| init | () | method |
public override function init(url:String, buffer:uint = 4):voidload audio and initialize MP3Player UI and MP3.
Parametersurl:String — of mp3 file.
|
|
buffer:uint (default = 4) |
| removeMediaListeners | () | method |
protected override function removeMediaListeners():void
Remove MediaEvent.PROGRESS & other IProgressiveMedia events.
| statusHandler | () | method |
protected override function statusHandler(e:MediaEvent):void
Handle & re-dispatch the MediaEvent status events (since
AbstractMediaPlayer subclasses have the option of being added to
stage and bubbling these events unlike IProgressiveMedia classes).
It is best to implement your own switch/case subclass code for granular event responses.
Parameterse:MediaEvent |