Packageorg.flowplayer.view
Classpublic class FlowplayerBase
InheritanceFlowplayerBase Inheritance org.flowplayer.view.PlayerEventDispatcher
Implementsorg.flowplayer.view.ErrorHandler
SubclassesFlowplayer



Public Properties
 PropertyDefined by
  animationEngine : AnimationEngine
[read-only] Gets the animation engine.
FlowplayerBase
  config : Config
[read-only] Flowplayer configuration.
FlowplayerBase
  currentClip : Clip
[read-only] Gets the current clip (the clip currently playing or the next one to be played when playback is started).
FlowplayerBase
  fonts : Array
[read-only] Gets the fonts that have been loaded as plugins.
FlowplayerBase
  fullscreenManager : FullscreenManager
[write-only]
FlowplayerBase
  id : String
[read-only] Gets the player's id.
FlowplayerBase
  muted : Boolean
Is the volume muted?
FlowplayerBase
  playlist : Playlist
[read-only] Gets the playList.
FlowplayerBase
  playlistController : PlayListController
[write-only]
FlowplayerBase
  pluginLoader : PluginLoader
[write-only]
FlowplayerBase
  pluginRegistry : PluginRegistry
[read-only] Gets the plugin registry.
FlowplayerBase
  state : State
[read-only] Gets the player state.
FlowplayerBase
  status : Status
