Video Player - Documentation topics on: deprecated,macros,video player,.

Video Player
Deprecated

** This macro has been deprecated **

You can provide this macro a URL to a .flv file and it will provide a player for your video.

Macro Overview:

Syntax:

#videoPlayer(url)

Arguments:

  • url
    This is the path to the flv.

Optional Parameters:

  • videoPlayerPath
    This is the base location of the player (optional). You could use this variable to set another base location to the video player's components, the javascript and the flash files. Default: '/html/'.
  • width
    This is the new video width (optional). You could use the video width parameter alone or in combination with the height parameter. Default: 275.
  • height
    This is the new video height (optional). You could use the video height parameter alone or in combination with the width parameter. Default: 265.
  • autostart
    If the video plays automatically when it loads. Default: true.
  • backgroundColor
    The backgrounds color of the player. Default: #ffffff.
  • scale
    default (Show all) makes the entire movie visible in the specified area without distortion, while maintaining the original aspect ratio of the movie. Borders may appear on two sides of the movie.
    noorder scales the movie to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the movie.
    exactfit makes the entire movie visible in the specified area without trying to preserve the original aspect ratio. Distortion may occur.
    Default: 'default'.
  • autostart
    true if you want to play the movie automatically when the video player is loaded.
    false the movie won't be played automatically.
    Default: 'true'.
  • overstretch
    true will support overstretch.
    false won't support overstretch.
    Default: 'false'.
  • image
    The image to show in the player. Default: default.jpg.

Usage:

The macro will play the video within an embedded flash player
Examples:

Example 1: A simple example using the required fields

#videoPlayer("/global/videos/myvideo.flv")

Example 2: An example showing how to include one or more of the optional parameters

#set( $width = "500")
#set($height = "500")
#set($autostart = "true")
#set($backgroundColor = "#000000")
#set($scale = "default")
#videoPlayer("/global/videos/myvideo.flv")