beml_rt.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

beml_rt.dtd

Brightcove BEML "Runtime"

The root element.

<Runtime>'s children Name Cardinality Labels Any number Layout Any number Modules Any number Theme Any number

(Modules | Theme | Labels | Layout)+

top level nodes other than the Layout

<Modules>'s children Name Cardinality Module At least one

(Module)+

Enables loading a custom module.

<Module>'s children Name Cardinality param Any number

<Module>'s attributes Name Values Default file id

(param)*

The URL of a SWF file for a custom component.

Required

The id of the module to target through the API.

A name/value pair that will be passed to the custom module.

<param>'s attributes
Name	Values	Default
name
value

This element is always empty.

Sorry, no documentation.

Required

The value of the custom parameter to pass to the module.

Required

Sets a theme and style for all visual components that allow for configurable themes and styles.

<Theme>'s children Name Cardinality Font Any number Style Any number

<Theme>'s attributes Name Values Default bodyFont linkFont name style titleFont

(Style | Font)*

The overall theme.

The overall style.

The font face for body text.

The font face for title text.

The font face for link text.

Sets a style for a single component identified by the id attribute, or for all the components of a class identified by the class attribute. A Style element contains PCDATA with the CSS required to set the style for the component.

Example:

<Style id="mainTitle" >
    <![CDATA[
      .body {
        color: #777777;
    }
    ]]>
</Style>

<Style>'s attributes Name Values Default class id

The id attribute of an instance of a component for which you want to set the style. Use id="default" to override the default style.

Sorry, no documentation.

Instructs the player to load in a font file containing an embedded font that can be applied to any textfields in the player.

Example:

<Font name="Gotham Medium" />

<Font>'s attributes Name Values Default name

The name of the font file that should be loaded by the player for use with embedded fonts.

Required

Contains either the path to an XML file that contains the labels to be used for a player, individual overrides of labels within a player, or both.

<Labels>'s children Name Cardinality label Any number

<Labels>'s attributes Name Values Default file

(label)*

The URL of a label set XML file.

The label element's PCDATA contains the text for the label.

<label>'s attributes Name Values Default key

The name of the label whose text you are setting.

Required

The Layout element is the top-level container for all the layout boxes and UI components in the player.

<Layout>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number

<Layout>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y

(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | Label | Image | Link | Button | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | ExpandingBanner | Spacer | SWFLoader)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the Layout. Child elements are rendered over the background color.

Background image for the Layout. Child elements are rendered over the background image.

The type of layout box.

Possible values: vbox, hbox

The pixel space between child elements; only applicable if the boxType is "hbox" or "vbox."

Horizontal alignment.

Possible values: left, center, right

The pixel padding within the borders of the box, from which all positioning is made.

Vertical alignment.

Possible values: top, middle, bottom

The simplest type of layout box. Child elements in a Canvas are positioned absolutely within the canvas box at the (x, y) position specified in the child element.

<Canvas>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number

<Canvas>'s attributes Name Values Default backgroundColor backgroundImage height id Match the ID rules. padding style styleFile theme width x y

(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | ExpandingBanner | Spacer | SWFLoader)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the Layout. Child elements are rendered over the background color.

Background image for the Layout. Child elements are rendered over the background image.

The pixel padding within the borders of the element, from which all positioning is made.

A layout box that allows for a more complex layout, with child elements laid out in columns and rows.

<Grid>'s children Name Cardinality Columns Only one Rows Only one

<Grid>'s attributes Name Values Default backgroundColor backgroundImage height id Match the ID rules. padding style styleFile theme width x y

(Columns, Rows)

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the Layout. Child elements are rendered over the background color.

Background image for the Layout. Child elements are rendered over the background image.

The pixel padding within the borders of the element, from which all positioning is made.

Used to contain the individual Column elements in a Grid layout box. Its only attribute is gutter, allowing the setting of the pixel space between each column.

<Columns>'s children Name Cardinality Column At least one

<Columns>'s attributes Name Values Default gutter

