User Guide Cancel

cfmediaplayer

Last updated on May 30, 2024 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

THIS TAG HAS BEEN DEPRECATED

For a full list of deprecated features, refer to Deprecated features.

Description

Creates an in-built media player that lets you play videos in any format supported by HTML 5 compliant browsers in addition to 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. You can also play audio files of MP3 format.

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" 
onError="JavaScript function name" 
onPause="JavaScript function name" 
onLoad="JavaScript function name" 
onStart="JavaScript function name" 
posterImage="URL" 
quality="low|high|medium" 
repeat="true|false" 
skin="XML_Path" 
source="source name" 
style="style specification" 
title="title" 
type="html|flash"> 
height="integer" 
width="integer" 
wmode="window|opaque|transparent"> 
</cfmediaplayer>

History

ColdFusion 10: type, repeat, posterImage, title, skin, onPause, {{onError}}

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 or or a recognized color name, for example red. In the case of HTML player, this attribute applies only if you are using the attribute wmode set to transparent. The dependency does not exist if you are using Flash player.
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	true	If true, hides 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. This attribute is unsupported for HTML playback. Also, you cannot disable full screen for Flash player.
height	Optional	275 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.
onError			Custom JavaScript function to run when playback results in an error.
onLoad	Optional		Custom JavaScript function to run on loading of the player component.
onPause			Custom JavaScript function to run when the video is paused.
onStart	Optional		Custom JavaScript function to run when the FLV file starts playing.
posterImage			Sets a poster image for the video playback. Takes URL or relative address as value.
quality	Optional	high	The quality of the media playback: low medium high
repeat		false	If true, continues playback from first to last frame after the media player reaches the end of the video.
skin			Path to the XML in which skinning options are specified. Applies only to FlashFor example, <cfmediaplayer source="myvideo.mp4" skin="./skin/myskin.xml">
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.
title			Sets title on the media player. The title appears over the media player on upper-left corner. If title is specified and hideTitle is not specified, then hideTitle is set to false. Also when playback is Flash, the attribute wmode for Flash player is set to opaque, and ignores the default/user-specified value.
type		flash	The media player type, if html or flash.
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 When you set playback type as Flash, value of this attribute is set to opaque, and ignores the default/user-specified value.

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="center" 
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:#progressbg
ColorTheme#;progresscolor:#progressColorTheme#;borderleft:20;borderright:20;
bordertop:10;borderbottom:13" hideborder="false" hideTitle=false controlbar="true" source="#defaultFlvfile#">

Get help faster and easier

New user?