Flowplayer> Configuration

Configuration setup

Below you can find all configuration options that are available as a flat list. This list is intended to be used as a reference, and if you want to see more information about a specific topic please read quick start, playlists and advanced features sections.

Configuration variables are set in following way.

flashembed("example", {src:'FlowPlayerLight.swf'}, {config: {

    // list of variables goes here
    autoPlay: false,
    videoFile: 'example.flv',
    initialScale: 'scale', 
    useNativeFullScreen: true
  }} 
);

You can see different configuration settings from our screenshots page.

configFileName	An external javascript configuration file.
videoFile	The video file to be loaded by the player. You can specify an absolute URL here or a relative one (relative to the player's SWF file). See the `baseURL` below. Alternatively you can use a `playList`.
baseURL	Where to load the video files from. This is appended in front of the value of `videoFile` value.
autoPlay	`[true \|\| false]` Whether the player starts playback immediately when it's loaded into the browser. default: `true`
autoBuffering	Whether to start loading the video stream into buffer memory immediately. Only meaningful if `autoPlay` is set to `false` default: `true`.
usePlayOverlay	`[true \|\| false]` Show the play button image at the start of the playlist? default: `true`
splashImageFile	Useful if 'autoPlay' is set to false and you want to show a welcome image before the video is played. Must be JPG format. note: value is relative to the HTML page.
initialScale	Initial video scaling. This can be then changed by the user through the menu. Available options are: `'fit'`: Fit to window by preserving the aspect ratios encoded in the FLV metadata. This is the default setting. `'half'`: Half size (preserves aspect ratios) `'orig'`: Use the dimensions encoded in FLV. If the video is too big for the available space the video is scaled as if using the 'fit' option. `'scale'`: Scale the video to fill all available space for the video. Ignores the dimensions in metadata.
initialVolumePercentage	Initial volume level in percents. Optional, defaults to 50.
videoHeight	The height to be allocated for the video display. By default Flowplayer uses the maximium height available.
useNativeFullScreen	`[true \|\| false]` Should the Flash 9 native full screen mode be used? (default: `true`).
useHwScaling	`[true \|\| false]` Should the Flash 9 hardware scaling be used? (default: `true`). Only valid if useNativeFullScreen is set to true.
fullScreenScriptURL	The URL pointing to a sctipt that opens the player full screen. If this is not configured explicitly, the default script, http://flowplayer.org/video/x_xx/fullscreen.js, is used. NOTE: Only used when `useNativeFullScreen` is not set to false.
bufferLength	The size of the buffer in seconds when streaming video. Playback starts only after the initial buffer is full, and the initial buffer size is controlled using `startingBufferLength` (see below). Once the playback has been started the buffer is enlarged to this value. Make this large enough to compensate for gaps in the available bandwidth. Note that the value should always be less than the duration of the video. (default: 10)
startingBufferLength	The video buffer length (seconds) to be used to kick off the playback. This is used in the beginning of the playback and every time after the player has ran out of buffer memory (buffer has been flushed). This should be smaller than `bufferLength` so that the playback starts quickly.
useSmoothing	`[true \|\| false]` Whether to use antialiasing when the video is scaled. default: `true`
videoLink	A link to the video file that is shown when "Embed" is selected in the menu. Option, defaults to the url specified in videoFile or playList.
emailPostUrl	The URL used when posting the email data to the server.
emailVideoLink	The value of videoLink variable posted as part of the email data.
emailDefaultMessage	The default message text used as part of the email data. All occurrences of [video_link] tag in the message are replaced with the value of emailVideoLink.

autoRewind	If `true` rewinds back to the beginning of the first clip after reaching the end of the playlist. (default: false)
playList	List a series of flv or jpg files to display. More about playlists.
loop	`[true \|\| false]` Loop through the playlist? If `true` the playlist is looped continuoysly. Note that if the first clip is a splash image (either a JPG or PNG file without a name and without a duration) it is skipped when looping. default: `true`.
noVideoClip	Any missing video clips are replaced by this clip. Typically this is used to provide a message like, "The video you requested is not available". `noVideoClip: { url: 'sorry.jpg', duration: 10 }`

url	The URL used to load the clip. See also the `baseURL` variable. This can be an absolute or a relative URL. Relative URLs are always relative to the player's SWF file location.
name	Name for the clip. This is used in the suggestions view.
live	`[true \|\| false]` Is this a live stream played from a RTMP server?
start	The start time (seconds) from where to start the playback. A nonzero value can only be used when using a streaming server.
end	The end time (seconds) where to stop the playback.
protected	`[true \|\| false]` Apply inlinine linking protection for this clip? Optional, defaults to `false`.
type	One of 'video', 'flv', 'swf', 'jpg'. Optional, determined from the URL's filename extension if that is present. 'video' means a video file in any format supported by Flash. 'flv' is present here for backward compatibility, use 'video' in all new FlowPlayer installations now. Defaults to 'video' if the extension is not present in the URL.
linkUrl	Associates a hyperlink pointing to the specified URL. The linked document will be opened to the browser when the clip area is clicked. Specifying this parameter will replace the normal pause/resume behavior that is associated to clicking the display area. If you specify an empty linkUrl '' the pause/resume behavior is disabled but no hyperlink is created.
linkWindow	Specifies the name of the browser window or frame into which to load the linked document. Can be a custom name or one of presets: '_blank', '_parent', '_self', '_top'. (optional, defaults to '_blank')
overlay	An URL pointing to an image that will be placed on top of this image clip. This is only applicable to image clips (jpg or png files). Essentially this layers two images on top of each other. Typically the image on top is a big play button that is used on top of an image taken from the main movie.
overlayId	NOTE! This is advanced stuff and rarely used, please see if you can go with 'usePlayOverlay' first. overlayId specifies a built-in overlay to be used. Currently the player supports one built-in overlay with ID `'play'` (controlled by 'usePlayOverlay'). It renders a large play button with mouse hover color change. You can use this on top of image clips (one clip with both the `url` property and `overlayId` property). You can also specify a clip that only has this ID. In that case you should place it immediately before or after a video clip. This overlay-only clip is then rendered on top of the first or the last frame of the video.
duration	This specifies how long the clip is to be shown.
controlEnabled	`[true \|\| false]` Enable transport control buttons for this clip? Typically used to disable controls when showing ads. Optional, defaults to `true`.
allowResize	`[true \|\| false]` Allow resizing this clip according to the menu selection? Optional, defaults to `true`.
showOnLoadBegin	`[true \|\| false]` If `true`, makes this clip visible when the fist bits have been loaded into the player. If `false`, this clip stays hidden and the background is shown until the buffer is filled and the playback starts. Optional, defaults to `true`.
maxPlayCount	The maximum play count for this clip. The clip is removed from the playlist when the playcount reaches this amount.

controlBarGloss	Controlbar can have a slight gloss effect making it a bit more "metallic". Possible values are `'high', 'low'` or `'none'`. Default is 'low'.
controlsOverVideo	`['locked' \|\| 'ease' \|\| 'no']` 'locked' makes the control bar to stay on top of the video area, 'ease' makes it move in and out of the video area and 'no' will put it below the video area both in normal and in full-screen mode. By default when this option is not present the control bar stays below the video area in normal mode and eases in and out in full-screen.
controlBarBackgroundColor	Chanbes the color of the default flowplayer Air skin.

watermarkUrl	URL to a custom watermark logo shown on top right corner of the video area. (commercial version only)
showWatermark	`[ "fullscreen" \|\| "always"]` controls when the watermark is shown - only in full-screen mode or both in normal and full-screen modes (commercial version only)
watermarkLinkUrl	URL to load into the browser window when the watermark is clicked (commercial version only, optional)

bufferingAnimationColor	the color used in the "moving bars" buffering animation.
bufferBarColor1, bufferBarColor2	the colors used in the buffering indicator bar color gradient.
progressBarColor1, progressBarColor2	the colors used in the progress bar color gradient.
progressBarBorderColor1, progressBarBorderColor2	the colors used in the progress bar and volume slider border (background) gradient.
controlsAreaBorderColor	the color used in the area below the buttons and other controls.
hideControls	`[true \|\| false]` If set to true, hides all buttons and the progress bar leaving only the video showing. default: `false`
menuItems	Specifies which menu items will be shown. This is an array that contains a boolean value for each of the items. By default it shows them all. For example following configuration hides the fifth menu item: menuItems: `[ true, true, true, true, false, true ]`
showFullScreenButton	`[true \|\| false]` Specifies wether the full screen button should be shown or not. Optional parameter. default: `true`
showStopButton	`[true \|\| false]` Should the stop button be show?= default: `true`
showPlayButton	`[true \|\| false]` Should the play/pause button be shown? default: `true`
showScrubber	`[true \|\| false]` Should the scrubber/seek bar be shown? default: `true`
showVolumeSlider	`[true \|\| false]` Should the volume slider be shown? default: `true`
showMuteVolumeButton	`[true \|\| false]` Should the volume mute/unmute button be shown? default: `true`
showMenu	`[true \|\| false]` Whether the menu containing the size options should be shown or not default: `true`.
showPlayListButtons	`[true \|\| false]` Specifies wether the playlist control buttons (next/prev clip) should be shown in or not. (default: false)
timeDisplayFontColor	Color of the font used in the video time/duration display.

streamingServerURL	Streaming server connection URL for servers using the RTMP protocol.
streamingServer	What kind of streaming server? Available options: 'fms', 'red5', 'lighttpd'
rtmpConfigUrl	Instructs the player to load the configuration from a RTMP server. The player connects to the server listening in the address specified by this URL and calls a method `getStreamPlayerConfig(rtmpConfigParam:Object)` that should return a valid FP configuration object.
rtmpConfigParam	A param value to be passed to `getStreamPlayerConfig()`. A value 'foobar' will make the player to call `getStreamPlayerConfig('foobar')` in the applcation running in the streaming server.

thumbs	A list of thumbnails for jumping to a particular part of an flv. More about thumbnails.
thumbLocation	baseURL for thumbs
suggestedClipsInfoUrl	URL used to fetch suggestions information from the server. See also the `baseURL` variable.
googleAnalyticsPrefix	Enables Google Analytics support. Defines the prefix used to group the analytics related to video playback using FlowPlayer.
googleAnalyticsFunction	Name of the JavaScript function that is used to send the stats to Analytics. (default: `pageTracker._trackPageview`)
embedCode	The code that is shown when the user requests embedding. Optional, by default the code is generated from the hosting player's configuration.

useEmbeddedButtonImages	`[true \|\| false]` Set to false to "skin" the buttons. default: `true`.
skinImagesBaseURL	A base URL that points to a folder containing images used to skin the player. You must specify this if you intend to load external button images.

Quick start

Documentation

JavaScript tools

roadmap

resources