Class TFLPlayer

The TFLPlayer object exposes the different properties, functions, methods and callbacks of an instance of a Flash Media Player.
Defined in: <class.flplayer.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	TFLPlayer()

Field Summary
Field Attributes	Field Name and Description
	autostart Specifies whether the Flash player will automatically start playing the media URL assigned to it when the createPlayer function has been successfully called.
	flashPlayerSWF The URL to the SWF file (The Flash player code-base) You should not need to change this value.
	height The height of the Flash player.
	id The unique ID of the media player.
	mediaurl The URL of the media that will be played by the Flash media player.
<static>	TFLPlayer.MINIMUM_VERSION Static field - the minimum required flash version
	onBuffering Re-expose the onBuffering event.
	onClick Re-expose the onClick event.
	onData Re-expose the onData event.
	onFL_Buffering Subscribe to the onFL_Buffering event to handle any changes in the buffering status.
	onFL_Data Subscribe to the onFL_Data event to handle any raw meta data that arrives.
	onFL_EOF This event is triggered when the media plays and reached the end of the media file.
	onFL_MouseDown Subscribe to the onFL_MouseDown event to handle any instance of the user clicking on the Flash player.
	onFL_MouseOver Subscribe to the onFL_MouseOver event to handle any instance of the user moving the mouse over the Flash player.
	onFL_StatusChanged Subscribe to the onFL_StatusChanged event to handle any changes in the Flash player status.
	onLoaded Event is fired after player is fully loaded.
	onPlayerStatusChange Re-expose the onPlayerStatusChange event.
	showcontrols Specifies whether the control bar (contains the Play, Stop, Previous, Next, Pause, and Mute buttons as well as the volume control slider) must be displayed on the Flash media player.
	width The width of the Flash player.

Method Summary
Method Attributes	Method Name and Description
	assertPlayer() Test to see if internal player control is valid.
	attachPlayer(PlayerObj) Register an existing player object.
	Close() Closes the file/stream within the player.
	createPlayer(owner) Create player that is ready for use within HTMLView pages.
	getBufferProgress() Returns the media player's buffering progress.
	getContextName() Object's context name - "TFLPlayer"
	getMute() Get's the media player's IsMuted state.
	getMuted() Get's the media player's IsMuted state.
	getPlayer() Get's the flPlayer object
	getPlayerStatus() Returns the media player's normalized current status code.
	getVolume() Get's the media player's volume.
	Hide() Hides the Flash control.
	isBuffering() Checks to see if the media player is buffering or not.
	isControllable() Test to see if the player object is controlable through scripting.
<static>	TFLPlayer.isInstalled() Static function to detect if Flash plugin is installed.
	isLoaded() Player's loading status.
	Open(url) Opens the requested media URL.
	Pause() Pauses the playing of the media player.
	Play() Causes the media player to start playing.
	PreBuffer(url) Opens the requested media URL & pre-buffers the content.
	setMute(muted) Set's the media player's IsMuted state.
	setMuted(muted) Set's the media player's IsMuted state.
	setSize(width, height) Sets the player width and height
	setVolume(volume) Set's the media player's volume.
	Show() Displays the Flash control.
	Stop() Stops the playing of the media player.
	toggleMute() Mute's or un-Mute 's the media player depending on the player's current IsMuted state.

Class Detail

TFLPlayer()

Field Detail

{bool} autostart

Specifies whether the Flash player will automatically start playing the media URL assigned to it when the createPlayer function has been successfully called.

Default Value:: true

{string} flashPlayerSWF

The URL to the SWF file (The Flash player code-base) You should not need to change this value.

{int} height

The height of the Flash player.

Default Value:: 240

{string} id

The unique ID of the media player. If not specified, an unique ID will be generated for each new instance of a TFLPlayer object.

{string} mediaurl

The URL of the media that will be played by the Flash media player.

<static> TFLPlayer.MINIMUM_VERSION

Static field - the minimum required flash version

Default Value:: 9.0.0

{YUI_EVENT} onBuffering

Re-expose the onBuffering event.
Arguments passed back to the event handler function are:

bufferProgress - Buffering progress as a % (0..100)

{YUI_EVENT} onClick

Re-expose the onClick event.
No arguments are passed back to event handler function.

{YUI_EVENT} onData

Re-expose the onData event.
Arguments passed back to the event handler function are:

metadata - Media metadata array.

See:: TMediaData#onData

{YUI_EVENT} onFL_Buffering

Subscribe to the onFL_Buffering event to handle any changes in the buffering status.
Arguments passed back to the event handler function are:

bufferingProgress - value 0 to 100

{YUI_EVENT} onFL_Data

Subscribe to the onFL_Data event to handle any raw meta data that arrives.
Arguments passed back to the event handler function are:

data - Array object containing raw metadata results

