Packagesekati.ui
Classpublic class AbstractMediaPlayer
InheritanceAbstractMediaPlayer Inheritance LiquidSprite Inheritance CoreSprite Inheritance flash.display.Sprite
SubclassesFLVPlayer, MP3Player

AbstractMediaPlayer provides abstract player control logic for audio/video players and the likes.



Public Properties
 PropertyDefined by
  bufferBarPercent : Number
Buffer bar scale percent (0-1).
AbstractMediaPlayer
 Inheritedenabled : Boolean
Enabled property defines whether liquid eventing is available or not.
LiquidSprite
 InheritedinteractiveMode : Boolean
Specifies the mouse cursors modal state in the object as an interactive target via: buttonMode, mouseChildren & tabChildren.
CoreSprite
  media : IProgressiveMedia
[read-only] The IProgressiveMedia being played.
AbstractMediaPlayer
  progressBarPercent : Number
Progress bar scale percent (0-1).
AbstractMediaPlayer
 Inheritedscale : Number
The scale value.
CoreSprite
Protected Properties
 PropertyDefined by
  _bufferBar : Sprite
AbstractMediaPlayer
  _gutterBar : Sprite
AbstractMediaPlayer
  _isBufferPaused : Boolean
AbstractMediaPlayer
  _isDrag : Boolean
AbstractMediaPlayer
  _isSeeking : Boolean
AbstractMediaPlayer
  _media : IProgressiveMedia
AbstractMediaPlayer
  _playBtn : MovieClip
AbstractMediaPlayer
  _progressBar : Sprite
AbstractMediaPlayer
  _volumeBtn : Sprite
AbstractMediaPlayer
  _wasPlaying : Boolean
AbstractMediaPlayer
Public Methods
 MethodDefined by
  
AbstractMediaPlayer(playBtn:MovieClip, progressBar:Sprite, bufferBar:Sprite, gutterBar:Sprite, volumeBtn:Sprite)
AbstractMediaPlayer Constructor
AbstractMediaPlayer
 Inherited
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 and initialize the player UI and IProgressiveMedia.
AbstractMediaPlayer
  
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
 Inherited
toString():String
Return reflective output.
CoreSprite
Protected Methods
 MethodDefined by
  
Add MediaEvent.PROGRESS & other IProgressiveMedia events.
AbstractMediaPlayer
  
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
  
When playhead enters area that needs buffering, pause the IProgressiveMedia if playing.
AbstractMediaPlayer
  
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
 Inherited
configListeners(isAdd:Boolean = false):void
Event listener management.
LiquidSprite
  
createMedia():void
Instantiate IProgressiveMedia (stub).
AbstractMediaPlayer
 Inherited
fullscreen(e:StageEvent = null):void
Stub: fires when StageDisplay dispatches a FULLSCREEN event.
LiquidSprite
 Inherited
invalidate():void
Request a redraw, use for deferred rendering.
CoreSprite
 Inherited
offStage(e:Event = null):void
Stub: Sprite has been removed from stage.
LiquidSprite
 Inherited
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
  
Handle MediaEvent.PROGRESS event: update the buffer and progress bars.
AbstractMediaPlayer
  
Remove MediaEvent.PROGRESS & other IProgressiveMedia events.
AbstractMediaPlayer
  
Remove UI listers.
AbstractMediaPlayer
  
resize(e:StageEvent = null):void
Stub: fires when StageDisplay dispatches a RESIZE event.
AbstractMediaPlayer
 Inherited
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
  
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).
AbstractMediaPlayer
  
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
Property detail
_bufferBarproperty
protected var _bufferBar:Sprite
bufferBarPercentproperty 
bufferBarPercent:Number  [read-write]

Buffer bar scale percent (0-1).

Implementation
    public function get bufferBarPercent():Number
    public function set bufferBarPercent(value:Number):void
_gutterBarproperty 
protected var _gutterBar:Sprite
_isBufferPausedproperty 
protected var _isBufferPaused:Boolean
_isDragproperty 
protected var _isDrag:Boolean
_isSeekingproperty 
protected var _isSeeking:Boolean
_mediaproperty 
protected var _media:IProgressiveMedia
mediaproperty 
media:IProgressiveMedia  [read-only]

The IProgressiveMedia being played.

Implementation
    public function get media():IProgressiveMedia
