Support Center » Knowledgebase » FLV Player FlashVar Component Parameters API
 FLV Player FlashVar Component Parameters API
Article Every aspect of the FLV Player Component can be controlled using our FLV Player FlashVar Component Parameters API. No need to have Flash or the Component Inspector installed on your computer. We provide you with the needed swf, and the entire player can be setup using our FlashVars API and it's parameters listed below. All of these FlashVars can be used within your embed code in the same manner as our examples at the end of this article.


Video Playback Options
Control the Interface Display Mode
Show or Hide Any of the Interface Elements
Turn Rounded Corners On and Off
Control the Colors of the Component Interface
Control the Rollover Colors of the Component Interface
Control the Alpha Transparencies of the Component Interface
A Few Examples Using the FLV Player FlashVar Parameters API



Video Playback Options





flvpFolderLocation property

default : flvplayer/

Tells the FLV Player component where it can find the "flvplayer" folder on your server or local development environment. The "flvplayer" directory contains all of the fonts, media files, and xml settings.



flvpVideoSource property

default : [empty]

Sets up the url to use for video playback. This can be progressive (http) or streaming (rtmp) addresses, or an xml file. When setting the http value you can use something like "http://domain.com/media/video.mp4". when setting a rtmp value you can use something like "rtmp://your.fms_server.com/application_name/,video_name". Note that you do not need to specify the file extension when streaming from a Flash Media Server.



flvpPreRollImage property

default : [empty]

Optionally give FLV Player a url to an image to be used as a pre-roll image when the video auto start is set to false.



flvpAutoStartMovie property

default : true

Specify whether or not you want the first video available to automatically start playing when the video player is available. This setting accepts either "true" or "false". When set to true, the video automatically starts. When set to false, a large play button is displayed, and playback requires a user interaction.



flvpCustomLogo property

default : [empty]

Optionally give FLV Player a url to your own logo to be displayed within the player.



flvpCustomLogoPosition property

default : top left

Specify the location of the Custom Logo.

Options

top left — Position the logo in the top left corner.

top right — Position the logo in the top right corner.

bottom left — Position the logo in the bottom left corner.

bottom right — Position the logo in the bottom right corner.



flvpCustomLogoUrl property

default : [empty]

Specify the url that the logo takes users when clicked.



flvpMenuStartOpen property

default : false

Specify whether or not the menu system is open when the video player loads. This requires the xml file to be setup with videos present.



flvpShowMenuOnStop property

default : false

Specify whether or not the menu system is open when a stops the video playback using the stop button. This requires the xml file to be setup with videos present.



flvpShowMenuOnEnd property

default : false

Specify whether or not the menu system is open when a video completes playback. This requires the xml file to be setup with videos present.



flvpCaptionsStartOpen property

default : false

Specify whether or not the captions window is open when the player loads.



flvpShowInfoOnStart property

default : false

Specify whether or not the information window is open when the player loads.

Options

do not show at video start — Do not show the video information when a video loads.

show at video start — Show the video information when a video loads.

show at video start and autohide — Show the video information when a video loads, and automatically hide it after 5 seconds.

show at start and mouseover with autohide — Show the video information when a video loads, automatically hide it after 5 seconds, and automatically show it when the mouse hovers over the player.



flvpVideoLooping property

default : false

Specify whether or not a video will automatically loop once it has finished playing.



flvpAutoNextVideo property

default : false

Specify whether or not a video will automatically progress to the next video specified in the xml.



flvpVideoSmoothing property

default : true

Turn video smoothing on or off.



flvpVideoBuffer property

default : 3

Set how long the video will buffer before FLV Player begins playback. This value is also used in dynamic buffering if the playback of the video buffer becomes empty.



flvpInitVolume property

default : 50

Control the starting volume of the video playback. This value is a number that specifies the setting as a percentage. Values can range from 0-100.



flvpVidConstraints property

default : constrain to player

Control how the video is displayed and played back in terms of what size the player is setup.

Options

constrain to player — Keep the video at the same size as the component.

automatically resize if needed — Resize the video to fit within the component at the correct aspect ratio.

original — Do not resize the video. Keeps the video centered, and crops everything outside the component.

fit to width — Resize the video to fit the width of the component.

fit to height — Resize the video to fit the height of the component.



flvpVideoFade property

default : true

Specify whether or not the video will fade when the video is finished playing.



flvpWidth property

