Skip to navigation.
Documentation 13.11.2008

JSON parameters

All parameters are optional, except the ones marked with 'required'.

Here is a sample JSON stream (with some white-space conversion to help human read), live from Webcsatorna.hu.

Every parameter is optional except where it marked as required.

top level parameters
parameterdescription
autoplay Set it to true for autoplay.
Default: false (autoplay off).
volume Numbers from 0 to 100 to set up the starting volume (0 - silence, 100 -  full).
Default: "cache" (The player stores the last volume on the user's computer. If no stored volume is found, it starts with 80).
background An array with keys 'red', 'green' and 'blue' for colour tint of the skin's background. Each value is a colour offset number from -255 to 255.
Default: red: 0, green: 0, blue: 0 (no change in the skin's background).

Example 1: untinted default skin
untinted.png

Example 2: tinted default skin (red: 0, green: -128, blue: 128)
tinted.png
controls URL to the skin SWF file. Default: the player uses the default skin (it loads from http://player.imect.com/wuplayer/default_skin.swf).
css URL to the information pane's CSS file. Default: no CSS formatting used.
embedcode The embed code shown on the embed pane. Default: the embed pane and embed button is disabled.
mailgateway The mail pane form's target URL. Default: the mail pane and mail button is disabled. Please read about the mail functionality here.
disable An array with button identifiers in the skin file to disable, like 'btn_info' or 'btn_embed'.
preview An array with the following optional fields, to be shown when autoplay is OFF.
  • title - a text shown in a centered single line textfield (default: empty)
  • image - URL to a preview image (default: empty). The preview image will be centered and stretched automatically.
  • playbutton - URL to a play button shown in the middle, over the preview image (transparent PNGs are working very well with this) (default: empty)

Example 3: Webcsatorna is using a very nice play button over the preview image, and no title.
preview.jpg

Example 4: Stubes is using a very opaque play button with title and preview image.
preview2.jpg
items (required) An array containing the video stream's items. Must contain 1 or more elements from the following table.
nextpagemode If true, clicking on a slidebar item will not load the item's video but throw the browser to the item's landing page.

Here is a sample JSON stream (with some white-space conversion to help human read), live from Webcsatorna.hu.

Remember, every parameter is optional, there is only a few required.

per video parameters
parameterdescription
type The type of the item. Set it to 'ustream' to show a live Ustream.tv channel. Default: empty, the item is a normal video.
video (required) URL of the video file or the Ustream channel id.
flv_alternative If the video is mp4 (h264) and the user's Flash is too old for playing mp4 files, this is the URL for an FLV alternative.
secondtry An alternative URL for the video file, if the 'video' or 'flv_alternative' can't load.
startparam To make pseudo-streaming work you must tell the name of the 'start' GET parameter which your server accepts. For YouTube or Lighttpd this value should be: 'start='. Default: empty, no pseudo-streaming.
videolink This URL will be opened in a new browser window if you click on the currently playing video. Works with ustream as well.
url The page where the video is hosted = landing page.
title The video's title, shown in the slidebar.
thumbnail A thumbnail image (URL) about the video, shown in the slidebar. Supported formats: PNG, GIF or JPG.
controls Control set. A string with the following possible values: 'disable' for disable every control except volume and full-screen, 'noseek' to disable the seekbar only. Default: 'full' (every control is enabled).
information The information shown in the info pane, in UTF-8 encoded HTML format: can contain links, headers, images, etc. what Flash understands (not every html element!). Default: empty (info pane and info button is disabled).
lowcpu If true, it turns off video smoothing to save some CPU.
staturl The player will ping this URL in every 30 seconds to measure the video's view in depth. It will append the GET variable 'sec' with the value of the current playhead position (in seconds).
ga_id Your Google Analytics website profile identifier. Please read about Google Analytics support for measuring video views here.
ga_domain (required if ga_id is set) The domain associated with the given 'ga_id'.
ga_path The path to be shown as the content. Default: '/'.
ga_attachurl A boolean value, set it to true if you'd like to attach the embedding html document's path to 'ga_path'. Default: false.
pre_ad If it's a video file: a URL to a video shown before the 'real' video, basically for pre-video advertisement. During this video's play every control except volume and full-screen is disabled and the seekbar shows how much is left from the video.
If it's an SWF file: a URL to a Flash object shown before the 'real' video. During this time every control except volume and full-screen is disabled and the seekbar shows 'buffering'. Put an empty frame onto the end of this Flash object and gotoAndStop to this frame when you want to unload it.
pre_ad_staturl The player pings this URL when the pre-ad video starts to play, to measure the views of the pre-ad.
pre_ad_link This URL will be opened in a new browser window if you click on the pre-ad video.
pre_ad_clickstaturl The player pings this URL when the user clicked on the pre-ad. You can measure click-ons this way.
post_ad, post_ad_staturl, post_ad_link, post_ad_clickstaturl These are the same as the pre-ad, but it's shown after the 'real' video.
overlay_ad A URL to an SWF file containing an overlay advertisement. The player can use many types of overlay ad containers. Drop an e-mail if you're interested.
overlay_ad_sec In which second to show the overlay ad after the video starts playing. Default: 10. Must be > 0.
overlay_ad_staturl The player pings this URL when the overlay ad appears, to measure the views of the overlay ad.
overlay_ad_link This URL will be opened in a new browser window if you click on the overlay ad,
overlay_ad_clickstaturl The player pings this URL when the user clicked on the overlay ad. You can measure click-ons this way.

Here is a sample JSON stream (with some white-space conversion to help human read), live from Webcsatorna.hu.

iMect means internet, media and other cool things. iMect is a small company in Budapest, Hungary. We’ve a big footer on every page where you can discover what we do and what happens with us.

Az iMect jelentése: internet, média és egyéb király dolgok. Egy kis budapesti cég vagyunk. Minden oldalon van egy nagy lábléc, ahol felfedezheted, hogy mivel foglalkozunk.