(Column)+

The pixel space between columns.

Used to specify how many columns are to appear in a Grid and, optionally, the width of each column. No child elements are actually added to a Column element; instead, the child elements in the Grid are specified within Row elements.

<Column>'s attributes
Name	Values	Default
width

This element is always empty.

The width of the column in pixels or percent.

Used to contain the individual Row elements in a Grid layout box. Its only attribute is gutter, allowing the setting of the pixel space between each row.

<Rows>'s children Name Cardinality Row At least one

<Rows>'s attributes Name Values Default gutter

(Row)+

The pixel space between rows.

Used only within a Rows element, which in turn can be used only within a Grid layout box. A Row element acts very much like an HBox, laying out child items horizontally according to the width of the columns as specified in the Grid's Columns element. The number of child elements must correspond to the number of columns in the Grid. Any layout box or component can be a child element of a Row element.

<Row>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number

<Row>'s attributes Name Values Default backgroundColor backgroundImage gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y

(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | ExpandingBanner | Spacer | SWFLoader)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the Row. Child elements are rendered over the background color.

Background image for the Row. Child elements are rendered over the background image.

The pixel space between child elements.

Horizontal alignment.

Possible values: left, center, right

The pixel padding within the borders of the row, from which all positioning is made.

Vertical alignment.

Possible values: top, middle, bottom

A vertical box that lays out all child elements vertically. Child elements in a VBox are positioned sequentially from top to bottom, with each child element being placed directly below the preceding child element, with any specified pixel gutter between.

<VBox>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number

<VBox>'s attributes Name Values Default backgroundColor backgroundImage gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y

(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | ExpandingBanner | Spacer | SWFLoader)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the element. Child elements are rendered over the background color.

Background image for the element. Child elements are rendered over the background image.

The pixel space between child elements.

Horizontal alignment.

Possible values: left, center, right

The pixel padding within the borders of the box, from which all positioning is made.

Vertical alignment.

Possible values: top, middle, bottom

A horizontal box that lays out all its child elements horizontally. Child elements in an HBox are positioned sequentially from left to right, with each child element being placed directly to the right of the preceding child element, with an optional gutter between.

<HBox>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number

<HBox>'s attributes Name Values Default backgroundColor backgroundImage gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y

(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | ExpandingBanner | Spacer | SWFLoader)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the element. Child elements are rendered over the background color.

Background image for the element. Child elements are rendered over the background image.

The pixel space between child elements.

Horizontal alignment.

Possible values: left, center, right

The pixel padding within the borders of the box, from which all positioning is made.

Vertical alignment.

Possible values: top, middle, bottom

The Banner plugs into the advertising capabilities in a player. When a Banner element is included, a new format is allowed and are appended to all ad server calls, informing the ad server that a banner can be displayed. The size of the banner dictates the ad format supported, so a 468x60 banner element by default supports a 468x60 banner ad format. Additional ad formats can be specified as well, so that you can use a large banner area to support several smaller sizes of banner. How those banners are scaled and aligned within the larger area is controlled by the Banner's attributes.

<Banner>'s attributes
Name	Values	Default
alpha
bannerFormats
blendMode
depth
hAlign	left, center, right
height
id	Match the ID rules.
rotation
scaleMode	noScale, exactFit, showAll, scaleDown, noBorder
source
style
styleFile
theme
tooltip
url
vAlign	top, middle, bottom
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

A comma-delimited list of supported banner formats; these map to the formats of Brightcove's rich media templates. If a Banner component is of a size that matches one of the Brightcove-supported banner formats, that format is automatically included.

Horizontal alignment.

Possible values: left, center, right

How the Banner image should be scaled within the dimensions of the element.

Possible values: noScale, exactFit, showAll, scaleDown, noBorder

The path to the image to load; this is dynamically populated for incoming ads.

The text of a tooltip to appear when the viewer rolls over the image.

The URL to send the viewer to when the image is clicked; this is dynamically populated for incoming ads.

Vertical alignment.