default : 768

Specify the width of the video.



flvpHeight property

default : 423

Specify the height of the video.






Control the Interface Display Mode






flvpInterfaceDisplay property

default : open

Control how the interface is displayed.

Options

open — Interface is always available.

closed — Interface is always not available.

autohide — Interface is available when the player starts, and fades out when there is no user interaction. It will display again when mouse movement over the component is detected.



flvpInterfaceLayout property

default : overlay

Control where the interface is displayed.

Options

overlay — Display the interface over the video.

outside — Display the interface outside the video.






Show or Hide Any of the Interface Elements






flvpShowBG property

default : true

Turn component background on and off.



flvpShowControlsBG property

default : true

Turn component controls background on and off.



flvpShowbBack property

default : true

Turn Previous button on and off.



flvpShowbPlay property

default : true

Turn Play button on and off.



flvpShowbStop property

default : true

Turn Stop button on and off.



flvpShowbForward property

default : true

Turn Next button on and off.



flvpShowbInfo property

default : true

Turn Info button on and off.



flvpShowbCc property

default : true

Turn Closed Captions button on and off.



flvpShowbFullscreen property

default : true

Turn Fullscreen button on and off.



flvpShowbMenu property

default : true

Turn Menu button on and off.



flvpShowbVolumeOn property

default : true

Turn Volume On button on and off.



flvpShowScrubBar property

default : true

Turn Scrub Bar on and off.



flvpShowVolumeBar property

default : true

Turn Volume Bar on and off.



flvpShowTimerText property

default : true

Turn Time Text on and off.



flvpShowbPlayLarge property

default : true

Turn the large Play button on and off.



flvpShowbPreviousLarge property

default : true

Turn the large Previous button on and off.



flvpShowbReplayLarge property

default : true

Turn large Replay button on and off.



flvpShowbNextLarge property

default : true

Turn the large Next button on and off.



flvpShowToolTips property

default : true

Turn Tool Tips on and off.



flvpToolTipDelay property

default : 1

Adjust the delay on showing the tooltips.






Turn Rounded Corners On and Off






flvpTurnOnCorners property

default : true

Turn rounded corners on and off.






Control the Colors of the Component Interface



All of the colors support any hexidecimal values.




flvpBgColor property

default : 0x000000

Set the color of the Component Background.



flvpControlsBgColor property

default : 0x000000

Set the color of the Interface Background.



flvpInfoBoxColor property

default : 0x000000

Set the color of the Info Background.



flvpCaptionBoxColor property

default : 0x000000

Set the color of the Captions Background.



flvpBackButtonColor property

default : 0xFFFFFF

Set the color of the Previous Button.



flvpPlayButtonColor property

default : 0xFFFFFF

Set the color of the Play Button.



flvpPauseButtonColor property

default : 0xFFFFFF

Set the color of the Pause Button.



flvpStopButtonColor property

default : 0xFFFFFF

Set the color of the Stop Button.



flvpForwardButtonColor property

default : 0xFFFFFF

Set the color of the Next Button.



flvpInfoButtonColor property

default : 0xFFFFFF

Set the color of the Info Button.



flvpCCButtonColor property

default : 0xFFFFFF

Set the color of the Closed Captions Button.



flvpCloseMenuButtonColor property

default : 0xFF0000

Set the color of the Close Button located in the menu.



flvpFullScreenButtonColor property

default : 0xFFFFFF

Set the color of the Fullscreen Button.



flvpMenuButtonColor property

default : 0xFFFFFF

Set the color of the Menu Button.



flvpVolumeOnButtonColor property

default : 0xFFFFFF

Set the color of the Volume On Button.



flvpVolumeOffButtonColor property

default : 0xFFFFFF

Set the color of the Volume Off Button.



flvpTimeColor property

default : 0xFFFFFF

Set the color of the Timer Font.



flvpVideoNameFontColor property

default : 0xFF3333

Set the color of the Video Name font located in the info window.



flvpVideoDescFontColor property

default : 0xFFFFFF

Set the color of the Video Descriptions font located in the info window.



flvpVideoCaptionsFontColor property

default : 0xFFFFFF

Set the color of the Closed Caption font located in the closed captions video.



flvpScrubBarBackColor property

default : 0xFFFFFF

Set the color of the Scrub Bar Background.



flvpScrubBarBufferColor property

default : 0xFFFFFF

