cfdocs.org /

Description

Creates an in-built media player that lets you play FLV, MPEG-3, and MPEG-4 files.

FLV files can be played from any web server. You can play MPEG-3/MPEG-4 only from Flash Media Server using RTMP.

Category

Display management tags

Syntax

<cfmediaplayer 
    align="alignment option" 
    autoplay="true|false" 
    bgcolor="hexadecimal value" 
    hideborder="true|false" 
    hidetitle="true|false" 
    controlbar="true|false" 
    fullScreenControl="yes|no" 
    name="name" 
    onComplete="JavaScript function name" 
    onLoad="JavaScript function name" 
    onStart="JavaScript function name" 
    quality="low|high|medium" 
    source="source name" 
    style=="style specification" 
    height="integer" 
    width="integer" 
    wmode="window|opaque|transparent"> 
</cfmediaplayer>

History

ColdFusion 9: Added this tag.

Attributes

Attribute

Req/Opt

Default

Description

align

Optional

left

Specifies the horizontal alignment of the media player. You can select from left, right, and center.

autoplay

Optional

false
A Boolean value that specifies if the media player must automatically play the FLV file on loading the CFM page:

  • true

  • false

bgcolor

Optional

6b7c85

The background color of the media player specified as a Hexadecimal value without a "#"

controlbar

Optional

true

A Boolean value that specifies if you want to display the control panel for the media player:

  • true

  • false

hideborder

Optional

true

A Boolean value that specifies if you want a border for the media player panel:

  • true

  • false

hidetitle

Optional

false

If true, displays the video file name.

fullScreenControl

Optional

yes
Whether full screen is enabled:

  • yes

  • no

The following characteristics apply:

  • Single click plays/pauses the media player.

  • Borders, if defined, are not displayed in full-screen mode.

  • Double-click for full-screen mode.

  • (If you are in full-screen mode) Press "Esc" or double-click to restore the player to normal mode.

height

Optional

360 pixels

Height of the media player, in pixels.

name

Required if source is not defined

  

Name of the media player.

The name attribute is required when you invoke JavaScript functions.

onComplete

Optional

  

Custom JavaScript function to run when the FLV file has finished playing.

onLoad

Optional

  

Custom JavaScript function to run on loading of the player component.

onStart

Optional

  

Custom JavaScript function to run when the FLV file starts playing.

quality

Optional

high
The quality of the media playback:

  • low

  • medium

  • high

source

Required if name is not defined

  

The URL to the FLV file. This can be a URL relative to the current page.

You can store the FLV file on the ColdFusion server or any other streaming server.

style

Optional

  

The following are the supported styles:

  • bgcolor: The background color of the media player.

  • borderbottom: A numeric value. The default is 10.

  • bordertop: A numeric value. The default is 10.

  • borderleft: A numeric value. The default is 10.

  • borderright: A numeric value. The default is 10.

  • titletextcolor: Hexadecimal value of RGB color. For example, specify the color white as ##FFFFFF or FFFFFF. The default is black.

  • titlebgcolor: Hexadecimal value of RGB color. The default is black.

  • progresscolor: The foreground color for the progress bar. Hexadecimal value of RGB color. The default is black.

  • progressbgcolor: The background color for the progress bar. Hexadecimal value of RGB color. The default is black.

  • controlscolor: The foreground color of the controls in the Control panel. Hexadecimal value of RGB color. The default is black.

  • controlbarbgcolor: The background color of the controls. Hexadecimal value of RGB color. The default is black.

width

Optional

480 pixels

Width of the media player, in pixels.

wmode

Optional

window
Specifies the absolute positioning and layering capabilities in your browser:

  • window: Plays the media player in its own rectangular window on a web page

  • opaque: Hides everything behind the media player on the web page

  • transparent: Lets the background of the web page show through the transparent portions of the media player

Example

In this example, the FLV file is stored in the web root used by the ColdFusion server. You need to store an FLV file - mediafile.flv in the location web_root\xyz\. You can now create the media player with the following content:

<h3>cfmediaplayer Example</h3> 
<cfmediaplayer 
    name="Myvideo" 
    source="/xyz/mediafile.flv" 
    width=500 
    height=400 
    align="middle" 
    quality="high" 
    fullscreencontrol="true"/>

The following code illustrates styling of the media player:

<cfset bgColorTheme = "EDC393"> 
<cfset titleColorTheme = "800517"> 
<cfset controlsColorTheme = titleColorTheme> 
<cfset progressColorTheme = "E67451"> 
<cfset progressbgColorTheme = "FFF8C6"> 
<cfmediaplayer name="player2" style="bgcolor:#bgColorTheme#; 
titletextcolor:#titleColorTheme#;titlebgcolor:#bgColorTheme#;controlbarbgcolor:#bgColorTheme#;controlscolor:#controlsColorTheme#;progressbgcolor:#progressbgColorTheme#;progresscolor:#progressColorTheme#;borderleft:20;borderright:20;bordertop:10;borderbottom:13" hideborder="false" hideTitle=false controlbar="true" source="#defaultFlvfile#">