Projekktor supports a big portion of different configuration parameters to give you a high flexibility in customizing and branding it. All parameters described here are optional - you may want to, but do not have to use them. Per default the player is quite undemanding regarding external input. All it needs is a well formed reel.xml. But unfortunately if you want to unleash the full power of customizing you have to deal with information given at this page.
On startup the player queries different external resources to get its configuration setup. The resources have a predefined hierarchy where lower levels are overwritten by higher ones. It is vital that you know and understand this principle in order to not getting mad during customizing.
Lets start with a brief overview on resources that are queried during player initialization - given in hierarchic order from top (→winner) to bottom (→looser):
Except of reel.xml all other resources are optional.
You do not need to provide a pnetwork.xml if you do not use a multi-channel setup.
If the English default phrases working well for you, you do not have to provide a plang_xxx.xml file.
If your playlist file is called reel.xml and lies in the same directory like the projekktor.swf
does you do not even have to provide any single FlashVar parameter.
Flashvars allows you to set configuration variables to the SWF file directly through the HTML embed object code. Parameters given here are basically used to set the startup- and initialization environment. The bigger bulk of configuration parameters is interpreted out of the “reel.xml” (or alternative playlist file as configured). So available FlashVars are limited to the absolute essentials.
Type: hex color code
Default Value: 0x1A1A1A
Sets the center gradient color of the player´s loading-screen.
Type: hex color code
Default Value: 0x1A1A1A
Sets the upper and lower gradient color of the player´s loading-screen. Setting this equal to colA will force a plain colored loading-screen background.
Type: string
Default Value: empty
Full URL to an external JPG, PNG or GIF image to replace the default Projekktor Logo within the loading-screen. You should keep this file as small sized as possible.
Type: Boolean
Default Value: false
Setting this to true will let the player stay in boot-screen even if initialization has completed. This is just intended for testing the custom boot -colors and -playerlogo.
Type: string
Default Value: eng
Sets the language short name to use to create the filename for the language pack to load. Per default plang_eng.xml is loaded. Setting lang e.g. to ger will force the player to load plang_ger.xml. If the specific .XML file is not present or available, the player will use its built in default phrases (which are in English).
Type: boolean
Default Value: false
Enables / Disables debug callbacks. If set to true the player_js variable is automatically set to true also in order to allow javascript callbacks.
Type: string
Default Value: console.log('%txt%')
The javascript command to trigger on debug-events. The above mentioned default-value is quite useful for Firefox users (with “Firebug” enabled). Itz will pump the player messages right into your JS console.
%txt% is replaced by the debug message.
Type: string
Default Value: reel.xml
Full or relative URL to the initial reel where all the playlist magic and furhter configuration takes place.
Type: string
Default Value: empty
ID of video to begin playback with. Per default the player starts with the first video in reel. If vidid is set it will scan the first valid reel-file for the ID specified. If found the player will start with the corresponding video. If not this value is ignored and the player will start with the first video in reel.
This parameter is implemented for the blog embed function and for deeplinking but you may find an other useful reason to use it too.
Type: string
Default Value: empty
URL must point to a valid XML file. If the provided URL points to a directory instead of a file, pnetwork.xml is appended automatically. Please refer Building Networks for more information in this topic.
Type: string
Default Value: empty
String which is automatically appended to network_url e.g. to add GET parameters.
This is useful e.g. if you want to provide multiple-multiple-playlist channels / networks on one site without blowing up your file- and directory namespace. Also you can add parameters to track- or authenticate your network members here. Please refer Building Networks for more information in this topic.
Type: String
Default Value: empty
PRO / PRO+ customers can apply their registration key here.
Type: numeric
Default Value: 80
Player´s initial sound volume.
Type: boolean
Default Value: true
Enables / Disables player to autostart playback right after initialization. If set to false a START button is displayed in the middle of the video area. Playback will start if the viewer clicks start or selects any item in the channel- / network browser.
Type: boolean
Default Value: false
If set to true the player will jump into the video mode right after initialization and will not allow the viewer to navigate to the channel- / network- browser view.
Type: boolean
Default Value: false
Enables / Disables any javascript callbacks. If sys_debug is enabled, this is automatically set true.
If the current page´s URL indicates that the player is embedded into a third party site, player_js is automatically set to false.
Type: numeric
Default Value: 23
Maximum amount of items to store into history or favorites. If the maximum amount is exceeded after a new item has been added to the respective list the oldest item is deleted.
Type: boolean
Default Value: false
Enables / Disables the audio feedback on mouse clicks.
Type: boolean
Default Value: false
If set to TRUE, the player will jump right into history view on startup. Since there is no “back” button in this mode, all playlist items provided by reel.xml will be ignored. All branding- and oder configuration variables however will be read.
Type: boolean
Default Value: false
If set to TRUE, the player will jump right into favorites view. Since there is no “back” button in this mode, all playlist items provided by reel.xml will be ignored. All branding- and oder configuration variables however will be read.
Type: boolean
Default Value: true
If true the player will try to automatically set the permalink of the current video into the viewer´s client browser address field (URL). This will be the same URL the viewer can fetch from the link to this video dialog within the player itself.
However, the permalink is set only if:
Type: boolean
Default Value: true
Enabled / Disables the corresponding buttons shown in the video information area.
Type: string
Default Value: <object width=“425” height=“355”><param name=“movie” value=”%my_movie%”></param><param name=“allowFullscreen” value=“true”><param name=“FlashVars” value=”%prm%”></param><embed src=”%my_movie%” type=“application/x-shockwave-flash” allowFullscreen=“true” width=“425” height=“355” flashvars=”%prm%”></embed></object>
String which is used to build the “embed this player” HTML-code viewers can copy and paste into their blogs, myspace profiles and so on.
There are optional tags available you can use in this string which are automatically replaced by appropriate data:
Type: string
Default Value: &vidid=%video_id%&curl=%config_url%
Template intended to build a flashVars parameter string for use in sys_embed_template.
There are optional tags available you can use in this string which are automatically replaced by appropriate data:
Type: string
Default Value: %url_base%?id=%id%&type=%type&
Specifies the default URL to Detailed Video Info pages.
Is overwritten by the info_url parameter of the selected item if info_url is not false or blank.
There are optional tags available you can use in this string which are automatically replaced by appropriate data:
Type: string
Default Value: id[%key%]=%id%&
A string used as template to build an URL to pull further item information on remoting calls (pServer).
There are optional tags available you can use in this string which are automatically replaced by appropriate data:
Type: string
Default Value: empty
A string which is appended to the URL resulting out of sys_query_template.
Type: boolean
Default Value: false
Alias: debug
Enables / Disables debugging functionality.
If set to true configuration variable player_js is automatically also set to true.
Type: string
Default Value: console.log('%txt%')
Alias: debug_tpl
Template to build the javascript callback command from which is used when sys_debug is true.
Will automatically prefixed with “javascript:”.
There are optional tags available you can use in this string which are automatically replaced by appropriate data:
Type: string
Default Value: none
Valid Values: none, javascript, post
Specifies the method uses for user tracking callbacks:
Type: string
Default Value: track_test(”%file%”, %stay%, %elapsed%, %remaining%, ”%id%”, ”%title%”, ”%action%”, %started%, ”%type%”, ”%info%”);
If track_type is set to post this variable should contain the full destination to push POST data to.
If track_type is set to piwik this variable should contain the full URL to a 'piwik.php' file.
Else this string is used as template to build a javascript command frequently repeated for tracking purposes.
There are optional tags available you can use in this string which are automatically replaced by appropriate data:
Type: number
Default Value: 6000
Valid Values: > 4000
Sets the tracking callback interval to defined milliseconds. Must not be smaller than 4000. Is ignored for PIWIK callbacks.
Type: number
Default Value: 0
If track_dest is set to piwik you must assign a valid piwik siteID here. To get one log in to your piwik installation, go to 'settings/sites' hit 'add new site', choose a name and save. Make sure you set the 'URLS' to the projekktor installation´s URL to be tracked.
Type: boolean
Default Value: true
If track_dest is set to piwik you can decide if the tracking data should use the full video- and channel- names or just their IDs as assign in reel.xml. If you are using the PIWIK dashboard and widgets to watch your tracking data true will do a perfect job here since it keeps your trackindata human readable. However, if you need to post-process the trackingdata with further scripts or programs, you should use false in some cases to avoid the need of further title⇒ID mappings.
If you´re unsure, just keep the default value.
Type: boolean
Default Value: true
Adds the current channel-name (or channel-ID if track_piwik_titles is false) to the tracked video. Useful for multi-reel-setups to keep track of each channel´s popularity. If you do use Projekktor just for a single playlist its recommended to switch this value to false.
Type: string
Default Value: right
Valid Values: some numeric, left, right, center
Sets the vertical align of the channel- (OR category) logo (if a logo resp. category is specified).
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current video display. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: string
Default Value: top
Valid Values: some numeric, top, bottom, middle
Sets the horizontal align of the channel- (OR category) logo (if a logo resp. category is specified).
Alignment works similar to equivalent CSS tags: top, bottom and middle will position the element relatively to current video display. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s upper border, regardless how small or big the parent element is.
Type: numeric
Default Value: 2
Defines the minimum margin to the borders of the parent element in conjunction with display_logo_align and display_logo_valign.
Type: string
Default Value: right
Valid Values: some numeric, left, right, center
Sets the vertical alignment of the playlist browser.
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: string
Default Value: top
Valid Values: some numeric, top, bottom, middle
Sets the horizontal alignment of the playlist browser.
Alignment works similar to equivalent CSS tags: top, bottom and middle will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s upper border, regardless how small or big the parent element is.
Type: numeric
Default Value: 100
Amount to scale the whole playlist element in percent.
Type: numeric
Default Value: 0
Maximum amount of item rows. If set to 0 the amount of rows is automatically set to the possible maximum.
Type: numeric
Default Value: 5
Maximum amount of item columns to show while in browser mode.
Type: boolean
Default Value: true
If set to true and a playlist tile represents a channel- or sub- playlist a link-icon is shown in the upper left corner of that tile.
By clicking this tile the user gets the permalink to corresponding channel- or sub- playlist.
Type: string
Default Value: 15
Valid Values: some numeric, left, right, center
Sets the vertical alignment of the fullscreen button while in browser mode.
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: string
Default Value: 35
Valid Values: some numeric, top, bottom, middle
Sets the horizontal alignment of the fullscreen button while in browser mode.
Alignment works similar to equivalent CSS tags: top, bottom and middle will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s upper border, regardless how small or big the parent element is.
Type: string
Default Value: 0xffffff
Type: string
Default Value: 0xffffff
Hex-Color-Code defining the item tiles background / border color.
Type: string
Default Value: 0xFF9999
Hex-Code of color to mark items with which are in the current viewer´s favorites list.
Type: string
Default Value: 0×999999
Hex-Color-Code defining the background / border color to mark tile of currently played item.
Type: string
Default Value: 0xffffff
Hex-Color-Code defining color of all text- and navigation- elements of the playlist browser (pager, header etc.pp)
Type: Boolean
Default Value: true
Enables / Disables the header decoration element competely.
Type: Boolean
Default Value: true
Enables / Disables the automatically rendered drop shadow of the header stripe.
Type: Boolean
Default Value: false
If set to true the shadow generates the illusion of a bumped in header element.
If set to false the header element itself drops a shadow which brings it visually out.
Type: Numeric
Default Value: 10
Applies a brightness filter to the header stripe which makes it highlighted e.g. even if it uses the same wallpaper image.
Setting this value to zero will disable the filter.
Type: Hex Color Code
Default Value: 0x0F4699
The “canvas” background color of the header stripe visible through transparent header-wallpapers or areas which are not covered by any image bitmap.
Type: Numeric
Default Value: 160
The hight of the header stripe in pixels.
Type: Numeric
Default Value: 30
The margin between the header´s upper edge and the upper border of the player itself.
Type: String
Default Value: wobble
A full qualified URL to an external image file which is used as wallpaper for the header stripe then.
If set to wobble the header stripe is filled with some random gradient color blobs.
Type: String
Default Value: r,y,b
Influences the colors used for the blob FX if header_wallpaper is set to wobble by providing a comma separated list of colors which can be picked by the randomizer. Available values are 'r', 'y', 'b', 'm', 'g' which are 'red', 'yellow', 'blue', 'magenta' and 'green'.
Type: string
Default Value: right
Valid Values: some numeric, left, right, center
Sets the horizontal alignment of the header wallpaper image if one is provided via header_wallpaer and if header_wallpaper_tiled is false.
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: string
Default Value: top
Valid Values: some numeric, top, bottom, middle
Sets the vertical alignment of the header wallpaper image if one is provided via header_wallpaer and if header_wallpaper_tiled is false.
Alignment works similar to equivalent CSS tags: top, bottom and middle will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s upper border, regardless how small or big the parent element is.
Type: Boolean
Default Value: both false
Enables / disables the automatic stretching of the image provided by header_wallpaper. Of this value is set to true the image is stretched vertically / horizontally to fill the whole header area. Can be combined with header_wallpaper_tiled.
Type: Boolean
Default Value: false
If false and stretching is enabled the image header wallpaper stretches as height and wide equal to the header stripe´s dimension. If this parameter is set to true and stretching is enabled also, the stretchin orientates on the overall player size. This will cause some interesting effects, especially if you do use the same wallpaper for both, the header- and the main- background.
Type: Boolean
Default Value: false
If set to true and an image is specified by header_wallpaper the specific image will be repeatedly displayed until the whole header section is filled.
Type: Boolean
Default Value: true
Enables / disables the textual video informations (duration, elapsed, title, links etc.pp.) within the header-stripe.
Attention: Is affected by preview_info. If preview_info is true the header_info parameter will be set to false automatically.
Type: string
Default Value: 290
Valid Values: some numeric, left, right, center
Sets the horizontal alignment of the textual video informations if they are not disabled by header_info.
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: string
Default Value: 50
Valid Values: some numeric, top, bottom, middle
Sets the horizontal alignment of the textual video informations if they are not disabled by header_info.
Alignment works similar to equivalent CSS tags: top, bottom and middle will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s upper border, regardless how small or big the parent element is.
Type: Hex Color Code
Default Value: 0xffffff
Defines the color to use for the textual video informations and links within the header-stripe.
The playlist- and channel- browser background is split into 4 layers. Below please find a hierarchic list (first item is the closest to the viewer):
Type: String
Default Value: default
wallpaper_main: Full URL to an external image file to load as wallpaper. If set to default or kept empty a small and striped tile bitmap will be loaded.
wallpaper_logo: ull URL to an external image file to load as playlist logo. If set to default or kept empty this layer stays empty.
Type: Hex Color Code
Default Value: false
Color to fill the full background with. If false or empty, the background will be transparent.
Type: String
Default Value: right
Default Value: some numeric, left, right, center
wallpaper_align: Sets the horizontal alignment of the wallpaper image or if one is provided via wallpaper_main and if wallpaper_tiled is false.
logo_align: Sets the horizontal alignment of the logo image or if one is provided via wallpaper_logo. Is not affected by wallpaper_tiled.
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: String
Default Value: top
Default Value: some numeric, top, bottom, middle
wallpaper_valign: Sets the vertical alignment of the wallpaper image if one is provided via wallpaper_main and if wallpaper_tiled is false.
wallpaper_logo: valign: Sets the vertical alignment of the logo image if one is provided via wallpaper_logo. Is not affected by wallpaper_tiled
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: Boolean
Default Value: true
If set to true and an image is specified by wallpaper_main the specific image will be repeatedly displayed until the whole “desktop” section is filled.
Type: Boolean
Default Value: both false
Enables / disables the automatic stretching of the image provided by wallpaper_main. Of this value is set to true the image is stretched vertically / horizontally to fill the whole available area. Can be combined with wallpaper_tiled.
Type: Boolean
Default Value: both true
Applies a radial gradient semi transparent bitmap mask to the underlying wallpaper layers. This is just some eyecandy FX which makes the overall look a bit … cooler.
Type: String
Default Value: 60
Default Value: some numeric, left, right, center
Sets the horizontal alignment of the preview video area.
Alignment works similar to equivalent CSS tags: left, right and center will position the element relatively to current player background. A numeric value will set the element to a specified amount of pixels shifted from the parent element´s left border, regardless how small or big the parent element is.
Type: String
Default Value: 30
Default Value: some numeric, top, bottom, middle
Sets the vertical alignment of the preview video area.
Type: Numeric
Default Value: 60
Sets the height of the preview video area. This value is absolute. The preview area does not scale if the player is resized.
Type: Numeric
Default Value: 210
Sets the width of the preview video area. This value is absolute. The preview area does not scale if the player is resized.
Type: Hex Color Code
Default Value: 0xffffff
Linecolor of outline rectangle if mousepointer is right above preview video area.
The configuration parameters described below apply to all “Share This” popups, the HTML info windows and to the video information overlay of the video screens.
Type: Hex Color Code
Default Value: 0xf1f1f1
Sets the main background color.
Type: Hex Color Code
Default Value: 0×999999
Sets the header color.
Type: Hex Color Code
Default Value: 0xfdfdfd
Sets the font color in headers.
Type: Hex Color Code
Default Value: 0xfdfdfd
Sets the outline color of all window elements.
Type: Hex Color Code
Default Value: 0×010101
Sets the font color of all window elements. In HTML enabled windows this value might be overwritten by external style sheets.
Type: Boolean
Default Value: true
Enables / disables a funky gradient effect to the window headers which makes them visually a bit more stand out.