Set the color of the Scrub Bar Buffer.



flvpScrubBarFrontColor property

default : 0x00CC00

Set the color of the Scrub Bar Front.


flvpScrubBarDragColor property

default : 0xFFFFFF

Set the color of the Scrub Bar Drag.



flvpVolumeBackColor property

default : 0xFFFFFF

Set the color of the Volume Background.



flvpVolumeFrontColor property

default : 0x00CC00

Set the color of the Volume Front.



flvpVolumeDragColor property

default : 0xFFFFFF

Set the color of the Volume Drag.



flvpVideoNameMenuFontColor property

default : 0x00CC00

Set the color of the Video Name located in the menu.



flvpVideoDescMenuFontColor property

default : 0xFFFFFF

Set the color of the Video Description located in the menu.

flvpToolTipPreviousColor property

default : 0x000000

Set the color of the Previous Buttons Tooltip background.



flvpToolTipPlayColor property

default : 0x000000

Set the color of the Play Buttons Tooltip background.



flvpToolTipPauseColor property

default : 0x000000

Set the color of the Pause Buttons Tooltip background.



flvpToolTipStopColor property

default : 0x000000

Set the color of the Stop Buttons Tooltip background.



flvpToolTipNextColor property

default : 0x000000

Set the color of the Next Buttons Tooltip background.



flvpToolTipVideoInfoColor property

default : 0x000000

Set the color of the Video Info Buttons Tooltip background.



flvpToolTipClosedCaptionsColor property

default : 0x000000

Set the color of the Closed Captions Buttons Tooltip background.



flvpToolTipFullscreenColor property

default : 0x000000

Set the color of the Fullscreen Buttons Tooltip background.



flvpToolTipMenuColor property

default : 0x000000

Set the color of the Menu Buttons Tooltip background.



flvpToolTipVolumeOnColor property

default : 0x000000

Set the color of the Volume On Buttons Tooltip background.



flvpToolTipVolumeOffColor property

default : 0x000000

Set the color of the Volume Off Buttons Tooltip background.



flvpToolTipTimeColor property

default : 0x000000

Set the color of the Time Tooltip background.



flvpToolTipVolumeColor property

default : 0xFFFFFF

Set the color of the Volume Tooltip background.



flvpToolTipPlayFontColor property

default : 0xFFFFFF

Set the color of the Play Tooltip font.



flvpToolTipPauseFontColor property

default : 0xFFFFFF

Set the color of the Pause Tooltip font.



flvpToolTipStopFontColor property

default : 0xFFFFFF

Set the color of the StopTooltip font.



flvpToolTipNextFontColor property

default : 0xFFFFFF

Set the color of the Next Tooltip font.



flvpToolTipVideoInfoFontColor property

default : 0xFFFFFF

Set the color of the Video Info Tooltip font.



flvpToolTipClosedCaptionsFontColor property

default : 0xFFFFFF

Set the color of the Closed Caption Tooltip font.



flvpToolTipFullscreenFontColor property

default : 0xFFFFFF

Set the color of the Fullscreen Tooltip font.



flvpToolTipMenuFontColor property

default : 0xFFFFFF
Set the color of the Menu Tooltip font.



flvpToolTipVolumeOnFontColor property

default : 0xFFFFFF

Set the color of the Volume On Tooltip font.



flvpToolTipVolumeOffFontColor property

default : 0xFFFFFF

Set the color of the Volume Off Tooltip font.



flvpToolTipTimeFontColor property

default : 0xFFFFFF

Set the color of the Time Tooltip font.



flvpToolTipVolumeFontColor property

default : 0xFFFFFF

Set the color of the Volume Tooltip font.






Control the Rollover Colors of the Component Interface



All of the colors support any hexidecimal values.




flvpBackButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Previous button.



flvpPlayButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Play button.



flvpPauseButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Pause button.



flvpStopButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Stop button.



flvpForwardButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Next button.



flvpInfoButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Info button.



flvpCCButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Closed Captions button.



flvpFullscreenButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Fullscreen button.



flvpMenuButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Menu button.



flvpCloseMenuButtonRollOverColor property

default : 0x00CC00

Set the rollover color of the Close Menu button.



flvpScrubBarDragRollOverColor property

default : 0x0033CC

Set the rollover color of the Scrub Bar Drag button.



flvpVolumeButtonOnRollOverColor property

