FCPlayer Configuration

IndexA list of the optional parameters for use with FCPlayer.play



where is it
Below is a list of the options that you can place in the options argument of the FCPlayer.play function. A brief explanation of their function is given with an example of their usage. The tutorial: how to Use the options parameter to add options to your videos shows you how to incorporate these options in your videos. You may notice that there is some overlap with the global configuration parameters found in FCPlayer/config/FCPlayerConfig.js. When a confict arises between the two, these options will override the global configuration.

width

Width of the player window, in pixels. This parameter will be ignored if the player is embedded in the page.

Example:

width:800,


height

Height of the player window, in pixels. This parameter will be ignored if the player is embedded in the page.

Example:

height:432,


vidWidth

Width of the video screen, in pixels. Use only with videos that do not have height and width properly encoded in their metadata.

Example:

vidWidth:300,


vidHeight

Height of the video screen, in pixels. Use only with videos that do not have height and width properly encoded in their metadata.

Example:

vidHeight:280,


title

The title of your video.

Example:

title:'A video about my cat.',


playState

Default play state- choices are "Standby", "FirstFrame" and "Run".

"Standby" is the default mode when the player is embedded in the page. In this mode, the player will wait for user input (such as pressing play) before loading and playing the video.

"FirstFrame" is the default mode when the player is used as a window application. If "FirstFrame" is selected, upon opening, the player will display the first frame (approximately) of the video and pause. While paused the video will continue loading.

If "Run" is selected, the player will immediately start the video on loading.

Thes options are case sensitive.

Example:

playState:'FirstFrame',


previewImage

Specifies the location of a preview image to display on the screen before the video starts playing.
Preview images can only be used in the playState is set to 'FirstFrame'.

Example:

previewImage:'http://www.fastcatsoftware.com/FCPlayer/images/vid2.jpg',


slide_controls

Determines whether the controls are fixed in place, or allowed to slide in and out of view as needed.
The values this parameter accepts are true and false. This applies only to version 1.1.8 and later.

Example:

slide_controls:true,



use_loop_button
use_full_screen_button
use_popout_button

The loop button, popout button, and full screen button are optional, as of version 1.1.8. The values these parameters accept are true and false.

Example:

use_loop_button:true,
use_full_screen_button:true,
use_popout_button:true,



plugins

An array of plugins to add to the menu bar. A full discussion of plugins can be found in the tutorial: how to Add plugins to the menu bar


Example:

plugins:['defaultBWPlugin','defaultSharePlugin','defaultInfoPlugin','viewMenu'],


quality

Use Flash based video quality enhancement. (true/false).
Setting to true may affect playback performance for slow connections.

Example:

quality:false,


volume

Default volume. (Range is 0-1).

Example:

volume:.5,


duration

Default video duration in seconds (A fallback parameter for videos with no metadata)

Example:

duration:300,


noMeta

Videos assumed to have no metadata, by default (true/false).

Example:

noMeta:false,


startTime

The number of seconds, from the beginning of the video, to start playback.
This only works with streaming or psuedo-streaming videos.

Example:

startTime:30,


startBuffer

The number of seconds to buffer before starting playback.


Example:

startBuffer:10,




If you have a pre-sales question, submit your inquiry via our sales contact page. For general, non-sales inquiries, contact us at support@fastcatsoftware.com.

Solution Graphics