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 hash id required true, false false

(param)*

The URL of a SWF file for a custom component.

Required

The id of the module to target through the API.

Whether successful loading of the module is required before loading the player.

Possible values: true, false - Default value: false

The SHA1 hash value for the file for the custom component.

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. By default, it acts as a Canvas. You can use the boxType attribute to specify that the Layout element should instead act as a VBox or HBox.

<Layout>'s children Name Cardinality AudioPlayer Any number Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number

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

(ViewStack | Canvas | HBox | VBox | Grid | AudioPlayer | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | GraphicBlock | Label | Image | Link | Button | LiveButton | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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. If this element has multiple child elements, this attribute indicates whether the children are arranged vertically (vbox) or horizontally (hbox).

Possible values: vbox, hbox

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

Default value: 0

Horizontal alignment.

Possible values: left, center, right - Default value: left

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

Default value: 0

Vertical alignment.

Possible values: top, middle, bottom - Default value: top

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 AudioPlayer Any number Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number VolumeControl Any number

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

(ViewStack | Canvas | HBox | VBox | Grid | AudioPlayer | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | GraphicBlock | Playhead | VolumeControl | Label | Image | Link | Button | LiveButton | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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 maximum height in pixels that the box should render at.

The maximum width in pixels that the box should render at.

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

Default value: 0

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. includeInLayout true maxHeight maxWidth padding 0 style styleFile theme visible true 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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 maximum height in pixels that the box should render at.

The maximum width in pixels that the box should render at.

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

Default value: 0

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 0

(Column)+

The pixel space between columns.

Default value: 0

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 0

(Row)+

The pixel space between rows.

Default value: 0

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 AudioPlayer Any number Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number VolumeControl Any number

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

(ViewStack | Canvas | HBox | VBox | Grid | AudioPlayer | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | GraphicBlock | Playhead | VolumeControl | Label | Image | Link | Button | LiveButton | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 0

Horizontal alignment.

Possible values: left, center, right - Default value: left

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

Default value: 0

Vertical alignment.

Possible values: top, middle, bottom - Default value: top

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 AudioPlayer Any number Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number VolumeControl Any number

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

(ViewStack | Canvas | HBox | VBox | Grid | AudioPlayer | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | GraphicBlock | Playhead | VolumeControl | Label | Image | Link | Button | LiveButton | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 0

Horizontal alignment.

Possible values: left, center, right - Default value: left

The maximum height in pixels that the box should render at.

The maximum width in pixels that the box should render at.

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

Default value: 0

Vertical alignment.

Possible values: top, middle, bottom - Default value: top

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 AudioPlayer Any number Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number VolumeControl Any number

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

(ViewStack | Canvas | HBox | VBox | Grid | AudioPlayer | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | GraphicBlock | Playhead | VolumeControl | Label | Image | Link | Button | LiveButton | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 0

Horizontal alignment.

Possible values: left, center, right - Default value: left

The maximum height in pixels that the box should render at.

The maximum width in pixels that the box should render at.

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

Default value: 0

Vertical alignment.

Possible values: top, middle, bottom - Default value: top

A layout box that stacks all elements on top of each other and can show only one element at a time based on the selected index in the stack.

<ViewStack>'s children Name Cardinality AudioPlayer Any number Banner Any number Button Any number Canvas Any number ChromelessVideoPlayer Any number ComboBox Any number ExpandingBanner Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number VolumeControl Any number

<ViewStack>'s attributes Name Values Default backgroundColor backgroundImage height id Match the ID rules. includeInLayout true maxHeight maxWidth padding 0 selectedIndex 0 selectedItemID style styleFile theme visible true width x y

(ViewStack | Canvas | HBox | VBox | Grid | AudioPlayer | VideoPlayer | VideoDisplay | ChromelessVideoPlayer | MediaControls | TextRegion | GraphicBlock | Playhead | VolumeControl | Label | Image | Link | Button | LiveButton | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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 maximum height in pixels that the box should render at.

The maximum width in pixels that the box should render at.

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

Default value: 0

The index in the stack of the visible child element.

Default value: 0

The BEML id of the visible child element.

The nonrendering AudioPlayer allows for programming and playback of audio media within the player.

<AudioPlayer>'s attributes
Name	Values	Default
audioTrack
autoStart	true, false	false
id	Match the ID rules.

This element is always empty.

The audio track to play.

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

Possible values: true, false - Default value: false

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 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		1
bannerFormats
blendMode		normal
depth
enabled		true
hAlign	left, center, right	center
height
id	Match the ID rules.
includeInLayout		true
rotation		0
scaleMode	noScale, exactFit, showAll, scaleDown, noBorder	noScale
source
style
styleFile
theme
tooltip
url
vAlign	top, middle, bottom	middle
visible		true
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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

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 - Default value: center

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

Possible values: noScale, exactFit, showAll, scaleDown, noBorder - Default value: noScale

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 - Default value: middle

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

<Button>'s attributes
Name	Values	Default
accessibleName
alpha		1
autoSize	true, false	false
blendMode		normal
click
data
depth
enabled		true
font
height
iconAlignmentH	right, center, left	center
iconAlignmentV	top, middle, bottom	middle
iconName
iconOffsetX		0
iconOffsetY		0
iconScale		1
id	Match the ID rules.
includeInLayout		true
label
labelAlignmentH	left, center, right	center
labelAlignmentV	top, middle, bottom	middle
labelBuffer		0
labelOffsetX		0
labelOffsetY		0
lockHeight	true, false	false
maxWidth
multiline	true, false	false
rotation		0
showBack	true, false	true
size
style
styleFile
tabIndex
theme
tooltip
truncateLabel	true, false	false
visible		true
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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

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

Possible values: true, false - Default value: 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 - Default value: center

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

Possible values: top, middle, bottom - Default value: middle

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

Default value: 0

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

Default value: 0

The name of icon to use for the button.

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

Default value: 1

The text to display on the button.

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

Possible values: left, center, right - Default value: center

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

Possible values: top, middle, bottom - Default value: middle

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

Default value: 0

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

Default value: 0

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

Default value: 0

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 - Default value: 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 - Default value: false

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true

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 - Default value: false

The index of the element in the player tab order.

The text read by screenreader when element received focus.

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

<ChromelessVideoPlayer>'s children Name Cardinality ChromelessControls One or none

<ChromelessVideoPlayer>'s attributes Name Values Default alpha 1 autoStart true, false false blendMode normal compactViewThreshold 320 depth enabled true height hideControlsOnLoad true, false false id Match the ID rules. includeInLayout true preventFullScreen true, false false rotation 0 style styleFile theme useOverlayMenu true, false true video visible true width x y

(ChromelessControls?)

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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

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

Possible values: true, false - Default value: false

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

Possible values: true, false - Default value: false

The videoDTO currently loaded into the video player

The pixel width threshold at which the controls will switch to a compact view, if defined.

Default value: 320

Whether the controls should be hidden on instantiation of the component.

Possible values: true, false - Default value: false

Whether the menu with video name and menu icons should appear overlaid on the video.

Possible values: true, false - Default value: true

The layout box for the UI that overlays the video and is only shown on user rollover.

<ChromelessControls>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ComboBox Any number GraphicBlock Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number LiveButton 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 ViewStack Any number VolumeControl Any number

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

(ViewStack | Canvas | HBox | VBox | Grid | MediaControls | TextRegion | GraphicBlock | Label | Image | Link | Button | LiveButton | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | Spacer | SWFLoader | 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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."

Default value: 0

Horizontal alignment.

Possible values: left, center, right - Default value: left

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

Default value: 0

Vertical alignment.

Possible values: top, middle, bottom - Default value: top

Renders a drop down list of scrollable items.

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

<ComboBox>'s attributes Name Values Default accessibleName alpha 1 animated true, false true blendMode normal data depth enabled true height id Match the ID rules. includeInLayout true itemInsetH 0 itemInsetV 0 itemLeading 0 label labelBufferLeft 6 labelBufferRight 16 labelBufferTop 1 labelField label noInitialSelection true, false false numRows 5 rotation 0 rowHeight 22 scrollerInset 0 scrollerWidth 23 style styleFile tabIndex theme useComboOverlay true, false false visible true 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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

Whether the list should animate when opening.

Possible values: true, false - Default value: true

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.

Default value: 0

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

Default value: 0

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

Default value: 0

The text that should display when no item is selected.

The pixel buffer to the left of the label.

Default value: 6

The pixel buffer to the right of the label.

Default value: 16

The pixel buffer to the top of the label.

Default value: 1

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

Default value: label

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

Possible values: true, false - Default value: false

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

Default value: 5

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

Default value: 22

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

Default value: 0

The width in pixels of the vertical scrollbar.

Default value: 23

The index of the element in the player tab order.

The text read by screenreader when element received focus.

Whether the popup menu should be rendered on a layer above all UI elements.

Possible values: true, false - Default value: false

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		1
animationType	fade, expand	expand
bannerFormats
blendMode		normal
buttonHeight		10
buttonWidth		60
collapsedHAlign	left, center, right	left
collapsedVAlign	top, middle, bottom	top
depth
disableOnExpand
enabled		true
expandDirection	up, down	up
expandedHeight		250
expandedOffsetX		0
expandedOffsetY		0
expandedWidth		-1
height
id	Match the ID rules.
includeInLayout		true
rotation		0
showButtons	true, false	true
style
styleFile
theme
visible		true
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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

How the banner animates when it expands or collapses.

Possible values: fade, expand - Default value: 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.

Default value: 10

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

Default value: 60

The horizontal alignment of the collapsed image within its dimensions.

Possible values: left, center, right - Default value: left

The vertical alignment of the collapsed image within its dimensions.

Possible values: top, middle, bottom - Default value: top

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 - Default value: up

The height in pixels of the expanded unit.

Default value: 250

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

Default value: 0

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

Default value: 0

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

Default value: -1

Whether the expand/collapse buttons are visible.

Possible values: true, false - Default value: true

The GraphicBlock is a non-interactive graphic that can be used as a skin behind other elements.

<GraphicBlock>'s attributes
Name	Values	Default
alpha		1
blendMode		normal
depth
enabled		true
height
id	Match the ID rules.
includeInLayout		true
rotation		0
style
styleFile
theme
visible		true
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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

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
accessibleName
alpha		1
blendMode		normal
click
data
depth
enabled		true
hAlign	left, center, right	center
height
id	Match the ID rules.
includeInLayout		true
rotation		0
scaleMode	noScale, exactFit, showAll, scaleDown, noBorder	exactFit
source
style
styleFile
tabIndex
theme
tooltip
url
vAlign	top, middle, bottom	middle
visible		true
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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

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 - Default value: center

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

Possible values: noScale, exactFit, showAll, scaleDown, noBorder - Default value: exactFit

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 - Default value: middle

The index of the element in the player tab order.

The text read by screenreader when element received focus.

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		1
autoSize	true, false	false
blendMode		normal
color
depth
enabled		true
font
hAlign	left, center, right	left
height
htmlEnabled	true, false	false
id	Match the ID rules.
includeInLayout		true
multiline	true, false	false
resize	true, false	false
rotation		0
size
style
styleFile
tabIndex
text
theme
translationText
truncate	true, false	false
type	body, title, link	body
underline	true, false	false
vAlign	top, middle, bottom	top
visible		true
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.

Whether the element should be included in the rendering and the size and position calculations.

Default value: true

Whether the component should be visible.

Default value: true

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.

Default value: 1

The ActionScript DisplayObject blend mode of the component.

Default value: normal

The depth of the component in levels.

Whether a component will receive mouse events.

Default value: true

The rotation of the component in degrees.

Default value: 0

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 - Default value: left

Whether the label should render HTML text.

Possible values: true, false - Default value: false

Whether the label should display multiple lines of text.

Possible values: true, false - Default value: false

Deprecated.

Possible values: true, false - Default value: false

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

Possible values: true, false - Default value: 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 - Default value: false

A type which corresponds to the desired style to apply.

Possible values: body, title, link - Default value: body

Whether the text should be underlined.

Possible values: true, false - Default value: false

Vertical alignment.

Possible values: top, middle, bottom - Default value: top

The index of the element in the player tab order.

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		1
blendMode		normal
click
data
depth
enabled		true
font
hAlign	left, center, right	left
height
id	Match the ID rules.
includeInLayout		true
multiline	true, false	false
rotation		0
size
style
styleFile
tabIndex
text
theme
tooltip
url
vAlign	top, middle, bottom	top
visible		true
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.