default : 0x00CC00

Set the rollover color of the Volume On button.



flvpVolumeButtonOffRollOverColor property

default : 0x0x00CC00

Set the rollover color of the Volume Off button.



flvpVolumeDragRollOverColor property

default : 0x0033CC

Set the rollover color of the Volume Drag button.






Control the Alpha Transparencies of the Component Interface



All of the alpha transparencies support values of 0-1.




flvpBgAlpha property

default : 1

Set the alpha transparency of the players Background.



flvpControlsBgAlpha property

default : 0.7

Set the alpha transparency of the Interface Background.



flvpInfoBoxAlpha property

default : 0.7

Set the alpha transparency of the Info Background.



flvpCaptionBoxAlpha property

default : 0.7

Set the alpha transparency of the Closed Captions Background.



flvpBackButtonAlpha property

default : 1

Set the alpha transparency of the Previous Button.



flvpBackButtonAlphaDisabled property

default : 0.5

Set the alpha transparency of the Back Button disabled state. This state is invoked when there are no available previous or next videos.


flvpPlayButtonAlpha property

default : 1

Set the alpha transparency of the Play Button.



flvpPlayButtonLargeAlpha property

default : 0.7

Set the alpha transparency of the Large Play Button.



flvpReplayLargeButtonAlpha property

default : 0.7

Set the alpha transparency of the Large Replay Button.



flvpPreviousLargeButtonAlpha property

default : 0.7

Set the alpha transparency of the Large Previous Button.



flvpNextLargeButtonAlpha property

default : 0.7

Set the alpha transparency of the Large Next Button.



flvpPlayLargeButtonRollOverAlpha property

default : 1

Set the alpha rollover transparency of the Large Play Button.



flvpReplayLargeButtonRollOverAlpha property

default : 1

Set the alpha rollover transparency of the Large Replay Button.



flvpPreviousLargeButtonRollOverAlpha property

default : 1

Set the alpha rollover transparency of the Large Previous Button.



flvpNextLargeButtonRollOverAlpha property

default : 1

Set the alpha rollover transparency of the Large Next Button.



flvpPauseButtonAlpha property

default : 1

Set the alpha transparency of the Pause Button.



flvpStopButtonAlpha property

default : 1

Set the alpha transparency of the Stop Button.



flvpForwardButtonAlpha property

default : 1

Set the alpha transparency of the Next Button.



flvpForwardButtonAlphaDisabled property

default : 0.5

Set the alpha transparency of the Next Button disabled state. This state is invoked when there are no available previous or next videos.



flvpInfoButtonAlpha property

default : 1

Set the alpha transparency of the Info Button.



flvpCCButtonAlpha property

default : 1

Set the alpha transparency of the Closed Captions Button.



flvpCloseMenuButtonAlpha property

default : 1

Set the alpha transparency of the Close Menu Button.



flvpFullscreenButtonAlpha property

default : 1

Set the alpha transparency of the Fullscreen Button.



flvpMenuButtonAlpha property

default : 1

Set the alpha transparency of the Menu Button.



flvpTimeFontAlpha property

default : 1

Set the alpha transparency of the Timer Font.



flvpVideoNameFontAlpha property

default : 1

Set the alpha transparency of the Video Name Font.



flvpVideoDescFontAlpha property

default : 1

Set the alpha transparency of the Video Description Font.



flvpVideoCaptionsFontAlpha property

default : 1

Set the alpha transparency of the Closed Captions Font.



flvpMenuItemContainerAlpha property

default : 1

Set the alpha transparency of the background of each menu item.



flvpMenuItemContainerRolloverAlpha property

default : 1

Set the alpha transparency of the background of each menu item during a rollover.



flvpMenuItemContainerRolloutAlpha property

default : 0.7

Set the alpha transparency of the background of each menu item during a rollout.



flvpVideoDescMenuFontAlpha property

default : 1

Set the alpha transparency of the background of each menu item during a rollout.



flvpVideoNameMenuFontAlpha property

default : 1

Set the alpha transparency of the Video Name in the menu.



flvpScrubBarBackAlpha property

default : 0.5

Set the alpha transparency of the Scrub Bar Background.



flvpScrubBarBufferAlpha property

default : 0.2

Set the alpha transparency of the Scrub Bar Buffer.



flvpScrubBarFrontAlpha property

default : 1

Set the alpha transparency of the Scrub Bar Front.