[read-only] Gets the current status {
FlowplayerBase
  version : Array
[read-only] Gets the Flowplayer version number.
FlowplayerBase
  volume : Number
Gets the current volume level.
FlowplayerBase
Protected Properties
 PropertyDefined by
  _animationEngine : AnimationEngine
FlowplayerBase
  _config : Config
FlowplayerBase
  _panel : Panel
FlowplayerBase
  playButtonOverlay : DisplayProperties
[read-only]
FlowplayerBase
  _playListController : PlayListController
FlowplayerBase
  _pluginRegistry : PluginRegistry
FlowplayerBase
  screen : Screen
[read-only]
FlowplayerBase
Public Methods
 MethodDefined by
  
FlowplayerBase(stage:Stage, pluginRegistry:PluginRegistry, panel:Panel, animationEngine:AnimationEngine, errorHandler:ErrorHandler, config:Config, playerSWFBaseURL:String)
FlowplayerBase
  
addClip(clip:Clip, index:int = -1):void
Adds a new clip into the playlist.
FlowplayerBase
  
addToPanel(displayObject:DisplayObject, props:Object, resizeListener:Function = null):void
Adds the specified display object to the panel.
FlowplayerBase
  
Stops the player and closes the stream and connection.
FlowplayerBase
  
createLoader():ResourceLoader
Creates a new resource loader.
FlowplayerBase
  
createTextField(fontSize:int = 12, bold:Boolean = false):TextField
Creates a text field with default font.
FlowplayerBase
  
doTogglePlugin(disp:DisplayObject, props:DisplayProperties = null):Boolean
FlowplayerBase
  
handleError(error:PlayerError, info:Object = null, throwError:Boolean = true):void
Handles the specified error.
FlowplayerBase
  
hidePlugin(pluginName:String):void
FlowplayerBase
  
isFullscreen():Boolean
Is the player in fullscreen mode?
FlowplayerBase
  
isPaused():Boolean
Is the player currently paused?
FlowplayerBase
  
isPlaying():Boolean
Is the player currently playing?
FlowplayerBase
  
loadPlugin(pluginName:String, url:String, callback:Function):void
Loads the specified plugin.
FlowplayerBase
  
logging(level:String, filter:String = "*"):void
Configures logging.
FlowplayerBase
  
Moves to next clip in playList.
FlowplayerBase
  
Pauses the current clip.
FlowplayerBase
  
play(clip:Clip = null):FlowplayerBase
Plays the current clip in playList or the specified clip.
FlowplayerBase
  
Moves to previous clip in playList.
FlowplayerBase
  
reset(pluginNames:Array = null, speed:Number = 500):void
Resets the screen and the controls to their orginal display properties
FlowplayerBase
  
Resumes playback of the current clip.
FlowplayerBase
  
seek(seconds:Number):FlowplayerBase
Seeks to the specified target second value in the clip's timeline.
FlowplayerBase
  
Seeks to the specified point.
FlowplayerBase
  
setPlaylist(playlist:Array):void
Sets a new playlist.
FlowplayerBase
  
showError(message:String):void
Shows the specified error message in the player area.
FlowplayerBase
  
showPlugin(pluginName:String, props:Object = null):void
FlowplayerBase
  
Starts buffering the current clip in playList.
FlowplayerBase
  
Stops the player and rewinds to the beginning of the playList.
FlowplayerBase
  
Stops buffering.
FlowplayerBase
  
toggle():Boolean
Toggles between paused and resumed states.
FlowplayerBase
  
Toggles between the full-screen and normal display modeds.
FlowplayerBase
  
togglePlugin(pluginName:String, props:Object = null):Boolean
FlowplayerBase
Protected Methods
 MethodDefined by
  
checkPlugin(plugin:Object, pluginName:String, RequiredClass:Class = null):void
FlowplayerBase
  
doShowPlugin(disp:DisplayObject, displayProps:Object):void
FlowplayerBase
  
loadPluginLoadable(loadable:Loadable, callback:Function = null):void
FlowplayerBase
Property detail
_animationEngineproperty
protected var _animationEngine:AnimationEngine
animationEngineproperty 
animationEngine:AnimationEngine  [read-only]

Gets the animation engine.

Implementation
    public function get animationEngine():AnimationEngine
_configproperty 
protected var _config:Config
configproperty 
config:Config  [read-only]

Flowplayer configuration.

Implementation
    public function get config():Config
currentClipproperty 
currentClip:Clip  [read-only]

Gets the current clip (the clip currently playing or the next one to be played when playback is started).

Implementation
    public function get currentClip():Clip
fontsproperty 
fonts:Array  [read-only]

Gets the fonts that have been loaded as plugins.

Implementation
    public function get fonts():Array
fullscreenManagerproperty 
fullscreenManager:FullscreenManager  [write-only]Implementation
    public function set fullscreenManager(value:FullscreenManager):void
idproperty 
id:String  [read-only]

Gets the player's id.

Implementation
    public function get id():String
mutedproperty 
muted:Boolean  [read-write]

Is the volume muted?

Implementation
    public function get muted():Boolean
    public function set muted(value:Boolean):void
_panelproperty 
protected var _panel:Panel
playButtonOverlayproperty 
playButtonOverlay:DisplayProperties  [read-only]Implementation
    protected function get playButtonOverlay():DisplayProperties
playlistproperty 
playlist:Playlist  [read-only]

Gets the playList.

Implementation
    public function get playlist():Playlist
playlistControllerproperty 
playlistController:PlayListController  [write-only]Implementation
    public function set playlistController(value:PlayListController):void
_playListControllerproperty 
protected var _playListController:PlayListController
pluginLoaderproperty 
pluginLoader:PluginLoader  [write-only]Implementation
    public function set pluginLoader(value:PluginLoader):void
_pluginRegistryproperty 
protected var _pluginRegistry:PluginRegistry
pluginRegistryproperty 
pluginRegistry:PluginRegistry  [read-only]

Gets the plugin registry.

Implementation
    public function get pluginRegistry():PluginRegistry
screenproperty 
screen:Screen  [read-only]Implementation
    protected function get screen():Screen
stateproperty 
state:State  [read-only]

Gets the player state.

Implementation
    public function get state():State
statusproperty 
status:Status  [read-only]

Gets the current status {

Implementation
    public function get status():Status
versionproperty 
version:Array  [read-only]

Gets the Flowplayer version number.

Implementation
    public function get version():Array
volumeproperty 
volume:Number  [read-write]

Gets the current volume level.

Implementation
    public function get volume():Number
    public function set volume(value:Number):void
Constructor detail
FlowplayerBase()constructor
public function FlowplayerBase(stage:Stage, pluginRegistry:PluginRegistry, panel:Panel, animationEngine:AnimationEngine, errorHandler:ErrorHandler, config:Config, playerSWFBaseURL:String)Parameters
stage:Stage
 
pluginRegistry:PluginRegistry
 
panel:Panel
 
animationEngine:AnimationEngine
 
errorHandler:ErrorHandler
 
config:Config
 
playerSWFBaseURL:String
Method detail
addClip()method
public function addClip(clip:Clip, index:int = -1):void

Adds a new clip into the playlist. Insertion of clips does not change the current clip.

Parameters
clip:Clip
 
index:int (default = -1) — optional insertion point, if not given the clip is added to the end of the list.
addToPanel()method 
public function addToPanel(displayObject:DisplayObject, props:Object, resizeListener:Function = null):void

Adds the specified display object to the panel.

Parameters
displayObject:DisplayObject
 
props:Object
 
resizeListener:Function (default = null)
checkPlugin()method 
protected function checkPlugin(plugin:Object, pluginName:String, RequiredClass:Class = null):voidParameters
plugin:Object
 
pluginName:String
 
RequiredClass:Class (default = null)
close()method 
public function close():FlowplayerBase

Stops the player and closes the stream and connection.

Returns
FlowplayerBase
createLoader()method 
public function createLoader():ResourceLoader

Creates a new resource loader.

Returns
ResourceLoader
createTextField()method 
public function createTextField(fontSize:int = 12, bold:Boolean = false):TextField

Creates a text field with default font. If the player configuration has a FontProvider plugin configured, we'll use that. Otherwise platform fonts are used, the platform font search string used to specify the font is: "Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Bitstream Vera, Verdana, Arial, _sans, _serif"

Parameters
fontSize:int (default = 12)
 
bold:Boolean (default = false)

Returns
TextField
doShowPlugin()method 
protected function doShowPlugin(disp:DisplayObject, displayProps:Object):voidParameters
disp:DisplayObject
 
displayProps:Object
doTogglePlugin()method 
public function doTogglePlugin(disp:DisplayObject, props:DisplayProperties = null):BooleanParameters
disp:DisplayObject
 
props:DisplayProperties (default = null)

Returns
Boolean
handleError()method 
public function handleError(error:PlayerError, info:Object = null, throwError:Boolean = true):void

Handles the specified error.

Parameters
error:PlayerError
 
info:Object (default = null)
 
throwError:Boolean (default = true)
hidePlugin()method 
public function hidePlugin(pluginName:String):voidParameters
pluginName:String
isFullscreen()method 
public function isFullscreen():Boolean

Is the player in fullscreen mode?

Returns
Boolean
isPaused()method 
public function isPaused():Boolean

Is the player currently paused?

Returns
Boolean — true if the player is currently in the paused state

See also

isPlaying()method 
public function isPlaying():Boolean

Is the player currently playing?

Returns
Boolean — true if the player is currently in the playing or buffering state

See also

loadPlugin()method 
public function loadPlugin(pluginName:String, url:String, callback:Function):void

Loads the specified plugin.

Parameters
pluginName:String — the plugin to load
 
url:String — a function to call when the loading is complete
 
callback:Function
loadPluginLoadable()method 
protected function loadPluginLoadable(loadable:Loadable, callback:Function = null):voidParameters
loadable:Loadable
 
callback:Function (default = null)
logging()method 
public function logging(level:String, filter:String = "*"):void

Configures logging.

Parameters
level:String
 
filter:String (default = "*")
next()method 
public function next():Clip

Moves to next clip in playList.

Returns
Clip
pause()method 
public function pause():FlowplayerBase

Pauses the current clip.

Returns
FlowplayerBase
play()method 
public function play(clip:Clip = null):FlowplayerBase

Plays the current clip in playList or the specified clip.

Parameters
clip:Clip (default = null) — an optional clip to play. If specified it will replace the player's playlist.

Returns
FlowplayerBase
previous()method 
public function previous():Clip

Moves to previous clip in playList.

Returns
Clip
reset()method 
public function reset(pluginNames:Array = null, speed:Number = 500):void

Resets the screen and the controls to their orginal display properties

Parameters
pluginNames:Array (default = null)
 
speed:Number (default = 500)
resume()method 
public function resume():FlowplayerBase

Resumes playback of the current clip.

Returns
FlowplayerBase
seek()method 
public function seek(seconds:Number):FlowplayerBase

Seeks to the specified target second value in the clip's timeline.

Parameters
seconds:Number

Returns
FlowplayerBase
seekRelative()method 
public function seekRelative(value:Number):FlowplayerBase

Seeks to the specified point.

Parameters
value:Number — point in the timeline, between 0 and 100

Returns
FlowplayerBase
setPlaylist()method 
public function setPlaylist(playlist:Array):void

Sets a new playlist.

Parameters
playlist:Array — an array of Clip instances

See also

ClipEventType.PLAYLIST_REPLACE
showError()method 
public function showError(message:String):void

Shows the specified error message in the player area.

Parameters
message:String
showPlugin()method 
public function showPlugin(pluginName:String, props:Object = null):voidParameters
pluginName:String
 
props:Object (default = null)
startBuffering()method 
public function startBuffering():FlowplayerBase

Starts buffering the current clip in playList.

Returns
FlowplayerBase
stop()method 
public function stop():FlowplayerBase

Stops the player and rewinds to the beginning of the playList.

Returns
FlowplayerBase
stopBuffering()method 
public function stopBuffering():FlowplayerBase

Stops buffering.

Returns
FlowplayerBase
toggle()method 
public function toggle():Boolean

Toggles between paused and resumed states.

Returns
Boolean — true if the player is playing after the call, false if it's paused
toggleFullscreen()method 
public function toggleFullscreen():FlowplayerBase

Toggles between the full-screen and normal display modeds.

Returns
FlowplayerBase
togglePlugin()method 
public function togglePlugin(pluginName:String, props:Object = null):BooleanParameters
pluginName:String
 
props:Object (default = null)

Returns
Boolean