Package | org.flowplayer.view |
Class | public class FlowplayerBase |
Inheritance | FlowplayerBase ![]() |
Implements | org.flowplayer.view.ErrorHandler |
Subclasses | Flowplayer |
Property | Defined 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 |
Property | Defined 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 |
Method | Defined by | ||
---|---|---|---|
FlowplayerBase(stage:Stage, pluginRegistry:PluginRegistry, panel:Panel, animationEngine:AnimationEngine, errorHandler:ErrorHandler, config:Config, playerSWFBaseURL:String)
| FlowplayerBase | ||
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 | ||
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 | ||
seekRelative(value:Number):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 |
Method | Defined 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 |
_animationEngine | property |
protected var _animationEngine:AnimationEngine
animationEngine | property |
animationEngine:AnimationEngine
[read-only]Gets the animation engine.
Implementation public function get animationEngine():AnimationEngine
_config | property |
protected var _config:Config
config | property |
config:Config
[read-only]Flowplayer configuration.
Implementation public function get config():Config
currentClip | property |
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
fonts | property |
fonts:Array
[read-only]Gets the fonts that have been loaded as plugins.
Implementation public function get fonts():Array
fullscreenManager | property |
fullscreenManager:FullscreenManager
[write-only]Implementation
public function set fullscreenManager(value:FullscreenManager):void
id | property |
id:String
[read-only]Gets the player's id.
Implementation public function get id():String
muted | property |
muted:Boolean
[read-write]Is the volume muted?
Implementation public function get muted():Boolean
public function set muted(value:Boolean):void
_panel | property |
protected var _panel:Panel
playButtonOverlay | property |
playButtonOverlay:DisplayProperties
[read-only]Implementation
protected function get playButtonOverlay():DisplayProperties
playlist | property |
playlist:Playlist
[read-only]Gets the playList.
Implementation public function get playlist():Playlist
playlistController | property |
playlistController:PlayListController
[write-only]Implementation
public function set playlistController(value:PlayListController):void
_playListController | property |
protected var _playListController:PlayListController
pluginLoader | property |
pluginLoader:PluginLoader
[write-only]Implementation
public function set pluginLoader(value:PluginLoader):void
_pluginRegistry | property |
protected var _pluginRegistry:PluginRegistry
pluginRegistry | property |
pluginRegistry:PluginRegistry
[read-only]Gets the plugin registry.
Implementation public function get pluginRegistry():PluginRegistry
screen | property |
screen:Screen
[read-only]Implementation
protected function get screen():Screen
state | property |
state:State
[read-only]Gets the player state.
Implementation public function get state():State
status | property |
status:Status
[read-only]Gets the current status {
Implementation public function get status():Status
version | property |
version:Array
[read-only]Gets the Flowplayer version number.
Implementation public function get version():Array
volume | property |
volume:Number
[read-write]Gets the current volume level.
Implementation public function get volume():Number
public function set volume(value:Number):void
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 |
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.
Parametersclip: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.
ParametersdisplayObject:DisplayObject |
|
props:Object |
|
resizeListener:Function (default = null )
|
checkPlugin | () | method |
protected function checkPlugin(plugin:Object, pluginName:String, RequiredClass:Class = null):void
Parameters
plugin:Object |
|
pluginName:String |
|
RequiredClass:Class (default = null )
|
close | () | method |
public function close():FlowplayerBase
Stops the player and closes the stream and connection.
ReturnsFlowplayerBase |
createLoader | () | method |
public function createLoader():ResourceLoader
Creates a new resource loader.
ReturnsResourceLoader |
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"
ParametersfontSize:int (default = 12 )
|
|
bold:Boolean (default = false )
|
TextField |
doShowPlugin | () | method |
protected function doShowPlugin(disp:DisplayObject, displayProps:Object):void
Parameters
disp:DisplayObject |
|
displayProps:Object |
doTogglePlugin | () | method |
public function doTogglePlugin(disp:DisplayObject, props:DisplayProperties = null):Boolean
Parameters
disp:DisplayObject |
|
props:DisplayProperties (default = null )
|
Boolean |
handleError | () | method |
public function handleError(error:PlayerError, info:Object = null, throwError:Boolean = true):void
Handles the specified error.
Parameterserror:PlayerError |
|
info:Object (default = null )
|
|
throwError:Boolean (default = true )
|
hidePlugin | () | method |
public function hidePlugin(pluginName:String):void
Parameters
pluginName:String |
isFullscreen | () | method |
public function isFullscreen():Boolean
Is the player in fullscreen mode?
ReturnsBoolean |
isPaused | () | method |
public function isPaused():Boolean
Is the player currently paused?
ReturnsBoolean — true if the player is currently in the paused state
|
See also
isPlaying | () | method |
public function isPlaying():Boolean
Is the player currently playing?
ReturnsBoolean — 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.
ParameterspluginName: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):void
Parameters
loadable:Loadable |
|
callback:Function (default = null )
|
logging | () | method |
public function logging(level:String, filter:String = "*"):void
Configures logging.
Parameterslevel:String |
|
filter:String (default = "* ")
|
next | () | method |
pause | () | method |
play | () | method |
public function play(clip:Clip = null):FlowplayerBase
Plays the current clip in playList or the specified clip.
Parametersclip:Clip (default = null ) — an optional clip to play. If specified it will replace the player's
playlist.
|
FlowplayerBase |
previous | () | method |
reset | () | method |
public function reset(pluginNames:Array = null, speed:Number = 500):void
Resets the screen and the controls to their orginal display properties
ParameterspluginNames:Array (default = null )
|
|
speed:Number (default = 500 )
|
resume | () | method |
public function resume():FlowplayerBase
Resumes playback of the current clip.
ReturnsFlowplayerBase |
seek | () | method |
public function seek(seconds:Number):FlowplayerBase
Seeks to the specified target second value in the clip's timeline.
Parametersseconds:Number |
FlowplayerBase |
seekRelative | () | method |
public function seekRelative(value:Number):FlowplayerBase
Seeks to the specified point.
Parametersvalue:Number — point in the timeline, between 0 and 100
|
FlowplayerBase |
setPlaylist | () | method |
public function setPlaylist(playlist:Array):void
Sets a new playlist.
Parametersplaylist:Array — an array of Clip instances
|
See also
showError | () | method |
public function showError(message:String):void
Shows the specified error message in the player area.
Parametersmessage:String |
showPlugin | () | method |
public function showPlugin(pluginName:String, props:Object = null):void
Parameters
pluginName:String |
|
props:Object (default = null )
|
startBuffering | () | method |
public function startBuffering():FlowplayerBase
Starts buffering the current clip in playList.
ReturnsFlowplayerBase |
stop | () | method |
public function stop():FlowplayerBase
Stops the player and rewinds to the beginning of the playList.
ReturnsFlowplayerBase |
stopBuffering | () | method |
toggle | () | method |
public function toggle():Boolean
Toggles between paused and resumed states.
ReturnsBoolean — 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.
ReturnsFlowplayerBase |
togglePlugin | () | method |
public function togglePlugin(pluginName:String, props:Object = null):Boolean
Parameters
pluginName:String |
|
props:Object (default = null )
|
Boolean |