BITGRAVITY PLAYER 5

Parameter Name: File
Type: String (text)
Example: "http://www.mydomain.com/videos/video1.flv"
Default: (blank)
Description: The URL of the FLV video you want to play.

Parameter Name: AutoPlay
Type: Boolean (true/false)
Example: true
Default: false
Description: If set to false, the video will not begin until the user clicks PLAY.

Parameter Name: Thumbnail
Type: String (text)
Example: "http://www.mydomain.com/images/video1.jpg"
Default: (blank)
Description: The URL of the image displayed until the video starts playing.

Parameter Name: PreRoll
Type: String (text)
Example: "http://www.mydomain.com/ads/ad1.flv"
Default: (blank)
Description: The URL of the video file played before the main video. Playback controls are disabled. You cannot have both a thumbnail and a preroll.

Parameter Name: LogoPNG
Type: String (text)
Example: "http://www.mydomain.com/images/logo2.jpg"
Default: (blank)
Description: The URL of the image displayed in the top left of the player.

Parameter Name: BitGravityLogo
Type: Boolean (true/false)
Example: false
Default: true
Description: The BitGravity Logo will show by default unless this option is set to false, or LogoPNG is set to an alternate logo.

Parameter Name: AllowDebug
Type: Boolean (true/false)
Example: false
Default: true
Description: When focus is on the player, pressing the 'b' key will bring up a bandwidth profile, and 'd' will bring up a debug overlay. To disable this functionality, set AllowDebug to false.

Parameter Name: ForceReconnect (only affects live mode)
Type: Number
Example: 3600
Default: 1800
Description: Some internet browsers have difficulty storing a very long contiguous FLV file in memory, so setting this parameter to x will force a reconnect to the stream every x seconds. This can be set to 0 to disable the function.

Parameter Name: ScrubMode
Type: String (text)
Options: "normal" / "advanced" / "hybrid"
Default: "normal"
Description: Advanced mode makes use of BitGravity's Advanced Progressive (TM) technology to allow instant scrubbing to any point in an FLV video by making advanced requests to the server.

Parameter Name: Mode
Type: String (text)
Options: ("ondemand" / "live")
Default: "ondemand"
Description: Use "ondemand" for static FLV video files, and "live" for BitGravity's BGLiveBroadcast (TM) streams.

Parameter Name: FileQuality2 (FileQuality3, FileQuality4, ...)
Type: String (text)
Example: "http://bglive-a.bitgravity.com/mystream/500kbps"
Default: (blank)
Description: The URL location of streams encoded at additional bitrates. "File" should be the highest quality, then "FileQuality2", then "FileQuality3", etc. Each quality level requires a "FileLabel".

Parameter Name: FileLabel (FileQuality2Label, FileQuality3Label, ...)
Type: String
Example: "2000 kbps"
Default: (blank)
Description: When connecting to multiple streams, a label should be set for each to appear in the player's Bitrate Menu. FileLabel is the label for File, FileQuality2Label is the label for FileQuality2.

Parameter Name: FileBitrate (FileQuality2Bitrate, FileQuality3Bitrate, ...)
Type: String
Example: "2000" or "http://bglive-a.bitgravity.com/mystream/500kbps.xml"
Default: (blank)
Description: When connecting to multiple streams, a bitrate should be set for each. FileBitrate is the bitrate for File, FileQuality2Bitrate is the bitrate for FileQuality2. When using LiveBroadcast, an XML URL should be set instead of a number. The xml should follow this format;
<?xml version="1.0" encoding="ISO-8859-1"?>
<stream>
<url>http://bitcast-a.bitgravity.com/bitgravity/dtv1/2000kbps</url>
<label>1000 Kbps</label>
<bitrate>1024000</bitrate>
</stream>

Parameter Name: DefaultRatio
Type: Number
Example: 4/3
Default: 16/9
Description: The video dimensions will be set to use this ratio ONLY if the video meta data does not have built-in dimensions OR ForceRatio is set to true.

Parameter Name: ForceRatio
Type: Boolean (true/false)
Example: true
Default: false
Description: Set to true if you want the value set in DefaultRatio to be preferred to built-in video meta data dimensions.

Parameter Name: VideoFit
Type: String (text)
Example: ("automatic" / "stretch" / "fill")
Default: "automatic"
Description: If the video dimensions differ from that of the player, the video will be stretched according to this mode. "automatic" will proportionally stretch the video as large as is possible without hiding any part of the video. "stretch" will stretch the video to fill the player. "fill" will proportionally stretch the video to just large enough to fill the player. i.e. video may be cropped.

Parameter Name: AutoBitrate
Type: String (text)
Example: ("on" / "off" / "disabled")
Default: "disabled"
Description: Player will drop or jump to streams based on periodic connection measurements. Unless set to "disabled" this is toggleable by the user during runtime, and defaults to the value of this parameter.

Parameter Name: MaxFallBack
Type: String (text)
Example: 5%
Default: 5
Description: If the video falls further than this far behind LIVE, the player will drop to a lower quality stream (if available).

Parameter Name: BufferTime
Type: Number
Example: 3
Default: 1.5
Description: Video will load at least this much video before playing. Increase this number for longer wait in favor of less start-and-stop in the video.