Flowplayer Configuration Tailor every aspect of the player to your needs

• Introduction
• Player
• Clips
• Playlists
• Plugins
• Streaming

Player configuration

A Player is installed on a webpage by a call to the flowplayer() function or its shorthand $f(). See installation on how and where to place this call and see the documentation of the flowplayer() function in the api, Player creation.

Player is the top-level object. Configuration properties and event listeners are placed in the root of the configuration; it is not a sub-object of the configuration. Example:

flowplayer("player", "/path/to/flowplayer-3.2.4.swf", {
	buffering : false,		// set a Player property
	onLoad : function() {	// provide a Player event listener
		this.unmute();
	}
    }
);

This section describes the two configuration parameters of the flowplayer() function:

    flowplayer("player", Flash configuration, Player configuration);

Player Configuration (3^rd parameter)

You can set Player properties and can supply event listeners for a Player in the configuration.

Player properties

log : {
		level  : 'warn',
		filter : 'org.flowplayer.rtmp.*'
	}

Player events

You can supply listeners for Player events in the configuration. These are placed in the root of the configuration. See also events in the JavaScript api.

Each Player fires events that can inform you of changes in the Player and of actions the Player intends to take or has just taken. The event listener receives as its this variable a reference to the current Player instance.

Before events are marked in gray. Not all events have a before event. The 'Cancel action' column says what will happen when a before event listener returns false.

Flash configuration (2^nd parameter)

The second parameter of the flowplayer() function specifies the Flash embedding parameters. If you supply it as a simple string it is treated as the src property of flashembed which defines the path to the Flowplayer Flash component (.swf). If you want to customize the Flash embedding, you can supply the settings as an object written in json.

Flowplayer uses our flashembed tool to embed the Flowplayer Flash component on the page. This tool is included in the flowplayer-3.2.4.js file and you have all its power available such as version detection and handling of old Flash versions. All Flash configuration options are given directly to flashembed.

See also:

• Flash embedding in the introduction
• Full list of Flashembed configuration properties
• All standard Flash parameters
• Demo: Flashembed
• Demo: placing HTML content over the video using wmode configuration property

Flowplayer uses the following defaults:

In the following example we supply a custom onFail listener for Flash versions that do not support MP4. On Flash versions below 9.115, users will experience an Express Install and additionally our onFail event listener is called, explaining the problem in an info box. The same behaviour occurs if the container is configured with an initial splash image.

Here is the JavaScript and html code for this example:

<!-- setup player container -->
<div id="player" style="width:425px;height:300px"></div>

<div id="info" class="box info">
	You have Flash version 9.115 or above. Enjoy high quality video!
</div>

<script>

// Flowplayer installation with Flashembed configuration
flowplayer("player", {

	// our Flash component
	src: "http://releases.flowplayer.org/swf/flowplayer-3.2.4.swf",

	// we need at least this Flash version
	version: [9, 115],

	// older versions will see a custom message
	onFail: function()  {
		document.getElementById("info").innerHTML =
			"You need the latest Flash version to see MP4 movies. " +
			"Your version is " + this.getVersion()
		;
	}

	// here is our third argument which is the Flowplayer configuration
}, {
	clip: "KimAronson-TwentySeconds6421.m4v"
});
</script>

Flowplayer Twitter feed