****Flash_FLV_Player_FlashVars.txt - Free Flash FLV Video Player**** ##################################################################################### Version : Flash FLV Player SWF v1.0 Beta Released : January 10, 2011 Copyright : (c)2011 Craig Chant (DJ - C.D.C.) http://dance-music.org Coded In : FLASH - X/HTML - JAVASCRIPT Licence : Released under freeware licence - no warranty given. ##################################################################################### Acknowledgements -> Inspired by Lee Brimelow and his 'Flash Video Basics' tutorials (http://www.gotoandlearn.com) ##################################################################################### !...ALL VARIABLES ARE CASE SENSITIVE...! >>>>>> VIDEO SETTINGS <<<<<< Buffer : Sets buffer length in seconds (Min: 1 , Default: 20) : Flv : Path / URL to flash video file (.flv) FlvWidth : Set overall width of FLV player (Default: 800) - dynamically resizes all content (do not pass as a flashVar) FlvHeight : Set overall height of FLV player (Default: 600) - dynamically resizes all content (do not pass as a flashVar) NoAuto : Sets if the video should NOT auto play (Range: 0-1, Default: 0) NoLoop : Sets if the video should NOT loop when video ends (Range: 0-1, Default: 0) FlvTitle : Sets title of the video (shown on the buffering screen only!) TitleSize : Sets size of video title text (Default: 25) TitleColor : Sets colour of video title text (Default: FFFFFF, White) - Ensure you use hexadecimal colours without the hash (#) VideoWidth : Sets width of video window VideoHeight : Sets height of video window VideoTop : Sets top margin of video window VideoLeft : Sets left margin of video window VideoAlpha : Sets the alpha transparency of the video window VideoBGImg : Path / URL to video background image VideoBGWidth : Sets width of video background VideoBGHeight : Sets height of video background VideoBGTop : Sets top margin of video background VideoBGLeft : Sets left margin of video background VideoBGAlpha : Sets the alpha transparency of the video background NOTES: Only us a positive number for VideoTop to push the video window down or VideoLeft to move it right, otherwise the video will go off screen. If you use use the VideoHeight to stretch the video when no control bar background is displayed, remember you can alter all the other controls' alpha transparencies to get a nice see through effect. FlvHeight & FlvWidth are used to size the flash object via the HTML tag and should not be passed as actual flashVars! You can use the VideoBGImg/VideoBGApha and VideoAlpha settings to create neat effects or simply to add a background watermark. >>>>>> LOGO IMAGE <<<<<< HideLogo : Hides logo image (Range: 0-1, Default: 0) LogoAlpha : Sets logo image alpha transparency (Range: 0-100) Logo : Path / URL to alternative logo image LogoURL : URL of website to open when logo is clicked LogoWidth : Sets logo image width LogoHeight : Sets logo image height LogoLeft : Sets left margin of logo image (use negative numbers to move in opposite direction) LogoTop : Sets top margin of logo image (use negative numbers to move in opposite direction) >>>>>> TIMER DISPLAY <<<<< HideTimer : Hides timer display (Range: 0-1, Default: 0) TimerSize : Set size of timer text (Default: 15) TimerColor : Set colour of timer text (Default: 000000, Black) - Ensure you use hexadecimal colours without the hash (#) TimerHoverColor : Set colour of timer text on mouse hover over (Default: FFFFFF, White) - Ensure you use hexadecimal colours without the hash (#) Timer2GoColor : Set colour of timer text when showing time left (Default: FFFF00, Yellow) - Ensure you use hexadecimal colours without the hash (#) TimerLenColor : Set colour of timer text when showing total video length (Default: 00FF00, Green) - Ensure you use hexadecimal colours without the hash (#) TimerWidth : Set width of timer text TimerHeight : Sets height of timer text TimerLeft : Sets left margin of timer text (use negative numbers to move in opposite direction) TimerTop : Sets top margin of timer text (use negative numbers to move in opposite direction) >>>>>> PERCENT LOADED <<<<< HidePerc : Hides percent loaded counter (Range: 0-1, Default: 0) PercSize : Set size of percent loaded text (Default: 15) PercColor : Set colour of percent loaded text (Default: 000000, Black) - Ensure you use hexadecimal colours without the hash (#) PercWidth : Set width of percent loaded text PercHeight : Sets height of percent loaded text PercLeft : Sets left margin of percent loaded text (use negative numbers to move in opposite direction) PercTop : Sets top margin of percent loaded text (use negative numbers to move in opposite direction) >>>>>> REWIND BUTTON <<<<<< HideRewindButton : Hides rewind button (Range: 0-1, Default: 0) RewindButtonAlpha : Sets rewind button alpha transparency (Range: 0-100) RewindButtonImg : Path / URL to alternative rewind button image RewindWidth : Sets rewind button width RewindHeight : Sets rewind button height RewindLeft : Sets left margin of rewind button (use negative numbers to move in opposite direction) RewindTop : Sets top margin of rewind button (use negative numbers to move in opposite direction) RewindButtonOverImg : Path / URL to alternative rewind mouse hover over button image RewindOverWidth : Sets rewind mouse hover over button width RewindOverHeight : Sets rewind mouse hover over button height RewindOverLeft : Sets left margin of mouse hover over button (use negative numbers to move in opposite direction) RewindOverTop : Sets top margin of rewind mouse hover over button (use negative numbers to move in opposite direction) RewindButtonDownImg : Path / URL to alternative rewind mouse press down button image RewindDownWidth : Sets rewind mouse hover over button width RewindDownHeight : Sets rewind mouse hover over button height RewindDownLeft : Sets left margin of mouse hover over button (use negative numbers to move in opposite direction) RewindDownTop : Sets top margin of rewind mouse hover over button (use negative numbers to move in opposite direction) NOTES: Rewind button 'over' and 'down' dimensions and positioning only works if you provide these attributes otherwise it uses the default rewind button settings for them instead. >>>>>> PLAY BUTTON <<<<<< HidePlayButton : Hides play button and pause button (Range: 0-1, Default: 0) PlayButtonAlpha : Sets play button alpha transparency (Range: 0-100) PlayButtonImg : Path / URL to alternative play button image PlayWidth : Sets play button width PlayHeight : Sets play button height PlayLeft : Sets left margin of play button (use negative numbers to move in opposite direction) PlayTop : Sets top margin of play button (use negative numbers to move in opposite direction) PlayButtonOverImg : Path / URL to alternative play mouse hover over button image PlayOverWidth : Sets play mouse hover over button width PlayOverHeight : Sets play mouse hover over button width PlayOverLeft : Sets left margin of mouse hover over play button (use negative numbers to move in opposite direction) PlayOverTop : Sets top margin of mouse hover over play button (use negative numbers to move in opposite direction) >>>>>> PAUSE BUTTON <<<<<< PauseButtonAlpha : Sets pause button alpha transparency (Range: 0-100) PauseButtonImg : Path / URL to alternative pause button image PauseWidth : Sets pause button width PauseHeight : Sets pause button height PauseLeft : Sets left margin of pause button (use negative numbers to move in opposite direction) PauseTop : Sets top margin of pause button (use negative numbers to move in opposite direction) PauseButtonOverImg : Path / URL to alternative pause mouse hover over button image PauseOverWidth : Sets pause mouse hover over button width PauseOverHeight : Sets pause mouse hover over button height PauseOverLeft : Sets left margin of mouse hover over pause button (use negative numbers to move in opposite direction) PauseOverTop : Sets top margin of mouse hover over pause button (use negative numbers to move in opposite direction) NOTES: Pause button dimensions and positioning only works if you provide an alternative image otherwise it uses the play button settings for both. You can only provide an alternative pause button image if you have provided an alternative play button image! >>>>>> MUTE BUTTONS <<<<<< HideMuteButton : Hides mute button (Range: 0-1, Default: 0) MuteButtonAlpha : Sets mute button alpha transparency (Range: 0-100) MuteButtonImg : Path / URL to alternative mute 'off' button image MuteWidth : Sets mute 'off' button width MuteHeight : Sets mute 'off' button height MuteLeft : Sets left margin of mute 'off' button (use negative numbers to move in opposite direction) MuteTop : Sets top margin of mute 'off' button (use negative numbers to move in opposite direction) MuteButtonOverImg : Path / URL to alternative mute 'off' mouse hover over button image MuteOverWidth : Sets mute 'off' mouse hover over button width MuteOverHeight : Sets mute 'off' mouse hover over button height MuteOverLeft : Sets left margin of mute 'off' mouse hover over button (use negative numbers to move in opposite direction) MuteOverTop : Sets top margin of mute 'off' mouse hover over button (use negative numbers to move in opposite direction) MuteOnButtonImg : Path / URL to alternative mute 'on' button image MuteOnWidth : Sets mute 'on' button width MuteOnHeight : Sets mute 'on' button height MuteOnLeft : Sets left margin of mute 'on' button (use negative numbers to move in opposite direction) MuteOnTop : Sets top margin of mute 'on' button (use negative numbers to move in opposite direction) MuteOnButtonOverImg : Path / URL to alternative mute 'on' mouse hover over button image MuteOnOverWidth : Sets mute 'on' mouse hover over button width MuteOnOverHeight : Sets mute 'on' mouse hover over button height MuteOnOverLeft : Sets left margin of mute 'on' mouse hover over button (use negative numbers to move in opposite direction) MuteOnOverTop : Sets top margin of mute 'on' mouse hover over button (use negative numbers to move in opposite direction) NOTES: Mute 'on' button dimensions and positioning only works if you provide an alternative image otherwise it uses the mute 'off' button settings for both. If you use your own button images and only provide the initial button ie.(RewindButtonImg, PlayButtonImg and/or PauseButtonImg, MuteButtonImg and/or MuteOnButtonImg), the player will automatically substitute the other possible states (On, Over, Down) with the initial button image provided. If you provide a 'play' button but no 'pause' button the 'play' button will be used instead. The same goes for the mute 'on' button if only mute 'off' button is provided, then that is used for both 'on' and 'off' buttons. IMPORTANT! If you use this simple rule you should not have too many issues :- If you are going to provide alternative buttons then either provide just the initial button or all possible states, you CANNOT use the default in-built initial buttons and then provide your own alternatives for the other button states i.e. (On, Over, Down). Don't forget you could use a 1 pixel transparent image and give that as the PlayButtonImg / PauseButtonImg images, then create a player with no controls except a PlayButtonOverImg and PauseButtonOverImg. This enables you to have a play button that could then appear in the middle of the video on mouse over or a pause button if paused. Remember to use the PlayWidth, PlayHeight, PlayTop and PlayLeft options to position and dimension the buttons as desired. With a little experimenting, the possiblities are endless. >>>>>> VOLUME SLIDER <<<<<< HideVolSlider : Hides volume slider (Range: 0-1, Default: 0) HideVolSliderAlpha : Sets volume slider alpha transparency (Range: 0-100) VolSliderWidth : Sets volume slider width VolSliderHeight : Sets volume slider height VolSliderLeft : Sets left margin of volume slider (use negative numbers to move in opposite direction) VolSliderTop : Sets top margin of volume slider (use negative numbers to move in opposite direction) >>>>>> PLAYER SCRUBBER BAR (VIDEO SEEK SLIDER) <<<<<< HideScrub : Hides the scrubber bar (Range: 0-1, Default: 0) ScrubAlpha : Sets scrubber bar alpha transparency (Range: 0-100 , Default: 50) ScrubWidth : Sets scrubber bar width ScrubHeight : Sets scrubber bar height ScrubLeft : Sets left margin of scrubber button (use negative numbers to move in opposite direction) ScrubTop : Sets top margin of scrubber button (use negative numbers to move in opposite direction) >>>>>> PLAYER PROGRESS BAR <<<<<< ProgressBarAlpha : Sets progress bar alpha transparency (Range: 0-100 , Default: 60) >>>>>> ENLARGE PLAYER BUTTON <<<<<< HideEB : Hides 'enlarge' button (Range: 0-1, Default: 0) EBAlpha : Sets 'enlarge' button alpha transparency (Range: 0-100) EBWidth : Set width of 'enlarge' button EBHeight : Sets height of 'enlarge' button EBLeft : Sets left margin of 'enlarge' button (use negative numbers to move in opposite direction) EBTop : Sets top margin of 'enlarge' button (use negative numbers to move in opposite direction) >>>>>> PLAYER CONTROL BAR <<<<<< HideControlBar : Hides the player control bar (Range: 0-1, Default: 0) ControlBarAlpha : Sets control bar alpha transparency (Range: 0-100 , Default: 50) ControlBarImg : Path / URL to alternative control bar image ControlBarWidth : Sets control bar width ControlBarHeight : Sets control bar height ControlBarLeft : Sets left margin of control bar (use negative numbers to move in opposite direction) ControlBarTop : Sets top margin of control bar (use negative numbers to move in opposite direction) >>>>>> CONTROL BAR BACKGROUND <<<<<< HideControlBarBG : Hides the player control bar background (Range: 0-1, Default: 0) ControlBarBGAlpha : Sets control bar background alpha transparency (Range: 0-100) ControlBarBGImg : Path / URL to alternative control bar background image ControlBarBGWidth : Sets control bar width ControlBarBGHeight : Sets control bar height ControlBarBGLeft : Sets left margin of control bar (use negative numbers to move in opposite direction) ControlBarBGTop : Sets top margin of control bar (use negative numbers to move in opposite direction) ControlBarBGTitle : Shows video title (FlvTitle) on control bar background (Range: 0-1, Default: 0) ControlBarBGTitleWidth : Sets video title width on control bar background ControlBarBGTitleHeight : Sets video title height on control bar background ControlBarBGTitleLeft : Sets left margin of control bar background video title text (use negative numbers to move in opposite direction) ControlBarBGTitleTop : Sets top margin of bar background video title text (use negative numbers to move in opposite direction) ControlBarBGTitleSize : Sets size of control bar background video title text (Default: 15) ControlBarBGTitleColor : Sets colour of control bar background video title text (Default: FFFFFF, White) - Ensure you use hexadecimal colours without the hash (#) NOTES: If you hide the control bar background remember to use VideoHeight to stretch video window to fill the blank space. >>>>>> PLAYER BORDER <<<<<< HideBorder : Hides the border (Range: 0-1, Default: 0) BorderAlpha : Sets border alpha transparency (Range: 0-100) BorderImg : Path / URL to alternative border image BorderWidth : Sets border width BorderHeight : Sets border height BorderLeft : Sets left margin of the border (use negative numbers to move in opposite direction) BorderTop : Sets top margin of the border (use negative numbers to move in opposite direction) NOTES: Remember to use a transparent image for the border ensuring the middle is see through so the other controls and video window is visible. ###################################### ######### GENERAL USAGE NOTES ######## ###################################### >>>>>> IMAGES <<<<<< Try to have your source images the correct size before you use them, this way you only need to tweak each dimension to get precise results. Remember the smaller the file sizes you use as your images, the quicker they will load into the player giving the user a more enjoyable experience. Best image formats to use are JPEG (.jpg), PNG (.png) and GIF (.gif) all with background transparencies. Image paths / urls can be either relative (/mydirectory/myfile) or fully qualified (http://www.mydomain.com/mydirectory/myfile) Only use images hosted on the same domain as the flash player otherwise flash will not show the image and give a security warning! >>>>>> SETTING VALUES <<<<<< If the variable is a toggle (show/hide), simply use 1 or 0 to say if the variable is to be activated or not (1=true, 0=false) Dimension settings such as Width, Height, Top, Left can be given as decimal numbers; so to get that perfect measurement for example you could use:- RewindWidth = 21.35 Alpha transparency ranges from 0 (invisible / totaly transparent) to 100 (fully visible / solid) >>>>>> COLOURS <<<<<< Colours should be given as hexadecimal without including the hash (#), so to set text RED for example you could use:- TitleColor = FF0000 Note that all colour variables are spelt 'color' using the American spelling. >>>>>> RESIZING FLV PLAYER <<<<<< If you want the video player to be smaller or larger, instead using the VideoWidth / VideoHeight settings to resize the actual video window. It is best to design your player using the default sizes for each component and then use the FlvWidth and FlvHeight variables which will resize the entire player and auto scale each component. The 'video' dimensions are for tweaking the main design and enabling you to move the controls around the player to any location without clipping the video window. Doing it this way means everything is scaled to fit your desired player dimensions, simply experiment with the settings and you will quickly find what works for you! Remember the flvWidth & flvHeight variables are not used as flasVars but simply set the & HTML tag sizes! >>>>>> DEFAULT COMPONENT SIZES <<<<<< All measurements are in pixels (but don't use the PX when giving values!) Border : W:814.8 x H:619.3 Video Window : W:803.0 x H:554.7 Video BG : W:803.0 x H:554.7 Control Bar BG : W:802.4 x H:60.0 Control Bar BG Title : W:792.8 x H:50.9 Control Bar : W:768.3 x H:32.0 Scrubber Bar : W:310.8 x H:31.9 Progress Bar : W:296.6 x H:17.3 Percent Loaded : W:49.0 x H:21.0 Rewind Button : W:33.3 x H:32.0 Play/Pause Button : W:33.3 x H:33.1 Mute Button : W:19.8 x H:30.5 Volume Slider : W:56.0 x H:14.6 Timer Display : W:63.5 x H:21.0 Enlarge Button : W:25.0 x H:25.0 Logo : W:160.0 x H:55.0