_playBtnproperty 
protected var _playBtn:MovieClip
_progressBarproperty 
protected var _progressBar:Sprite
progressBarPercentproperty 
progressBarPercent:Number  [read-write]

Progress bar scale percent (0-1).

Implementation
    public function get progressBarPercent():Number
    public function set progressBarPercent(value:Number):void
_volumeBtnproperty 
protected var _volumeBtn:Sprite
_wasPlayingproperty 
protected var _wasPlaying:Boolean
Constructor detail
AbstractMediaPlayer()constructor
public function AbstractMediaPlayer(playBtn:MovieClip, progressBar:Sprite, bufferBar:Sprite, gutterBar:Sprite, volumeBtn:Sprite)

AbstractMediaPlayer Constructor

Parameters
playBtn: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.
Method detail
addMediaListeners()method
protected function addMediaListeners():void

Add MediaEvent.PROGRESS & other IProgressiveMedia events.

addUIListeners()method 
protected function addUIListeners():void

Add UI listers.

bufferBarDown()method 
protected function bufferBarDown(e:MouseEvent):void

_bufferBar pressed: being seeking.

Parameters
e:MouseEvent
bufferBarMove()method 
protected function bufferBarMove(e:MouseEvent):void

_bufferBar scrubbing: seek.

Parameters
e:MouseEvent
bufferBarUp()method 
protected function bufferBarUp(e:MouseEvent):void

_bufferBar released: stop seeking.

Parameters
e:MouseEvent
bufferPause()method 
protected function bufferPause(e:MediaEvent):void

When playhead enters area that needs buffering, pause the IProgressiveMedia if playing.

Parameters
e:MediaEvent
bufferResume()method 
protected function 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. This prevents the media from restarting if it was user paused, and then playhead dragged into buffering area.

Parameters
e:MediaEvent
createMedia()method 
protected function createMedia():void

Instantiate IProgressiveMedia (stub).

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

Clean up after thy self.

init()method 
public function init(url:String, buffer:uint = 4):void

Load and initialize the player UI and IProgressiveMedia.

Parameters
url:String — of IProgressiveMedia to be played.
 
buffer:uint (default = 4) — in seconds.
pause()method 
public function pause():void

Pause playback

pauseMemory()method 
protected function pauseMemory():void

Pause video in memory and track state.

playBtnClick()method 
protected function playBtnClick(e:MouseEvent = null):void

Toggle the framed _playBtn icon and pause/resume playback.

Parameters
e:MouseEvent (default = null)
progressHandler()method 
protected function progressHandler(e:MediaEvent):void

Handle MediaEvent.PROGRESS event: update the buffer and progress bars.

Parameters
e:MediaEvent
remove()method 
public function remove():void

Remove the IProgressiveMedia from player.

removeMediaListeners()method 
protected function removeMediaListeners():void

Remove MediaEvent.PROGRESS & other IProgressiveMedia events.

removeUIListeners()method 
protected function removeUIListeners():void

Remove UI listers.

reset()method 
public function reset():void

Reset the interface.

resize()method 
protected override function resize(e:StageEvent = null):void

Stub: fires when StageDisplay dispatches a RESIZE event.

Parameters
e:StageEvent (default = null)
resume()method 
public function resume():void

Resume playback

resumeMemory()method 
protected function resumeMemory():void

Resume video from member and release state.

seekUI()method 
protected function seekUI():void

Use guttBar to prevent seek offset inaccuracy while still buffering.

setPauseIcon()method 
protected function setPauseIcon():void

Set the _playBtn icon "paused".

setPlayIcon()method 
protected function setPlayIcon():void

Set the _playBtn icon "played".

setVolume()method 
public function setVolume(percent:Number):void

Core video volume driver.

Parameters
percent:Number
statusHandler()method 
protected 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.

Parameters
e:MediaEvent
volumeBtnDown()method 
protected function volumeBtnDown(e:MouseEvent):void

_volumeBtn pressed: begin volume control.

Parameters
e:MouseEvent
volumeBtnMove()method 
protected function volumeBtnMove(e:MouseEvent):void

_volumeBtn scrubbing: change volume.

Parameters
e:MouseEvent
volumeBtnUp()method 
protected function volumeBtnUp(e:MouseEvent):void

_volumeBtn released: end volume control.

Parameters
e:MouseEvent