Possible values: top, middle, bottom

Defines a clickable graphic with a label that can broadcast events.

<Button>'s attributes
Name	Values	Default
alpha
autoSize	true, false
blendMode
click
data
depth
font
height
iconAlignmentH	right, center, left
iconAlignmentV	top, middle, bottom
iconName
iconOffsetX
iconOffsetY
iconScale
id	Match the ID rules.
label
labelAlignmentH	left, center, right
labelAlignmentV	top, middle, bottom
labelBuffer
labelOffsetX
labelOffsetY
lockHeight	true, false
maxWidth
multiline	true, false
rotation
showBack	true, false
size
style
styleFile
theme
tooltip
truncateLabel	true, false
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

Whether the button should automatically resize based on the amount of text.

Possible values: true, false

The function to call when the button is clicked.

Data stored with the element that can be passed when the button is clicked.

The font to use for the label. The font must be loaded through a style.

The horizontal alignment of the icon within the button's dimensions.

Possible values: right, center, left

The vertical alignment of the icon within the button's dimensions.

Possible values: top, middle, bottom

The pixel offset on the x axis to apply to the icon.

The pixel offset on the y axis to apply to the icon.

The name of icon to use for the button.

The percentage of the icon size at which to render the icon.

The text to display on the button.

The horizontal alignment of the label within the button's dimensions.

Possible values: left, center, right

The vertical alignment of the label within the button's dimensions.

Possible values: top, middle, bottom

The distance in pixels between the edge of the button and its label.

The pixel offset on the x axis to apply to the label.

The pixel offset on the y axis to apply to the label.

Used with autoSize, locks the height of the button to the specified pixel height, allowing the button to resize only horizontally.

Possible values: true, false

Used with autoSize, sets the maximum width the button can be before it begins to truncate its label.

Whether the button label should display multiple lines of text.

Possible values: true, false

Whether the background of the graphic should be shown.

Possible values: true, false

The size of the text to display, in points.

The tooltip to display on rollover of the text.

Whether the label should display an elipsis (...) when the text to display exceeds the button's width.

Possible values: true, false

A video window with overlaid video controls that hide when the mouse is not over the video or there is user inaction.

<ChromelessVideoPlayer>'s attributes
Name	Values	Default
alpha
autoStart	true, false
blendMode
depth
height
id	Match the ID rules.
preventFullScreen	true, false
rotation
style
styleFile
theme
video
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

Whether the video should begin to play back immediately when the player loads.

Possible values: true, false

Whether the maximize button should be suppressed in the player's controls.

Possible values: true, false

The videoDTO currently loaded into the video player

Renders a drop down list of scrollable items.

<ComboBox>'s children Name Cardinality data One or none

<ComboBox>'s attributes Name Values Default alpha animated true, false blendMode data depth height id Match the ID rules. itemInsetH itemInsetV itemLeading label labelBufferLeft labelBufferRight labelBufferTop labelField noInitialSelection true, false numRows rotation rowHeight scrollerInset scrollerWidth style styleFile theme visible width x y

(data?)

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

Whether the list should animate when opening.

Possible values: true, false

The data for the list. This can be bound to a value in another component, for example, the videos defined in a playlist stored in a tab.

The amount in pixels that items within the list are inset horizontally from the borders of the list.

The amount in pixels that items within the list are inset vertically from the borders of the list.

The vertical space in pixels between each item (defaults to 5).

The text that should display when no item is selected.

The pixel buffer to the left of the label.

The pixel buffer to the right of the label.

The pixel buffer to the top of the label.

The property of the list item that should be used for the item label.

Whether the first item in the list should be in a selected state when the list is initially rendered.

Possible values: true, false

The maximum number of rows that should display when the list is opened.

The height of each row in pixels (defaults to 50).

The amount in pixels that the vertical scrollbar is inset horizontally from the borders of the list.

The width in pixels of the vertical scrollbar.

The data provider for a ComboBox

<data>'s children Name Cardinality String Any number

