Plugin Parameters
The plugin parameters can be set in two ways: First, in the administration backend of the plugin, you can preset global parameters which affect all videos. Second, you can override these global settings in each tag individually. When overriding parameters, you add them - separated by spaces - inside the first part of the tag like this: {flv width="180" height="150" autostart="true"}party{/flv}. Overriding always uses a lowercase attribute name, followed by an equal sign, followed by the attribute's value quoted in double quotation marks.
The following table shows the supported parameter names, their attribute counterparts (the name to use when overriding) and their possible values. As described in the Table of supported local formats, there are different players used for various media formats. The only player which supports all of the listed parameters is the JW Media Player. All other players usually support width, height and autoplay only. The YouTube player is an exception. It supports some special attributes which are described in the table at the end of this page.Please note: Some special attributes are not available in the backend parameter page but can be set in the tag only. Those attributes are explained in the remarks.
| 00000;">Global section | Global parameter name | Attribute name | Values |
|---|---|---|---|
| Plugin Parameters | Container class | avcss | any class name |
| Plugin Parameters | Master video width | width | a pixel value |
| Plugin Parameters | Master video height | height | a pixel value |
| Plugin Parameters | iFilm video width | iwidth | a pixel value |
| Plugin Parameters | iFilm video height | iheight | a pixel value |
| Plugin Parameters | Metacafe video width | mwidth | a pixel value |
| Plugin Parameters | Metacafe video height | mheight | a pixel value |
| Plugin Parameters | Flash display mode | wmode | window, transparent or opaque |
| Plugin Parameters | Flash background color | bgcolor | a color value 1) |
| Plugin Parameters | Master audio width | awidth | a pixel value |
| Plugin Parameters | Master audio height | aheight | a pixel value |
| Advanced Parameters | Controls color | pbgcolor | a color value 1) |
| Advanced Parameters | Controls text color | pfgcolor | a color value 1) |
| Advanced Parameters | Controls highlight color | phicolor | a color value 1) |
| Advanced Parameters | Video background | psccolor | a color value 1) |
| Advanced Parameters | Autostart | autostart | true or false |
| Advanced Parameters | Show control bar | shownav | true or false |
| Advanced Parameters | Show digits | showdigits | true or false |
| Advanced Parameters | Show icons | showicons | true or false |
| Advanced Parameters | Show stop | showstop | true or false |
| Advanced Parameters | Show download | showdownload | true or false 7) |
| Advanced Parameters | Show fullscreen button | usefullscreen | true or false |
| Advanced Parameters | Scriptable | enablejs | true or false 5) |
| Advanced Parameters | Logo | logo | URL/relative path 2) |
| Advanced Parameters | Video screen mode | screenmode | a mode identifier 3) |
| Advanced Parameters | Playlist size | plsize | a pixel value 3) |
| Advanced Parameters | Stretch content | stretch | 0, 1, 2 or 3 4) |
| Advanced Parameters | Minimum Flash Version | flashver | Three numbers, separated by dots 10) |
| Advanced Parameters | Show equalizer | showeq | true or false |
| Advanced Parameters | Show search bar | searchbar | true or false |
| Advanced Parameters | Search provider | searchlink | URL 12) |
| Advanced Parameters | Alternate content | alt | any valid HTML 13) |
| - | - | cfg | URL 6) |
| - | - | displaywidth | a pixel value 3) |
| - | - | displayheight | a pixel value 3) |
| - | - | divid | any ID value 5) |
| - | - | link | URL 7) |
| - | - | linkfromdisplay | true or false 7) |
| - | - | linktarget | a window name (e.g. _blank) 7) |
| - | - | plthumbs | true or false 8) |
| - | - | type | A file type 9) |
| - | - | repeat | false, true or list 8) |
| - | - | shuffle | true or false 8) |
| - | - | autoscroll | true or false 8) |
| - | - | recurl | URL 11) |
| - | - | img | URL 14) |
| - | - | volume | int 15) |
| - | - | menu | true or false 16) |
| - | - | popup | true or false 17) |
Remarks:
1. Color values can be specified in any of the following formats and are converted to the correct format automatically:
- A 6-digit hexadecimal value, preceeded by a hash sign (e.g.: #223344 like ordinary HTML syntax)
- A 3-digit hexadecimal value, preceeded by a hash sign (e.g.: #234 like CSS short syntax)
- 3 decimal values following the word rgb in parenthesis (e.g.: rgb(99,140,235) - like CSS rgb syntax)
- A 1-6-digit hexadecimal value, preceeded by 0x (e.g.: 0x2345 like in JavaScript)
- One of the 16 standardized color names as specified in HTML 4.0.1 (e.g.: red)
2. Logo images can be specified either by their absolute URL (e.g.: http://host/logo.png) or - if locally stored on the same server - by their local path (e.g.: /images/stories/logo2.png). The logo should be png (preferred) or gif in order to support transparency. The logo is always positioned in the upper right corner of the video screen. If you like a different position you can work around this limitation by creating a larger image where most of the image is transparent.
3. The parameter screenmode is kind of special. It is not an actual parameter for JW mediaplayer but a shortcut which affects how the player's parameters displaywidth and displayheight(those specify the size of the player's video screen) are calculated by the plugin. The following modes are available:
| Mode | Description | |
|---|---|---|
| default | This mode results in the standard display where the player's control bar is located below the screen. Since the control bar has a height of 20 pixels, the available screen size iswidth × height - 20. | |
| coverlay | In this mode, displaywidth and displayheight are set equally to width and height. This results in the control bar being shown transparently inside the screen area. Furthermore, the control bar fades out, if the mouse leaves the screen area and reappears if the mouse enters the screen area. The available screen size in this mode is width × height. | |
| plbottom | This mode is intended to display a playlist at the bottom below the control bar. The height of this scrollable window is taken from the parameter plsize. The available screen size in this mode is width × height - 20 - plsize. | |
| plright | Like plbottom, except the playlist is to be displayed to the right of the screen. The width of the scrollable window is taken from the parameter plsize. The available screen size in this mode is width - plsize × height - 20. | |
| floatcplright | A combination of coverlay and plright. In this mode, the available screen size is width - plsize × height. |
Please note: When overriding displaywidth or displayheight within the tag, then the whole automatic calculation described above is disabled.
4. The stretch mode defines how to stretch movies to make them fit the display size. 1 will stretch them proportionally to fill the display, 0 will stretch them to fit. 2 will stretch them disproportionally to fit both height and width. 3 will show all items in their original dimensions.
5. If enabling scripting, the player can be controlled with JavaScript. To do this (and to distinguish multiple players in a page) it has to be addressed by it's ID. For easy scripting, this ID (which otherwise would be assigned automatically by the plugin) can be set manually by using the attribute divid. The resulting ID of the flash object to be used from within JavaScript is the specified value, prefixed by p_.
6. If many parameters have to be specified, you end up with quite lenghly tags. Alternatively, you can put all those parameters in a config file and then simply reference that. The URL, specified in the cfg attribute should point to a configuration XML file. The variable names in that file might differ from the attributes listed above. See the JW Media Player documentation for a reference. An example file can be found here.
7. The URL, specified in the link attribute is normally used for providing a download of the media or related information. This URL is invoked, when the player's download button is activated. Additionally, if the attribute linkfromdisplay is set to true, a click in the players display invokes that URL instead of toggling play/pause. The attribute linktarget (default: _blank) specifies the window in which this URL will be shown.
8. If plthumbs is set to true and a playlist is provided which provides image tags in its entries, those images are displayed as thumbnails in the playlist. If autoscroll is set to true, the playlist is scrolling automatically via mouse movement instead of using a scrollbar. The attribute repeat specifies how to proceed when a media stream is finished: false means stop the player, truemeans repeat the stream from beginning and list means start playing the next item in the playlist. In this context, the next item to be played is selected depending on the parameter shuffle(default: true). If this is set to false, the playlist is iterated sequentially. Using playlists is explained further down.
9. If using the remote variant of a media tag, you can reference any media file, even with a different extension or non extension at all. If this is the case, JW Media Player might not recognize the file type correctly. With this attribute you can forcibly set the media type to one of the supported types.
10. This attribute allows you to set the minimum Flash version, required to use the builtin JW Media Player. The player requires at least Flash version 7, however when running under that version, the features "display of GIF/PNG images", "smoothing of scaled images/video", VP6 and H264 encoded video, javascripting and the digits in the controlbar are not functional. Furthermore, for full screen display, at least Flash version 9.0.28 is required and for playing H264 encoded videos, at least Flash version 9.0.98. For full functionality, it is therefore stronglyrecommended, to specify at least version 9.0.28 (if using the fullscreen feature) or version 8 (without using fullscreen).
11. This attribute provides an URL for a recommendations XML file. A recommendations XML file contains titles, thumbnails and URLs for recommended Items, related to the currently playing video. It's content is shown after the video has finished playing (Similar like on YouTube). A sample recommendations XML file can be found here.
12. The URL provided here defines an alternate search provider which is used, when a user uses the search function of the search bar. The text typed by the user is appended to this URL. Example: If the URL is http://youtube.com/results?search_query= and the user searches for computer, then the resulting query is http://youtube.com/results?search_query=computer.
13. By default, the plugin provides two different warnings if the content can not be displayed: The first warning is displayed, if JavaScript is not available. Another warning is displayed, when JavaScript is working, but the flash plugin is either not available or it's version is below the value of the parameter flashver. With this parameter, the second warning can be replaced by custom content. If custom content is provided, the first warning will be disabled completely. The custom content must not contain any single quote or closing curly brace. To display those characters, they have to be encoded using html entities. The default warnings look like this:
Typical appearance of the default JavaScript warning (uses localized text):
To display this content, you need a JavaScript capable browser.
Typical appearance of the default Flash warning (uses localized text):
14. This attribute allows to specify a preview (thumbnail) image which is shown whenever the player is stopped. If a relative path is specified (i.e. the value does not start with a slash or http://or https://), then it is automatically prefixed by the default image directory (usually images/stories).
15. The initial volume. Unit is percent, which implies a valid range of 0 .. 100.
16. This attribute can be used to manipulate the context menu of the player. For flash based players, setting this to false restricts the menu to the basic entries. For the DivX player, this disables the menu completely.
17. When this attribute is set to true, then the resulting player will be invisible and prepared to be displayed in a popup window or lightbox by using the avrpopup special tag.
Special parameters of the YouTube player
When using the tag {youtube}, the YouTube player supports the following additional attributes (All boolean attributes have a default value of false):
| Global section | Global parameter name | Attribute name | YouTube API Name | Values |
|---|---|---|---|---|
| Advanced Parameters | Autostart | autostart | autoplay | true or false |
| Advanced Parameters | Controls color | pbgcolor | color1 | a color value |
| Advanced Parameters | Controls highlight color | phicolor | color2 | a color value |
| - | - | ytborder | border | true or false |
| - | - | ytegm | egm | true or false |
| - | - | ytloop | loop | true or false |
| - | - | ytrel | rel | true or false |
More information about the meaning of those attributes can be found in the YouTube API specification here.