DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
Reference¶
These are the constants of the extension. Constants names are matching player configuration parameters.
All properties have the prefix “plugin.tx_brightcovevideo.player”
backgroundColor¶
Property
backgroundColor
Data type
string
Description
A six-digit hexadecimal representation of the player's background color.
Default
ffffff
dynamicStreaming¶
Property
dynamicStreaming
Data type
boolean
Description
If true (the default setting), the player can take advantage of Flash Media Server 3.5 and Flash Player 10 smooth streaming capabilities.
Default
true
htmlDefaultBitrate¶
Property
htmlDefaultBitrate
Data type
int
Description
The default progressive download bitrate to use for HTML5 players.
Default
384000
htmlFallback¶
Property
htmlFallback
Data type
boolean
Description
Allows the HTML5 player to be loaded on devices that support Flash but do not have Flash installed.
Default
true
includeAPI¶
Property
includeAPI
Data type
boolean
Description
Required to be true in order to use the Smart Player API with this player.
Default
true
isUI¶
Property
isUI
Data type
boolean
Description
Required to be true for video players whose templates include UI elements other than the VideoPlayer component, such as a ChromelessVideoPlayer or VideoDisplay and MediaControls components.
Default
true
isVid¶
Property
isVid
Data type
boolean
Description
Required to be true for all video players.
Default
true
labels¶
Property
labels
Data type
string
Description
The URL of an XML file that describes the label set to use for this player.
language¶
Property
language
Data type
string
Description
The language to use for the default player labels; one of en (English), fr (French), de (German), it (Italian), jp (Japanese), ko (Korean) or es (Spanish).
Default
en
linkBaseURL¶
Property
linkBaseURL
Data type
string
Description
The base URL to use when the viewer clicks the "Share", "Get Link", or "Email" button in the player.
localizedErrorXML¶
Property
localizedErrorXML
Data type
string
Description
The URL of a player error message file. This XML file specifies the messages to be displayed in case of player errors.
majorVersion¶
Property
majorVersion
Data type
string
Description
The major version number of Flash that is required.
minorRevision¶
Property
minorRevision
Data type
string
Description
The minor revision number of Flash 9 that is required.
secureConnections¶
Property
secureConnections
Data type
boolean
Description
If true, prevents a Flash-based player that is published on a page that uses HTTPS from triggering security warnings.
Default
false
secureHTMLConnections¶
Property
secureHTMLConnections
Data type
boolean
Description
If true, prevents an HTML5 player that is published on a page that uses HTTPS from triggering security warnings.
Default
false
skipContentCall¶
Property
skipContentCall
Data type
boolean
Description
If true, prevents a content call from being made, if you are using the Flash-only Player API to retrieve content.
Default
false
showNoContentMessage¶
Property
showNoContentMessage
Data type
boolean
Description
If true, enables the display of a warning message if no content has been assigned to the player.
Default
false
templateErrorHandler¶
Property
templateErrorHandler
Data type
string
Description
The name of a user-defined JavaScript function to be automatically invoked in response to player error events.
templateLoadHandler¶
Property
templateLoadHandler
Data type
string
Description
The name of a user-defined JavaScript function to be automatically invoked when the player loads. This provides an entry point for the Smart Player API.
Default
Tx_BrightcoveVideo.onTemplateLoad
templateReadyHandler¶
Property
templateReadyHandler
Data type
string
Description
The name of a user-defined JavaScript function to be automatically invoked player ready events.
Default
Tx_BrightcoveVideo.onTemplateReady
videoSmoothing¶
Property
videoSmoothing
Data type
boolean
Description
Overrides the default video smoothing behavior for the player; if true (the default value), always applies video smoothing and if false, never applies video smoothing. If absent, the player uses video smoothing.
Default
true
wmode¶
Property
wmode
Data type
string
Description
Sets the Window Mode property of the SWF file for transparency, layering, positioning, and rendering in the browser.
Default
window