(String)*

The String datatype for use in list item data.

The ExpandingBanner plugs into the advertising capabilities in a player. When an Expanding Banner element is included, two new formats are allowed and are appended all ad server calls informing the ad server that a banner can be displayed. The size of the banner dictates the ad formats supported, so a 468x60 banner element by default supports a 468x60 banner ad format and a 468x60 synched banner unit. Additional ad formats can be specified as well, so that a large banner area can actually be made to support several smaller sizes of banner. How those banners are scaled and aligned within the larger area is controlled by the ExpandingBanner's attributes.

<ExpandingBanner>'s attributes
Name	Values	Default
alpha
animationType	fade, expand
bannerFormats
blendMode
buttonHeight
buttonWidth
collapsedHAlign	left, center, right
collapsedVAlign	top, middle, bottom
depth
disableOnExpand
expandDirection	up, down
expandedHeight
expandedOffsetX
expandedOffsetY
expandedWidth
height
id	Match the ID rules.
rotation
showButtons	true, false
style
styleFile
theme
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

How the banner animates when it expands or collapses.

Possible values: fade, expand

A comma-delimited list of supported banner formats; these map to the formats of Brightcove's rich media templates. If a Banner component is of a size that matches one of the Brightcove-supported banner formats, that format is automatically included.

The height in pixels of the expand/collapsed buttons; the default is 10.

The width in pixels of the expand/collapse buttons; the default is 60.

The horizontal alignment of the collapsed image within its dimensions.

Possible values: left, center, right

The vertical alignment of the collapsed image within its dimensions.

Possible values: top, middle, bottom

A comma-separated list of the names of the components to disable when the banner is in its expanded state.

The direction in which the expanded unit will be placed, in relation to the collapsed unit.

Possible values: up, down

The height in pixels of the expanded unit.

The number of pixels on the x axis to move the expanded unit in relation to the collapsed unit; default is 0.

The number of pixels on the y axis to move the expanded unit in relation to the collapsed unit; default is 0.

The width in pixels of the expanded unit; the default is the full width of the ExpandingBanner component.

Whether the expand/collapse buttons are visible.

Possible values: true, false

Allows for any JPG, GIF or SWF to be loaded into a player, scaled according to the scaleMode attribute of the component.

<Image>'s attributes
Name	Values	Default
alpha
blendMode
click
data
depth
hAlign	left, center, right
height
id	Match the ID rules.
rotation
scaleMode	noScale, exactFit, showAll, scaleDown, noBorder
source
style
styleFile
theme
tooltip
url
vAlign	top, middle, bottom
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

The function to call when the button is clicked.

Data stored with the element that can be passed when the button is clicked.

Horizontal alignment.

Possible values: left, center, right

How the image should be scaled within the dimensions of the element.

Possible values: noScale, exactFit, showAll, scaleDown, noBorder

The path to the image to load.

The tooltip to display on rollover of the image.

The URL to send the viewer to when the image is clicked

Vertical alignment.

Possible values: top, middle, bottom

A simple text component that allows for any text to be added to an experience. The text can be bound dynamically to any other component's property, for instance to display the name of the currently playing video.

<Label>'s attributes
Name	Values	Default
alpha
autoSize	true, false
blendMode
color
depth
font
hAlign	left, center, right
height
htmlEnabled	true, false
id	Match the ID rules.
multiline	true, false
resize	true, false
rotation
size
style
styleFile
text
theme
translationText
truncate	true, false
type	body, title, link
underline	true, false
vAlign	top, middle, bottom
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

The color of the text to display.

The font to use for the label. The font must be loaded through a style.

Horizontal alignment.

Possible values: left, center, right

Whether the label should render HTML text.

Possible values: true, false

Whether the label should display multiple lines of text.

Possible values: true, false

Deprecated.

Possible values: true, false

Whether the label should automatically resize with the amount of text.

Possible values: true, false

The size of the text, in points.

The text of the label.

If the text exists as a label key in the loaded resource bundle, the translated text will appear.

