|
JoomlaExtension's MP3 Player is extremely configurable so as to allow for very individual players for Community Builder Profiles.
The configuration variables can be divided into the following categories: Basic Configuration, Color Configuration, Display Configuration, Full screen Configuration, Player interaction Configuration and Playback Configuration.
Below you will find an explanation for each of these categories.
BASIC CONFIGURATION VARIABLES
-
image (url)*: If you play MP3 of FLV* files, you can use this variable to show a preview image or album cover. It can be a JPG/SWF/PNG/GIF file. You can also assign an image for every item in a playlist.
-
displayheight (number)*: This variable is used by the players and sets the height of the display. It defaults to the height of the SWF object minus the controlbar (20px), but if you set it to a smaller height, the playlist will show up. If you set it to exactly the height of the SWF object, the controlbar will disappear as well.
-
transition (fade,bgfade,blocks,circles,fluids,lines,random)*: This variable is only used by the rotator. It sets the transition to use between images. "random" will show all transitions randomly. The default is "fade".
-
shownavigation (true,false)*: Another variable only for the rotator. It enables/disables the navigation bar.
COLOR VARIABLES
-
backcolor (color): Background color of the player/rotator. The default for the players is 0xFFFFFF (white) and for the rotator 0x000000 (black).
- frontcolor (color): Texts / buttons color of the player/rotator. The default for the players is 0x000000 (black) and for the rotator 0xFFFFFF (white).
- lightcolor (color): Rollover/ active color of the player/rotator. The default for the players is 0x000000 (black) and for the rotator 0xCC0000 (red).
DISPLAY VARIABLES
-
showicons (true,false)*: Show or hide the play and activity icons in the middle of the display. Defaults to true for the players and false for the rotator.
-
overstretch (true,false,fit,none)*: Defines how to stretch images/movies to make them fit the display.
-
"true" will stretch them proportionally to fill the display,
-
"false" will stretch them to fit.
-
"fit" will stretch them disproportionately to fit both height and width.
-
"none" will show all items in their original dimensions.
-
Defaults to "fit" for the players and "false" for the rotator.
-
displaywidth (number of pixels)*: Instead of the "displayheight", you can set "displaywidth" to a size smaller that the SWF width, to make the playlist appear at the right side of the display.
-
logo (url)*: Set this variable to put a watermark logo in the bottom right corner of the display. If you've set the "link" variable as well, the logo will link to there. Again, all image formats are supported, but transparent PNG files give the best results.
-
captions (url)*: You can set this variable to the location of a textfile with captions. The players support SMIL's TimedText format and the SRT format used with ripped DVD's.
-
showeq (true,false): Set to true to show a fake equalizer in the display. It adds a nice graphical touch when you are playing MP3 files.
-
showdigits (true,false): Set this to false if you don't want the elapsed/total time to display in the controlbar of the players.
-
largecontrols (true,false)*: Set this to true to make the controlbar twice as large. This is useful to visually impaired users.
-
thumbsinplaylist (true,false)*: If you have a playlist that also includes preview images with the <image> element, you can set this variable to "true" to show them in the playlist.
-
autoscroll (true,false): By default, the playlist area of the players will have a scrollbar if the number of items is too long. If you set this variable to "true", the scrollbar will disappear and the playlist will scroll automatically, depending upon the mouse position.
FULLSCREEN VARIABLES*
-
fullscreenpage (url)*: The players automatically show a fullscreen button. Clicking on the fullscreen button will jump to the HTML page you specified here. In this HTML page, you can present a full-browser-screen version of the mediaplayer.
-
fsreturnpage (url)*: To let the browser know what page to jump to when somebody wants to close the semi-fullscreen, you can set the "normal" page as the fsreturnpage variable. It will be passed through to the fullscreen page with a flashcookie.
-
fullscreenmode (true,false)*: Set this variable to true for embedding of the player in the fullscreen page. The player will then get the "file","image","id" and "fsreturnpage" variables from a cookie and will present the "normal screen" button in the playlist, instead of the "full screen" button.
-
showfsbutton (true,false)*: Set this variable to false to hide the fullscreenbutton, even if flash9 is detected.
INTERACTION VARIABLES
-
link (url)*: If you have set a watermark logo, you can set this variable to a web address you want the logo to link to. You can also assign a link for every item in a playlist.
-
-
linkfromdisplay (true,false)*: Additionally, you can set this variable to "true" to make a click on the image/video display result in a jump to the "link" webpage.
-
linktarget (frame)*: The targetframe a link (from logo, display or playlist buttons) will open into. The default is "_self". Set it to "_blank" to open links in a new window.
-
type (mp3,flv,rtmp,jpg,png,gif,swf,rbs)*: The players determine the type of file to play based upon the last three characters of the "file" variable. This method doesn't work if you use database id's or mod_rewrite to retrieve the files. Therefore you can set this variable to tell the players of which filetype the file you want to play is. The type is also assigned to every item in a playlist. If no match is found, the player assumes it loads a playlist.
PLAYBACK VARIABLES
-
autostart (true,false): Set this to "true" to make the player automatically start playing when the page loads.
-
volume (number): The default volume for playback of sounds/movies is 80, but you can set another value with this variable.
-
shuffle (true,false): If you use a playlist, the players and rotator will automatically shuffle the entries to prevent boredom. Set this variable to "false" to play all items sequentially.
-
repeat (true,false,list): By default, the players will stop playback after every item to preserve bandwidth (repeat=false). You can set this to "list" to playback all items in a playlist once, or to "true" to continously playback your song/movie/playlist. The rotator's default is "true".
-
rotatetime (number)*: Use this variable to set the number of seconds you want an image to display. The default is "10" for the mediaplayer and "5" for the rotator.
-
bufferlength (number)*: This sets the number of seconds an FLV should be buffered ahead before the player starts it. Set this smaller for fast connections or short videos. Set this bigger for slow connections. The default is 5 seconds.
Please Note:
variables marked with an * will be available with the next release of the MP3 Media Player (Community Builder Edition). We have already began work on their inclusion after feedback from our beta testers.
The MP3 Media Player Plugin v1.0 will only play mp3 files. Once again the feedback from our beta testers have prompted us to enable a wider range of media file capabilities which will be available with the next release of the plugin. Furthermore the plugin will support three commonly used playlist formats to ensure maximum compatibility: XSPF (much used for CC music), RSS (much-used for Podcasts) and ATOM (much-used by Blogs).
|