[Summary view] [Print] [Text view]

   1  /*
   2   * FlowPlayer external configuration file.
   3   *
   4   * NOTE! This file is only needed if you don't want to include all configuration
   5   * in the embedding HTML file. Please see the installation instructions at
   6   * http://flowpalyer.org
   7   *
   8   * Copyright 2005-2008 Anssi Piirainen
   9   *
  10   * All settings defined in this file can be alternatively defined in the 
  11   * embedding HTML object tag (as flashvars variables). Values defined in the
  12   * object tag override values defined in this file. You could use this 
  13   * config file to provide defaults for multiple player instances that 
  14   * are used in a Web site. Individual instances can be then customized 
  15   * with their embedding HTML.
  16   *
  17   * Note that you should probably remove all the comments from this file
  18   * before using it. That way the file will be smaller and will load faster.
  19   */
  20  {
  21      /*
  22       * Instructs the player to load the configuration from an external config file.
  23       * This can be a abosulte URL or a relative url (relative to the HTML page
  24       * where the player is embedded).
  25       */
  26  //    configFileName: 'flowPlayer.js',
  27  
  28      /*
  29       * Instructs the player to load the configuration from a RTMP server.
  30       * The player connects to the server listening in the address specified
  31       * by this URL and calls a method 'getStreamPlayerConfig' that should return a
  32       * valid FP configuration object.
  33       */
  34  //    rtmpConfigUrl: 'rtmp://localhost/myapp',
  35  
  36      /*
  37       * A param value to be passed to getStreamPlayerConfig(). A value 'foobar'
  38       * will make the player to call getStreamPlayerConfig('foobsr')
  39       */
  40  //    rtmpConfigParam: 'anssi',
  41      
  42      /*
  43       * Name of the video file. Used if only one video is shown.
  44       *
  45       * Note for testing locally: Specify an empty baseURL '', if you want to load
  46       * the video from your local disk from the directory that contains
  47       * FlowPlayer.swf. In this case the videoFile parameter value should start
  48       * with a slash, for example '/video.flv'.
  49       *
  50       * See also: 'baseURL' that affects this variable
  51       */
  52  //     videoFile: 'honda_accord.flv',
  53  
  54      /*
  55       * Clip to be used if the file specified with 'videoFile' or any of the clips in the playlist
  56       * was not found.  The missing video clips are replaced by this clip. This can be
  57       * an image or a FLV clip. Typically this will contain an image/video saying
  58       * "the video you requested cannot be found.....".
  59       *
  60       * The syntax for the value is the same is with the clips in a playlist
  61       * including the possibility to have start/end and duration properties.
  62       *
  63       * See also: 'baseURL' that affects this variable
  64       */
  65       noVideoClip: { url: 'main_clickToPlay.jpg', duration: 10 },
  66       //noVideoClip: { url: 'MiltonFriedmanonLimi.flv' },
  67  
  68      /*
  69       * Playlist is used to publish several videos using one player instance.
  70       * You can also have images in the playlist. The playback pauses in the
  71       * image unless a 'duration' property is given for the image:
  72  
  73   *      * The clips in the playlist may have following properties:
  74       *
  75       * name: Name for the clip to be shown in the playlist view. If this is
  76       *       not given, the clip will be hidden from the view.
  77       *
  78       * url: The URL used to load the clip.
  79       * 
  80       * type: One of 'video', 'flv', 'swf', 'jpg'. Optional, determined from the URL's filename extension
  81       *       if that is present. 'video' means a video file in any format supported by Flash.
  82       *       'flv' is present here for backward compatibility, use 'video' in new FlowPlayer installations
  83       *       now. Defaults to 'video' if the extension is not present in the URL.
  84       *
  85       * start: The start time (seconds) from where to start the playback. A nonzero
  86       *        value can only be used when using a streaming server!!
  87       * end: The end time (seconds) where to stop the playback.
  88       *
  89       * duration: The duration the image is to be shown. If not given the playback
  90       *           pauses when the image is reached in the list.
  91       * 
  92       * protected: (true/false) Apply inlinine linking protection for this clip?
  93       *            Optional, defaults to false.
  94       * 
  95       * linkUrl: Associates a hyperlink pointing to the specified URL. The linked
  96       *          document will be opened to the browser when the clip area is clicked.
  97       *             Specifying this parameter will replace the normal pause/resume behavior
  98       *             that is associated to clicking the display area. If you specify an empty
  99       *             linkUrl '' the pause/resume behavior is disabled but no hyperlink
 100       *             is created.
 101       * linkWindow: Specifies the name of the browser window or frame into which to load
 102       *   the linked document. Can be a custom name or one of presets: '_blank', 
 103       *   '_parent', '_self', '_top'. (optional, defaults to '_blank')
 104       * 
 105       * controlEnabled: (true/false) Enable transport control buttons for this clip?
 106       *                 Optional, defaults to true.
 107       *
 108       * allowResize: (true/false) Allow resizing this clip according to the menu selection.
 109       *              Optional, defaults to true.
 110       *              
 111       * overlay: A filename pointing to an image that will be placed on top of this image clip. This
 112       *          is only applicable to image clips (jpg or png files). Essentially this layers two images
 113       *          on top of each other. Typically the image on top is a big play button that is used on
 114       *          top of an image taken from the main movie.
 115       * 
 116       * overlayId: ID that specifies a built-in overlay to be used. Currently the player supports
 117       *               one built-in overlay with ID 'play'. It renders a large play button with mouse hover color change.
 118       *               You can use this on top of image clips (one clip with both the 'url' property and
 119       *               'overlayId' property). 
 120       *               You can also specify a clip that only has this ID. In that
 121       *               case you should place it immediately before or after a FLV clip. This overlay-only
 122       *               clip is then rendered on top of the first or the last frame of the FLV video.
 123       * 
 124       * live: (true/false) Is this a live stream (played from a media server)?
 125       * 
 126       * showOnLoadBegin: (true/false) If true, make this clip visible when the fist bits have been loaded.
 127       * If false, do not show this clip (show the background instead) before the buffer is filled
 128       * and the playback starts. Optional, defaults to true.
 129       * 
 130       * maxPlayCount: The maximum play count for this clip. The clip is removed from the playlist when
 131       * the playcount reaches this amount.
 132       * 
 133       * suggestedClipsInfoUrl:  URL used to fetch suggestions (related videos) information from the server
 134       * 
 135       * See also: 'baseURL' is prefixed with each URL
 136       */
 137      playList: [
 138      { url: 'main_clickToPlay.jpg' },
 139      { name: 'Honda Accord', url: '!honda_accord.flv' },
 140      { name: 'River', url: 'river.flv' },
 141      { name: 'Ounasvaara', url: 'ounasvaara.flv' }
 142      ],
 143      
 144      /*
 145       * Specifies wether the playlist control buttons should be shown in the player SWF component or not.
 146       * Optional, defaults to the value of showPlayList. 
 147       */
 148      showPlayListButtons: true,
 149  
 150      /*
 151       * Streaming server connection URL. 
 152       * You don't need this with lighttpd, just use the streamingServer setting (see below) with it.
 153       */
 154  //     streamingServerURL: 'rtmp://localahost:oflaDemo',
 155      
 156      /* 
 157       * baseURL specifies the URL that is appended in front of different file names
 158       * given in this file.
 159       * 
 160       * You don't need to specify this at all if you place the video next to
 161       * the player SWF file on the Web server (to be available under the same URL path).
 162       */
 163  //     baseURL: 'http://flowplayer.sourceforge.net/video',
 164      
 165      
 166      /*
 167       * What kind of streaming server? Available options: 'fms', 'red5', 'lighttpd'
 168       */
 169  //    streamingServer: 'fms',
 170      
 171      /*
 172       * Specifies whether thumbnail information is contained in the FLV's cue point 
 173       * metadata. Cue points can be injected into the FLV file using 
 174       * for example Flvtool2. See the FlowPlayer web site for more info.
 175       * (optional, defaults to false)
 176       * 
 177       * See also: cuePoints below for an alternative way of specifying thumb metadata
 178       */
 179  //    thumbsOnFLV: true,
 180      
 181      /*
 182       * Thumbnails specific to cue points. Use this if you don't want to
 183       * embed thumbnail metadata into the FLV's cue points. 
 184       * If you have thumbNails defined here you should have thumbsOnFLV: false !
 185       * thumb times are given in seconds
 186       */
 187  //     thumbs: [
 188  //     { thumbNail:  'Thumb1.jpg', time: 10 },
 189  //     { thumbNail:  'Thumb2.jpg', time: 24 },
 190  //     { thumbNail:  'Thumb3.jpg', time: 54 },
 191  //     { thumbNail:  'Thumb4.jpg', time: 74 },
 192  //     { thumbNail:  'Thumb5.jpg', time: 94 },
 193  //     { thumbNail:  'Thumb6.jpg', time: 110 }
 194  //     ],
 195      // Location of the thumbnail files
 196  //     thumbLocation: 'http://www.kolumbus.fi/apiirain/video',
 197      
 198      /* 
 199       * 'autoPlay' variable defines whether playback begins immediately or not.
 200       * 
 201       * Note that currently with red5 you should not have false in autoPlay 
 202       * when you specify a nonzero starting position for the video clip. This is because red5
 203       * does not send FLV metadata when the playback starts from a nonzero value.
 204       * 
 205       * (optional, defaults to true)
 206       */
 207      autoPlay: true,
 208  
 209      /*
 210       * 'autoBuffering' specifies wheter to start loading the video stream into
 211       *  buffer memory  immediately. Only meaningful if 'autoPlay' is set to
 212       * false. (optional, defaults to true)
 213       */
 214      autoBuffering: true,
 215  
 216      /*
 217       * 'startingBufferLength' specifies the video buffer length to be used to kick
 218       * off the playback. This is used in the beginning of the playback and every time
 219       * after the player has ran out of buffer memory. 
 220       * More info at: http://www.progettosinergia.com/flashvideo/flashvideoblog.htm#031205
 221       * (optional, defaults to the value of 'bufferLength' setting)
 222       * 
 223       * see also: bufferLength
 224       */
 225  //    startingBufferLength: 5,
 226  
 227      /*
 228       * 'bufferLength' specifies the video buffer length in seconds. This is used
 229       * after the playback has started with the initial buffer length. You should
 230       * use an arbitrary large value here to ensure stable playback.
 231       * (optional, defaults to 10 seconds)
 232       * 
 233       * see also: startingBufferLength
 234       */
 235      bufferLength: 20,
 236  
 237      /*
 238       * 'loop' defines whether the playback should loop to the first clip after
 239       * all clips in the playlist have been shown. It is used as the
 240       * default state of the toggle button that controls looping. (optional,
 241       * defaults to true)
 242       */
 243      loop: true,
 244  
 245      /*
 246       * Rewind back to the fist clip in the playlist when end of the list has been reached?
 247       * This option only has effect if loop is false (please see loop variable above).
 248       * (optional, defaults to false)
 249       */
 250      autoRewind: true,
 251      
 252      /*
 253       * Specifies wether the loop toggle button should be shown in the player SWF component or not.
 254       * Optional, defaults to false. 
 255       */
 256  //    showLoopButton: true,
 257      
 258      /*
 259       * Specifies the height to be allocated for the video display. This is the
 260       * maximum height available for the different resizing options.
 261       */
 262      videoHeight: 320,
 263      
 264      /*
 265       * Specifies the width for the control buttons area. Optiona, defaults to the
 266       * width setting used in the embedding code. 
 267       */
 268  //    controlsWidth: 480,
 269      
 270      /*
 271       * Specifies how the video is scaled initially. This can be then changed by
 272       * the user through the menu. (optional, defaults to 'fit')
 273       * Possible values:
 274       * 'fit'   Fit to window by preserving the aspect ratios encoded in the FLV metadata.
 275       *         This is the default behavior.
 276       * 'half'  Half size (preserves aspect ratios)
 277       * 'orig'  Use the dimensions encoded in FLV. If the video is too big for the 
 278       *         available space the video is scaled as if using the 'fit' option.
 279       * 'scale' Scale the video to fill all available space for the video. Ignores
 280       *         the dimensions in metadata.
 281       * 
 282       */
 283      initialScale: 'fit',
 284      
 285      /*
 286       * Specifies if the menu containing the size options should be shown or not.
 287       * (optional, defaults to true)
 288  //    showMenu: false,
 289      
 290      /*
 291       * 'hideControls' if set to true, hides all buttons and the progress bar
 292       * leaving only the video showing (optional, defaults to false)
 293       */
 294      hideControls: false,
 295  
 296      /*
 297       * URL that specifies a base URL that points to a folder containing
 298       * images used to skin the player. You must specify this if you intend
 299       * to load external button images (see 'loadButtonImages' below).
 300       */
 301      skinImagesBaseURL: 'http://flowplayer.sourceforge.net/resources'
 302  
 303      /*
 304       * Will button images be loaded from external files, or will images embedded
 305       * in the player SWF component be used? Set this to false if you want to "skin"
 306       * the buttons. Optional, defaults to true.
 307       * 
 308       * NOTE: If you set this to false, you need to have the skin images available
 309       * on the server! Otherwise the player will not show up at all or will show
 310       * up corrupted.
 311       *
 312       * See also: 'skinImagesBaseURL' that affects this variable
 313       */
 314  //    useEmbeddedButtonImages: false,
 315      
 316      /*
 317       * 'splashImageFile' specifies an image file to be used as a splash image.
 318       * This is useful if 'autoPlay' is set to false and you want to show a
 319       * welcome image before the video is played. Should be in JPG format. The
 320       * value of 'baseURL' is used similarily as with the video file name and
 321       * therefore the video and the image files should be placed in the Web
 322       * server next to each other.
 323       * 
 324       * NOTE: If you set a value for this, you need to have the splash image available
 325       * on the server! Otherwise the player will not show up at all or will show
 326       * up corrupted.
 327       *
 328       * NOTE2: You can also specify the splash in a playlist. This is just
 329       * an alternative way of doing it. It was preserved for backward compatibility.
 330       *
 331       * See also: 'baseURL' that affects this variable
 332       */
 333  //    splashImageFile: 'main_clickToPlay.jpg',
 334      
 335      /*
 336       * Should the splash image be scaled to fit the entire video area? If false,
 337       * the image will be centered. Optional, defaults to false.
 338       */
 339  //    scaleSplash: false,
 340  
 341      /*
 342       * 'progressBarColor1' defines the color of the progress bar at the bottom
 343       * and top edges. Specified in hexadecimal triplet form indicating the RGB
 344       * color component values. (optional)
 345       */
 346  //    progressBarColor1: 0xFFFFFF,
 347  
 348  
 349      /*
 350       * 'progressBarColor2' defines the color in the middle of the progress bar.
 351       * The value of this and 'progressBarColor1' variables define the gradient
 352       * color fill of the progress bar. (optional)
 353       */
 354  //    progressBarColor2: 0xDDFFDD,
 355  
 356      /*
 357       * 'bufferBarColor1' defines the color of the buffer size indicator bar at the bottom
 358       * and top edges. (optional)
 359       */
 360  //    bufferBarColor1: 0xFFFFFF,
 361  
 362  
 363      /*
 364       * 'bufferBarColor2' defines the color of the buffer size indicator bar in the middle
 365       * of the bar. (optional)
 366       */
 367  //    bufferBarColor2: 0xDDFFDD,
 368  
 369      /*
 370       * 'progressBarBorderColor1' defines the color of the progress bar's border at the bottom
 371       * and top edges. (optional)
 372       */
 373  //    progressBarBorderColor1: 0xDDDDDD,
 374  
 375  
 376      /*
 377       * 'progressBarBorderColor2' defines the color of the progress bar's border in the middle
 378       * of the bar. (optional)
 379       */
 380  //    progressBarBorderColor2: 0xEEEEEE,
 381  
 382      /*
 383       * 'bufferingAnimationColor' defines the color of the moving bars used in the buffering 
 384       * animation. (optional)
 385       */
 386  //    bufferingAnimationColor: 0x0000FF,
 387  
 388      /*
 389       * 'controlsAreaBorderColor' defines the color of the border behind buttons and progress bar 
 390       * (optional)
 391       */
 392  //    controlsAreaBorderColor: 0x1234,
 393  
 394      /*
 395       * 'timeDisplayFontColor' defines the color of the progress/duration time display 
 396       * (optional)
 397       */
 398  //    timeDisplayFontColor: 0xAABBCC,
 399  
 400      /*
 401       * Height of the progress bar. (optional)
 402       */
 403  //    progressBarHeight: 10,
 404  
 405      /*
 406       * Height of the progress bar area. (optional)
 407       */
 408  //    progressBarAreaHeight: 10,
 409  
 410      /*
 411       * Name of the authentication code file name that is used to prevent inline linking
 412       * of video and image files. This can be a complete URL or just a file name relative
 413       * to the location from where the player is loaded. (optional, defaults to flowplayer_auth.txt)
 414       */
 415  //    authFileName: 'http://www.mytube.org/authCode.txt',
 416  
 417      /*
 418       * The URL pointing to a sctipt that opens the player full screen. 
 419       * If this is not configured explicitly, the default script, 
 420       * http://flowplayer.sourceforge.net/fullscreen.js, is used.
 421       */
 422  //    fullScreenScriptURL: 'http://mysite.org/fullscreen.js'
 423  
 424      /**
 425       * Specifies which menu items will be show. This is an array that contains a boolean
 426       * value for each of the items. By default shows them all except "full screen".
 427       */
 428  //    menuItems[
 429  //        true, // show 'Fit to window'
 430  //        true, // show 'Half size'
 431  //        true, // show 'Original size'
 432  //        true, // show 'Fill window'
 433  //        true, // show 'Full screen'
 434  //        false // hide 'Embed...'
 435  //    ],
 436  
 437  
 438      /*
 439       * Specifies wether the full screen button should be shown in the player SWF component or not.
 440       * Optional, defaults to true. 
 441       */
 442  //    showFullScreenButton: false,
 443  
 444      /*
 445       * Use the Flash 9 native full screen mode.
 446       */
 447  //    useNativeFullScreen: true,
 448  }
 449