flvpScrubBarDragAlpha property

default : 1

Set the alpha transparency of the Scrub Bar Drag.



flvpVolumeBackAlpha property

default : 0.5

Set the alpha transparency of the Volume Background.



flvpVolumeFrontAlpha property

default : 1

Set the alpha transparency of the Volume Front.



flvpVolumeButtonOnAlpha property

default : 1

Set the alpha transparency of the Volume On Button.



flvpVolumeButtonOffAlpha property

default : 1

Set the alpha transparency of the Volume Off Button.



flvpVolumeDragAlpha property

default : 1

Set the alpha transparency of the Volume Drag.



flvpToolTipPreviousAlpha property

default : 0.7

Set the background alpha transparency of the Previous Tooltip.



flvpToolTipPlayAlpha property

default : 0.7

Set the background alpha transparency of the Play Tooltip.



flvpToolTipPauseAlpha property

default : 0.7

Set the background alpha transparency of the Pause Tooltip.



flvpToolTipStopAlpha property

default : 0.7

Set the background alpha transparency of the Stop Tooltip.



flvpToolTipNextAlpha property

default : 0.7

Set the background alpha transparency of the Next Tooltip.



flvpToolTipVideoInfoAlpha property

default : 0.7

Set the background alpha transparency of the Video Info Tooltip.



flvpToolTipClosedCaptionsAlpha property

default : 0.7

Set the background alpha transparency of the Closed Captions Tooltip.



flvpToolTipFullscreenAlpha property

default : 0.7

Set the background alpha transparency of the Fullscreen Tooltip.



flvpToolTipMenuAlpha property

default : 0.7

Set the background alpha transparency of the Menu Tooltip.



flvpToolTipVolumeOnAlpha property

default : 0.7

Set the background alpha transparency of the Volume On Tooltip.



flvpToolTipVolumeOffAlpha property

default : 0.7

Set the background alpha transparency of the Volume Off Tooltip.



flvpToolTipTimeAlpha property

default : 0.7

Set the background alpha transparency of the Time Tooltip.



flvpToolTipVolumeAlpha property

default : 0.7

Set the background alpha transparency of the Volume Tooltip.



flvpToolTipPreviousFontAlpha property

default : 1

Set the font alpha transparency of the Previous Tooltip.



flvpToolTipPlayFontAlpha property

default : 1

Set the font alpha transparency of the Play Tooltip.



flvpToolTipPauseFontAlpha property

default : 1

Set the font alpha transparency of the Pause Tooltip.



flvpToolTipStopFontAlpha property

default : 1

Set the font alpha transparency of the Stop Tooltip.



flvpToolTipNextFontAlpha property

default : 1

Set the font alpha transparency of the Next Tooltip.



flvpToolTipVideoInfoFontAlpha property

default : 1

Set the font alpha transparency of the Video Info Tooltip.



flvpToolTipClosedCaptionsFontAlpha property

default : 1

Set the font alpha transparency of the Closed Captions Tooltip.



flvpToolTipFullscreenFontAlpha property

default : 1

Set the font alpha transparency of the Fullscreen Tooltip.



flvpToolTipMenuFontAlpha property

default : 1

Set the font alpha transparency of the Menu Tooltip.



flvpToolTipVolumeOnFontAlpha property

default : 1

Set the font alpha transparency of the Volume On Tooltip.



flvpToolTipVolumeOffFontAlpha property

default : 1

Set the font alpha transparency of the Volume Off Tooltip.



flvpToolTipTimeFontAlpha property

default : 1

Set the font alpha transparency of the Time Tooltip.



flvpToolTipVolumeFontAlpha property

default : 1

Set the font alpha transparency of the Volume Tooltip.








A Few Examples Using the FLV Player FlashVar Parameters API





	
		FLV Player FlashVars Example
		
		
	
	
		

Please Upgrade Your Flash Player

Get Adobe Flash player





Create an instance of the FLV Player that is a custom width and height. Use the video information that is contained in the videos.xml file structure. Lower the default volume to 20.


	
		FLV Player FlashVars Example
		
		
	
	
		

Please Upgrade Your Flash Player

Get Adobe Flash player



Article Details
Article ID: 35
Created On: 31 Aug 2009 2:17 PM

 This article was helpful  This article was not helpful

 Back
 Log in  
Username:
Password:
Remember Me:
 
 Search
 Article Options