{YUI_EVENT} onFL_EOF

This event is triggered when the media plays and reached the end of the media file.
No arguments are passed back to event handler function.

{YUI_EVENT} onFL_MouseDown

Subscribe to the onFL_MouseDown event to handle any instance of the user clicking on the Flash player.
Arguments passed back to the event handler function are:

x - X position of mouse pointer
y - Y position of mouse pointer

{YUI_EVENT} onFL_MouseOver

Subscribe to the onFL_MouseOver event to handle any instance of the user moving the mouse over the Flash player.
Arguments passed back to the event handler function are:

x - X position of mouse pointer
y - Y position of mouse pointer

{YUI_EVENT} onFL_StatusChanged

Subscribe to the onFL_StatusChanged event to handle any changes in the Flash player status.
Arguments passed back to the event handler function are:

newstate - Flash player state code

{YUI_EVENT} onLoaded

Event is fired after player is fully loaded. (SilverLight players need to load a remote XAP file).
No arguments are passed back to event handler function.

{YUI_EVENT} onPlayerStatusChange

Re-expose the onPlayerStatusChange event.
Arguments passed back to the event handler function are:

newstatus - Current normalized status code (1-5) of the Flash media player. Can be 1 - Playing, 2 - Paused, 3 - Stopped, 4 - Buffering, 5 - Error

{string} showcontrols

Specifies whether the control bar (contains the Play, Stop, Previous, Next, Pause, and Mute buttons as well as the volume control slider) must be displayed on the Flash media player. Note: instead of using the control bar, Html buttons and controls can be used to operate the player. Valid values are "auto", true or false.

Default Value:: "auto"

{int} width

The width of the Flash player.

Default Value:: 320

Method Detail

assertPlayer()

Test to see if internal player control is valid.

attachPlayer(PlayerObj)

Register an existing player object. Find the existing player object by ID/Name. Subscribes local event handlers to the player object. Build functions to fix context of events from player object. Attach events to player object.

Parameters:
{string} PlayerObj: The ID/Name of the existing player object

Close()

Closes the file/stream within the player.

createPlayer(owner)

Create player that is ready for use within HTMLView pages. The owner of the player is a DOM tag element, usually the body. If no owner is supplied, the body is used. Using the Flash.createObjectEx function the Flash Control hosting the SL player is created. On the onLoad event of the Flash Control, the SL player is then initialized.

Parameters:
{string} owner: The ID/Name of a DOM tag element, usually body

getBufferProgress()

Returns the media player's buffering progress. Can be a value from 0 to 100.

{string} getContextName()

Object's context name - "TFLPlayer"

Returns:: {string} Returns the name of the player "class", i.e. "TFLPlayer"

getMute()

Get's the media player's IsMuted state.

getMuted()

Get's the media player's IsMuted state.

getPlayer()

Get's the flPlayer object

getPlayerStatus()

Returns the media player's normalized current status code. The codes are:

1-Playing
2-Paused
3-Stopped
4-Buffering
5-Error

getVolume()

Get's the media player's volume. The value of the volume returned ranges from 0 to 100.

Hide()

Hides the Flash control.

isBuffering()

Checks to see if the media player is buffering or not. Currently this method always returns false.

isControllable()

Test to see if the player object is controlable through scripting.

See:: TWMPlayer#isControllable; TSLPlayer#isControllable

<static> {bool} TFLPlayer.isInstalled()

Static function to detect if Flash plugin is installed.

Returns:: {bool} Returns TRUE if Flash plugin is detected.

{bool} isLoaded()

Player's loading status. Player needs to load SWF file first.

Returns:: {bool} Returns TRUE if player is done loading (successfully), else false.

Open(url)

Opens the requested media URL.

Parameters:
{string} url: The media url to be loaded by the media player.

Pause()

Pauses the playing of the media player.

Play()

Causes the media player to start playing.

PreBuffer(url)

Opens the requested media URL & pre-buffers the content.
NOTE: This will automatically set #autostart to false!

Parameters:
{string} url: The media url to be loaded by the media player.

setMute(muted)

Set's the media player's IsMuted state.

Parameters:
{bool} muted: True or False value that indicates whether the media player must be muted or un-muted.

setMuted(muted)

Set's the media player's IsMuted state.

Parameters:
{bool} muted: True or False value that indicates whether the media player must be muted or un-muted.

setSize(width, height)

Sets the player width and height

Parameters:
{int} width: Player width (in pixels)
{int} height: Player height (in pixels)

setVolume(volume)

Set's the media player's volume.

Parameters:
{int} volume: The value to which the volume is set. The range is from 0 to 100.

Show()

Displays the Flash control.

Stop()

Stops the playing of the media player.

toggleMute()

Mute's or un-Mute 's the media player depending on the player's current IsMuted state.

Classes

Class TFLPlayer