Whether the label should display an elipsis (...) when the text to display exceeds the label's width.

Possible values: true, false

A type which corresponds to the desired style to apply.

Possible values: body, title, link

Whether the text should be underlined.

Possible values: true, false

Vertical alignment.

Possible values: top, middle, bottom

Provides a means to display clickable text within a player to be used to navigate to another URL or call JavaScript.

<Link>'s attributes
Name	Values	Default
alpha
blendMode
click
data
depth
font
hAlign	left, center, right
height
id	Match the ID rules.
multiline	true, false
rotation
size
style
styleFile
text
theme
tooltip
url
vAlign	top, middle, bottom
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

The function to call when the link is clicked.

Data stored with the element that can be passed when the link is clicked.

The font to use for the link. The font must be loaded through a style.

Horizontal alignment.

Possible values: left, center, right

Whether the link should display multiple lines of text.

Possible values: true, false

The size of the link text, in points.

The text of the link.

The tooltip to display on rollover of the image.

The URL to send the viewer to when the link is clicked

Vertical alignment.

Possible values: top, middle, bottom

Displays a vertical scrolling list composed of ListItems. Each ListItem in turn specifies its contained elements and their layout. A ListItem can contain any of the supported UI control components, other than a VideoPlayer or a list component.

<List>'s children Name Cardinality ListItem Only one

<List>'s attributes Name Values Default alpha automaticAdvance true, false blendMode data depth height id Match the ID rules. itemInsetH itemInsetV itemLeading noInitialSelection true, false noSelect true, false rotation rowHeight scrollerInset scrollerWidth selectOnClick true, false showBack true, false style styleFile theme visible width x y

(ListItem)

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

Whether videos (if a video list) should automatically advance when play is complete.

Possible values: true, false

The data for the list. This can be bound to a value in another component, for example, the videos defined in a playlist stored in a tab.

The amount in pixels that items within the list are inset horizontally from the borders of the list.

The amount in pixels that items within the list are inset vertically from the borders of the list.

The vertical space in pixels between each item (defaults to 5).

Whether the first item in the list should be in a selected state when the list is initially rendered.

Possible values: true, false

Whether the list should show and maintain a selected state; this is useful when a list is used independently of any other elements, like a video player, where a click might launch a new browser window.

Possible values: true, false

The height of each row in pixels (defaults to 50).

The amount in pixels that the vertical scrollbar is inset horizontally from the borders of the list.

The width in pixels of the vertical scrollbar.

Whether clicking subelements in the list items automatically selects the associated list item.

Possible values: true, false

Deprecated.

Possible values: true, false

A ListItem must be defined within a List or TileList component. A ListItem can contain any supported component except a VideoPlayer or another list.

<ListItem>'s children Name Cardinality Button Any number Canvas Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number Spacer Any number SWFLoader Any number ThumbnailButton Any number TitleLabel Any number VBox Any number

<ListItem>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox gutter hAlign left, center, right height id Match the ID rules. padding showBack true, false style styleFile theme vAlign top, middle, bottom width x y

(Canvas | HBox | VBox | Grid | Label | Image | Link | Button | ThumbnailButton | TitleLabel | Spacer | SWFLoader)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the ListItem. Child elements are rendered over the background color.

Background image for the ListItem. Child elements are rendered over the background image.

The type of layout box.

Possible values: vbox, hbox

The pixel space between child elements.

Horizontal alignment.

Possible values: left, center, right

Vertical alignment.

Possible values: top, middle, bottom

The pixel padding within the borders of the box, from which all positioning is made.

Whether a background graphic should display behind the element.

Possible values: true, false

A layout container for media UI controls to control playback of audio or video.

<MediaControls>'s children Name Cardinality Button Any number Canvas Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number Playhead Any number Spacer Any number SWFLoader Any number TitleLabel Any number ToggleButton Any number VBox Any number VolumeControl Any number

<MediaControls>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox depth gutter hAlign left, center, right height id Match the ID rules. padding showBack true, false style styleFile theme vAlign top, middle, bottom width x y

