org.flowplayer.view.FlowplayerBase

	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
		keyboardHandler : KeyboardHandler [write-only]	FlowplayerBase
		muted : Boolean Is the volume muted?	FlowplayerBase
		playButtonOverlay : DisplayProperties [read-only]	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
		screen : DisplayProperties [read-only] Gets the Screen.	FlowplayerBase
		state : State [read-only] Gets the player state.	FlowplayerBase
		status : Status [read-only] Gets the current status {	FlowplayerBase
		streamProvider : StreamProvider [read-only] Gets the StreamProvider of the current clip.	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
		_playListController : PlayListController	FlowplayerBase
		_pluginRegistry : PluginRegistry	FlowplayerBase

	Method	Defined 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
		addKeyListener(keyCode:uint, func:Function):void	FlowplayerBase
		addToPanel(displayObject:DisplayObject, props:Object, resizeListener:Function = null):void Adds the specified display object to the panel.	FlowplayerBase
		close():FlowplayerBase Stops the player and closes the stream and connection.	FlowplayerBase
		createClips(clips:Array):Array Creates Clip objects from the specified array of objects	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:ErrorCode, 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
		isKeyboardShortcutsEnabled():Boolean	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
		loadPluginWithConfig(name:String, url:String, properties:Object = null, callback:Function = null):void	FlowplayerBase
		logging(level:String, filter:String = "*"):void Configures logging.	FlowplayerBase
		next():Clip Moves to next clip in playList.	FlowplayerBase
		pause():FlowplayerBase Pauses the current clip.	FlowplayerBase
		play(clip:Clip = null):FlowplayerBase Plays the current clip in playList or the specified clip.	FlowplayerBase
		playInstream(clip:Clip):void Starts playing the specified clip "in stream".	FlowplayerBase
		previous():Clip Moves to previous clip in playList.	FlowplayerBase
		removeKeyListener(keyCode:uint, func:Function):void	FlowplayerBase
		reset(pluginNames:Array = null, speed:Number = 500):void Resets the screen and the controls to their orginal display properties	FlowplayerBase
		resume():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
		setKeyboardShortcutsEnabled(enabled:Boolean):void	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
		startBuffering():FlowplayerBase Starts buffering the current clip in playList.	FlowplayerBase
		stop():FlowplayerBase Stops the player and rewinds to the beginning of the playList.	FlowplayerBase
		stopBuffering():FlowplayerBase Stops buffering.	FlowplayerBase
		switchStream(clip:Clip, netStreamPlayOptions:Object = null):void	FlowplayerBase
		toggle():Boolean Toggles between paused and resumed states.	FlowplayerBase
		toggleFullscreen():Boolean 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

Property detail

_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

property

id:String [read-only]

Gets the player's id.

Implementation
public function get id():String

keyboardHandler

property

keyboardHandler:KeyboardHandler [write-only]Implementation
public function set keyboardHandler(value:KeyboardHandler):void

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
public 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:DisplayProperties [read-only]

Gets the Screen.

Implementation
public function get screen():DisplayProperties

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

streamProvider

property

streamProvider:StreamProvider [read-only]

Gets the StreamProvider of the current clip.

Implementation
public function get streamProvider():StreamProvider

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

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. You can also add instream clips like so:

position == 0, the clip is added as a preroll
position == -1, the clip is added as a postroll
position > 0, the clip is added as a midroll (linear instream)

Parameters

	`clip:Clip`

	`index:int` (default = `-1`) — optional insertion point, if not given the clip is added to the end of the list.

addKeyListener

()

method

public function addKeyListener(keyCode:uint, func:Function):voidParameters

	`keyCode:uint`

	`func:Function`

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`)

()

method

public function close():FlowplayerBase

Stops the player and closes the stream and connection. Does not dispatch any events.

Returns

FlowplayerBase

createClips

()

method

public function createClips(clips:Array):Array

Creates Clip objects from the specified array of objects

Parameters

clips:Array

Returns

Array

See also

Clip

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:ErrorCode, info:Object = null, throwError:Boolean = true):void

Handles the specified error.

Parameters

	`error:ErrorCode`

	`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

isKeyboardShortcutsEnabled

()

method

public function isKeyboardShortcutsEnabled():Boolean

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

state

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

state

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`)

loadPluginWithConfig

()

method

public function loadPluginWithConfig(name:String, url:String, properties:Object = null, callback:Function = null):voidParameters

	`name:String`

	`url:String`

	`properties:Object` (default = `null`)

	`callback:Function` (default = `null`)

logging

()

method

public function logging(level:String, filter:String = "*"):void

Configures logging.

Parameters

	`level:String`

	`filter:String` (default = "`*`")

()

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

playInstream

()

method

public function playInstream(clip:Clip):void

Starts playing the specified clip "in stream". The clip currently playing is paused and the specified clip is started. When the instream clip is finished the original clip is resumed.

Parameters

clip:Clip

()

method

public function previous():Clip

Moves to previous clip in playList.

Returns

Clip

removeKeyListener

()

method

public function removeKeyListener(keyCode:uint, func:Function):voidParameters

	`keyCode:uint`

	`func:Function`

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

setKeyboardShortcutsEnabled

()

method

public function setKeyboardShortcutsEnabled(enabled:Boolean):voidParameters

enabled:Boolean

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

switchStream

()

method

public function switchStream(clip:Clip, netStreamPlayOptions:Object = null):voidParameters

	`clip:Clip`

	`netStreamPlayOptions:Object` (default = `null`)

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():Boolean

Toggles between the full-screen and normal display modeds.

Returns

Boolean

togglePlugin

()

method

public function togglePlugin(pluginName:String, props:Object = null):BooleanParameters

	`pluginName:String`

	`props:Object` (default = `null`)

Returns

Boolean

FlowPlayer 3.2.3 API documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class FlowplayerBase	Properties \| Methods

Package	org.flowplayer.view
Class	public class FlowplayerBase
Inheritance	FlowplayerBase org.flowplayer.view.PlayerEventDispatcher
Implements	org.flowplayer.view.ErrorHandler
Subclasses	Flowplayer