FlashVars

Type

Description

Category on Flash Video MX series

autoResize

Boolean

Set to automatically resize the video or not when the player window size is changed.

Skin settings

maintainAspectRatio

Boolean

Set to maintain aspect ratio or not when the player window size is changed.

Skin settings

minWidth

Integer

The minimal width of the window.

Skin settings

minHeight

Integer

The minimal height of the window.

Skin settings

skinAutoHide

Boolean

Set to automatically hide the player or not.

Skin settings

skinHideDelay

Integer

The time in milliseconds to hide the player.

Skin settings

allowBigPlayButton

Boolean

Set to show the big play button or not.

Skin settings

mouseAutoHide

Boolean

Set to automatically hide the mouse or not when the skin hides. If set as true, components like Video, Label and Image will not be hidden.

Skin settings

videoFile

Character string

The URL of the video, see "rtmpConn" for more details.

Playback settings

playList

Character string

The playlist file path.

Playback settings

rtmpConn

Character string

The RTMP connection URL, when "rtmpConn" is set, "VideoFile" will be treated as the stream name of an RTMP stream.
Otherwise "VideoFile" will be treated as
1) An absolute/relative URL of an HTTP progressive download video or
2) An absolute URL of an RTMP stream ended with an RTMP stream name, e.g. rtmp://server/app/instance/stream_name, and the string at the right of last back slash will be treated as the stream name.

Note: For RTMP stream, if the stream name of your video contains back slash, you can not just set "VideoFile" to an absolute RTMP URL, as our URL parser can not parse the stream name correctly. You should set "rtmpConn" to the connection string, and "VideoFile" to an stream name. If you need to set this property to the player, please set it before "VideoFile" to be set.

Playback settings

firstFrame

Character string

The file path of the first frame image file.

Playback settings

autoLoad

Boolean

Set to automatically load the video or not when player is open. If set as true, the second video will be loaded for player with playlist.

Playback settings

autoPlay

Boolean

Set to automatically play the video or not when player is open. When it is set as true, it indicates autoLoad is true.

Playback settings

loopCount

Integer

The number of times to repeat the video. -1 is for infinite repeat.

Playback settings

unloadOnStop

Boolean

Set to unload the video or not when the video playing is stopped.

Playback settings

bufferTime

Floating-point

The buffer time of video content in seconds to be temporarily cached before playing.

Playback settings

smoothVideo

Boolean

Set to enable deblocking and smoothing to get better video quality or not.

Playback settings

showFirstFrameWhenStop

Boolean

Set to show the first frame or not when the video playing is stopped.

Playback settings

volume

Integer

The volume ranges from 0 to 100.

Playback settings

mute

Boolean

Set the video to mute or not when video is playing.

Playback settings

videoLink

Character string

The URL to be opened when the video screen is clicked.

Navigation on click

videoLinkTarget

Character string

The target browser window to open the videoLink URL.

Navigation on click

endURL

Character string

The URL to be opened when the video is played to the end.

Note: If loopCount has been set, only when the video has been played in loopCount times, will the endURL be called. Once the endURL has been called, no more call would be made during this video playback session.

Navigation at end

endURLTarget

Character string

Set the target browser window to open the endURL.

When endURLTarget is _swf, it indicates the endURL is a URL of SWF file, the endURLTarget will be loaded into current Flash player window.

When endURLTarget is _flv, it indicates the endURL is a URL of FLV file, and the endURLTarget will be loaded in the current window and the current video will be replaced.

Navigation at end

onPlayURL

Character string

The URL to be accessed in background using http GET method when the video starts playing. If movieId is set, a parameter named movieId will be passed to the URL.

Note: The URL can be only accessed one time for each playback session.

Play action

movieId

Character string

A string that will be passed to onPlayURL.

Tips: The onPlayURL and movieId are used to count the video playing hits.

Play action

eventHandler

Character string

The name (case sensitive) of a Javascript function to process the player events. The function prototype is:

function JSEventHandler(event);

event is an object which contains a list of event information:

event.name: the event name. Have a look at the supported event.name
event.info: the event's data, which varys from event to event.

Note: The "eventHandler" will not get effect until "disableAPI=no" is set in flashVars.

Event

eventFSCommand

Boolean

Set to trigger the event as fscommand or not.

Once eventFSCommand is set to true, the player events will be triggered as fscommand(name, info);

When name is the event name, info is the event's data, it will be a string of XML formatted as Flash External Interface XML format.

Event