(Canvas | HBox | VBox | Grid | Label | Image | Link | Button | ToggleButton | TitleLabel | Spacer | SWFLoader | Playhead | VolumeControl)*

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

Background color for the ListItem. Child elements are rendered over the background color.

Background image for the ListItem. Child elements are rendered over the background image.

The type of layout box.

Possible values: vbox, hbox

The depth of the component in levels.

The pixel space between child elements.

Horizontal alignment.

Possible values: left, center, right

Vertical alignment.

Possible values: top, middle, bottom

The pixel padding within the borders of the box, from which all positioning is made.

Whether a background graphic should display behind the MediaControls.

Possible values: true, false

A scrubber bar to control media playback and show current media position.

<Playhead>'s attributes
Name	Values	Default
alpha
autohideSlider	true, false
blendMode
depth
height
id	Match the ID rules.
mediaController
rotation
sliderWidth
style
styleFile
theme
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

The media controller (e.g., VideoPlayer, VideoDisplay) to receive events from and control playback of.

Whether the slider should only appear on rollover.

Possible values: true, false

The width of the draggable slider in pixels.

A formatting component that creates space between other elements.

<Spacer>'s attributes
Name	Values	Default
height
id
width

This element is always empty.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

The height of the element in percent or pixels.

The width of the element in pixels or percent.

The SWFLoader component allows you to specify a custom-developed SWF to be loaded, positioned and sized within a player. You can develop a custom component using ActionScript 3 and the Brightcove Player API. In order for the loaded SWF to be passed a handle to the runtime API, so that it can listen for events and interact with the rest of the player, it should implement the interface defined by this method signature:
function setInterface(obj:Object):void;

<SWFLoader>'s attributes
Name	Values	Default
alpha
blendMode
data
depth
height
id	Match the ID rules.
rotation
source
style
styleFile
theme
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

Additional data that is passed to the loaded SWF.

The URL of the SWF for the custom component to be loaded.

Displays a horizontally-paging series of tabs. The TabBar allows for a single selection in the collection. The TabBar displays left and right navigation when the number of tabs exceeds the component dimensions. Optionally, the TabBar can display a tab that produces a dropdown list on rollover.

<TabBar>'s attributes
Name	Values	Default
alpha
autoSizeTabs	true, false
blendMode
data
depth
height
hideSingleTab	true, false
id	Match the ID rules.
includeMenu	true, false
labelBuffer
labelField
maxMenuRows
menuItemInset
menuRowHeight
menuWidth
rotation
style
styleFile
tabAlign	left, center, right
tabPadding
tabWidth
theme
visible
width
x
y

This element is always empty.

The height of the element in percent or pixels.

An identifier by which you can refer to the element from other elements or when using CSS or the APIs.

Possible values: Match the ID rules.

The width of the element in pixels or percent.

The horizontal position of the element, in pixels from the lower left.

The vertical position of the element, in pixels from the lower left.

The name of the theme to apply to the element.

Inline CSS to apply to the element.

The URL of a CSS file containing the style to apply to the element.

The opacity of the component between 0 and 1.

The ActionScript DisplayObject blend mode of the component.

The depth of the component in levels.

The rotation of the component in degrees.

Whether the component should be visible.

Whether tabs are sized based on the length of their labels or are a fixed width.

Possible values: true, false

The data for the element. This can be bound to a value in another component, for example, the videos defined in a playlist stored in a tab.

If there is only a single tab, whether to display a tab.

Possible values: true, false

Whether to display the tab with the drop down quick navigation menu when necessary.

Possible values: true, false

The pixel space to the left and right of labels within a tab.

The field in the data object that determines the label of a tab.

The maximum number of menu rows that can display in the drop down quick navigation menu before paging is forced.

The horizontal pixel inset of labels within the drop down quick navigation menu.

The height in pixels of each item in the drop down quick navigation menu .

The width of the drop down quick navigation menu when it opens.