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

beml_rt.dtd

Brightcove BEML "Runtime"



<Runtime> Root element

The root element.

<Runtime>'s children
NameCardinality
LabelsAny number
LayoutAny number
ModulesAny number
ThemeAny number
Element's model:

(Modules | Theme | Labels | Layout)+


<Modules> Child of Runtime

top level nodes other than the Layout

<Modules>'s children
NameCardinality
ModuleAt least one
Element's model:

(Module)+


<Module> Child of Modules

Enables loading a custom module.

<Module>'s children
NameCardinality
paramAny number
<Module>'s attributes
NameValuesDefault
file
hash
id
requiredtrue, falsefalse
Element's model:

(param)*


@file Attribute of Module

The URL of a SWF file for a custom component.

Required


@id Attribute of Module

The id of the module to target through the API.


@required Attribute of Module

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

Possible values: true, false - Default value: false


@hash Attribute of Module

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


<param/> Child of Module

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

<param>'s attributes
NameValuesDefault
name
value

This element is always empty.


@name Attribute of param

Sorry, no documentation.

Required


@value Attribute of param

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

Required


<Theme> Child of Runtime

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

<Theme>'s children
NameCardinality
FontAny number
StyleAny number
<Theme>'s attributes
NameValuesDefault
bodyFont
linkFont
name
style
titleFont
Element's model:

(Style | Font)*


@name Attribute of Theme

The overall theme.


@style Attribute of Theme

The overall style.


@bodyFont Attribute of Theme

The font face for body text.


@titleFont Attribute of Theme

The font face for title text.


@linkFont Attribute of Theme

The font face for link text.


<Style> Child of Theme

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
NameValuesDefault
class
id

@id Attribute of Style

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.


@class Attribute of Style

Sorry, no documentation.


<Font> Child of Theme

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
NameValuesDefault
name

@name Attribute of Font

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

Required


<Labels> Child of Runtime

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
NameCardinality
labelAny number
<Labels>'s attributes
NameValuesDefault
file
Element's model:

(label)*


@file Attribute of Labels

The URL of a label set XML file.


<label> Child of Labels

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

<label>'s attributes
NameValuesDefault
key

@key Attribute of label

The name of the label whose text you are setting.

Required


<Layout> Child of Runtime

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
NameCardinality
AudioPlayerAny number
BannerAny number
ButtonAny number
CanvasAny number
ChromelessVideoPlayerAny number
ComboBoxAny number
ExpandingBannerAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
VideoDisplayAny number
VideoPlayerAny number
ViewStackAny number
<Layout>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
boxTypevbox, hbox
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
padding0
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

(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)*


@height Attribute of Layout

The height of the element in percent or pixels.


@id Attribute of Layout

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.


@includeInLayout Attribute of Layout

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

Default value: true


@visible Attribute of Layout

Whether the component should be visible.

Default value: true


@width Attribute of Layout

The width of the element in pixels or percent.


@x Attribute of Layout

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


@y Attribute of Layout

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


@theme Attribute of Layout

The name of the theme to apply to the element.


@style Attribute of Layout

Inline CSS to apply to the element.


@styleFile Attribute of Layout

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


@backgroundColor Attribute of Layout

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


@backgroundImage Attribute of Layout

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


@boxType Attribute of Layout

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


@gutter Attribute of Layout

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

Default value: 0


@hAlign Attribute of Layout

Horizontal alignment.

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


@padding Attribute of Layout

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

Default value: 0


@vAlign Attribute of Layout

Vertical alignment.

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


<Canvas> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls

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
NameCardinality
AudioPlayerAny number
BannerAny number
ButtonAny number
CanvasAny number
ChromelessVideoPlayerAny number
ComboBoxAny number
ExpandingBannerAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
PlayheadAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
VideoDisplayAny number
VideoPlayerAny number
ViewStackAny number
VolumeControlAny number
<Canvas>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
height
idMatch the ID rules.
includeInLayouttrue
maxHeight
maxWidth
padding0
style
styleFile
theme
visibletrue
width
x
y
Element's model:

(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)*


@height Attribute of Canvas

The height of the element in percent or pixels.


@id Attribute of Canvas

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.


@includeInLayout Attribute of Canvas

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

Default value: true


@visible Attribute of Canvas

Whether the component should be visible.

Default value: true


@width Attribute of Canvas

The width of the element in pixels or percent.


@x Attribute of Canvas

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


@y Attribute of Canvas

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


@theme Attribute of Canvas

The name of the theme to apply to the element.


@style Attribute of Canvas

Inline CSS to apply to the element.


@styleFile Attribute of Canvas

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


@backgroundColor Attribute of Canvas

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


@backgroundImage Attribute of Canvas

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


@maxHeight Attribute of Canvas

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


@maxWidth Attribute of Canvas

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


@padding Attribute of Canvas

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

Default value: 0


<Grid> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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

<Grid>'s children
NameCardinality
ColumnsOnly one
RowsOnly one
<Grid>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
height
idMatch the ID rules.
includeInLayouttrue
maxHeight
maxWidth
padding0
style
styleFile
theme
visibletrue
width
x
y
Element's model:

(Columns, Rows)


@height Attribute of Grid

The height of the element in percent or pixels.


@id Attribute of Grid

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.


@includeInLayout Attribute of Grid

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

Default value: true


@visible Attribute of Grid

Whether the component should be visible.

Default value: true


@width Attribute of Grid

The width of the element in pixels or percent.


@x Attribute of Grid

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


@y Attribute of Grid

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


@theme Attribute of Grid

The name of the theme to apply to the element.


@style Attribute of Grid

Inline CSS to apply to the element.


@styleFile Attribute of Grid

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


@backgroundColor Attribute of Grid

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


@backgroundImage Attribute of Grid

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


@maxHeight Attribute of Grid

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


@maxWidth Attribute of Grid

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


@padding Attribute of Grid

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

Default value: 0


<Columns> Child of Grid

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
NameCardinality
ColumnAt least one
<Columns>'s attributes
NameValuesDefault
gutter0
Element's model:

(Column)+


@gutter Attribute of Columns

The pixel space between columns.

Default value: 0


<Column/> Child of 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
NameValuesDefault
width

This element is always empty.


@width Attribute of Column

The width of the column in pixels or percent.


<Rows> Child of Grid

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
NameCardinality
RowAt least one
<Rows>'s attributes
NameValuesDefault
gutter0
Element's model:

(Row)+


@gutter Attribute of Rows

The pixel space between rows.

Default value: 0


<Row> Child of 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
NameCardinality
AudioPlayerAny number
BannerAny number
ButtonAny number
CanvasAny number
ChromelessVideoPlayerAny number
ComboBoxAny number
ExpandingBannerAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
PlayheadAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
VideoDisplayAny number
VideoPlayerAny number
ViewStackAny number
VolumeControlAny number
<Row>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
padding0
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

(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)*


@height Attribute of Row

The height of the element in percent or pixels.


@id Attribute of Row

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.


@includeInLayout Attribute of Row

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

Default value: true


@visible Attribute of Row

Whether the component should be visible.

Default value: true


@width Attribute of Row

The width of the element in pixels or percent.


@x Attribute of Row

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


@y Attribute of Row

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


@theme Attribute of Row

The name of the theme to apply to the element.


@style Attribute of Row

Inline CSS to apply to the element.


@styleFile Attribute of Row

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


@backgroundColor Attribute of Row

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


@backgroundImage Attribute of Row

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


@gutter Attribute of Row

The pixel space between child elements.

Default value: 0


@hAlign Attribute of Row

Horizontal alignment.

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


@padding Attribute of Row

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

Default value: 0


@vAlign Attribute of Row

Vertical alignment.

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


<VBox> Child of TextRegion, Layout, MediaControls, Row, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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
NameCardinality
AudioPlayerAny number
BannerAny number
ButtonAny number
CanvasAny number
ChromelessVideoPlayerAny number
ComboBoxAny number
ExpandingBannerAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
PlayheadAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
VideoDisplayAny number
VideoPlayerAny number
ViewStackAny number
VolumeControlAny number
<VBox>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
maxHeight
maxWidth
padding0
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

(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)*


@height Attribute of VBox

The height of the element in percent or pixels.


@id Attribute of VBox

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.


@includeInLayout Attribute of VBox

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

Default value: true


@visible Attribute of VBox

Whether the component should be visible.

Default value: true


@width Attribute of VBox

The width of the element in pixels or percent.


@x Attribute of VBox

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


@y Attribute of VBox

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


@theme Attribute of VBox

The name of the theme to apply to the element.


@style Attribute of VBox

Inline CSS to apply to the element.


@styleFile Attribute of VBox

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


@backgroundColor Attribute of VBox

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


@backgroundImage Attribute of VBox

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


@gutter Attribute of VBox

The pixel space between child elements.

Default value: 0


@hAlign Attribute of VBox

Horizontal alignment.

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


@maxHeight Attribute of VBox

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


@maxWidth Attribute of VBox

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


@padding Attribute of VBox

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

Default value: 0


@vAlign Attribute of VBox

Vertical alignment.

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


<HBox> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, ChromelessControls, Canvas

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
NameCardinality
AudioPlayerAny number
BannerAny number
ButtonAny number
CanvasAny number
ChromelessVideoPlayerAny number
ComboBoxAny number
ExpandingBannerAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
PlayheadAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
VideoDisplayAny number
VideoPlayerAny number
ViewStackAny number
VolumeControlAny number
<HBox>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
maxHeight
maxWidth
padding0
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

(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)*


@height Attribute of HBox

The height of the element in percent or pixels.


@id Attribute of HBox

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.


@includeInLayout Attribute of HBox

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

Default value: true


@visible Attribute of HBox

Whether the component should be visible.

Default value: true


@width Attribute of HBox

The width of the element in pixels or percent.


@x Attribute of HBox

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


@y Attribute of HBox

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


@theme Attribute of HBox

The name of the theme to apply to the element.


@style Attribute of HBox

Inline CSS to apply to the element.


@styleFile Attribute of HBox

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


@backgroundColor Attribute of HBox

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


@backgroundImage Attribute of HBox

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


@gutter Attribute of HBox

The pixel space between child elements.

Default value: 0


@hAlign Attribute of HBox

Horizontal alignment.

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


@maxHeight Attribute of HBox

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


@maxWidth Attribute of HBox

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


@padding Attribute of HBox

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

Default value: 0


@vAlign Attribute of HBox

Vertical alignment.

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


<ViewStack> Child of TextRegion, Layout, MediaControls, Row, VBox, HBox, ChromelessControls, Canvas

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
NameCardinality
AudioPlayerAny number
BannerAny number
ButtonAny number
CanvasAny number
ChromelessVideoPlayerAny number
ComboBoxAny number
ExpandingBannerAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
PlayheadAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
VideoDisplayAny number
VideoPlayerAny number
ViewStackAny number
VolumeControlAny number
<ViewStack>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
height
idMatch the ID rules.
includeInLayouttrue
maxHeight
maxWidth
padding0
selectedIndex0
selectedItemID
style
styleFile
theme
visibletrue
width
x
y
Element's model:

(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)*


@height Attribute of ViewStack

The height of the element in percent or pixels.


@id Attribute of ViewStack

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.


@includeInLayout Attribute of ViewStack

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

Default value: true


@visible Attribute of ViewStack

Whether the component should be visible.

Default value: true


@width Attribute of ViewStack

The width of the element in pixels or percent.


@x Attribute of ViewStack

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


@y Attribute of ViewStack

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


@theme Attribute of ViewStack

The name of the theme to apply to the element.


@style Attribute of ViewStack

Inline CSS to apply to the element.


@styleFile Attribute of ViewStack

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


@backgroundColor Attribute of ViewStack

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


@backgroundImage Attribute of ViewStack

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


@maxHeight Attribute of ViewStack

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


@maxWidth Attribute of ViewStack

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


@padding Attribute of ViewStack

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

Default value: 0


@selectedIndex Attribute of ViewStack

The index in the stack of the visible child element.

Default value: 0


@selectedItemID Attribute of ViewStack

The BEML id of the visible child element.


<AudioPlayer/> Child of Layout, Row, VBox, ViewStack, HBox, Canvas

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

<AudioPlayer>'s attributes
NameValuesDefault
audioTrack
autoStarttrue, falsefalse
idMatch the ID rules.

This element is always empty.


@audioTrack Attribute of AudioPlayer

The audio track to play.


@autoStart Attribute of AudioPlayer

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

Possible values: true, false - Default value: false


@id Attribute of AudioPlayer

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.


<Banner/> Child of Layout, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

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
NameValuesDefault
alpha1
bannerFormats
blendModenormal
depth
enabledtrue
hAlignleft, center, rightcenter
height
idMatch the ID rules.
includeInLayouttrue
rotation0
scaleModenoScale, exactFit, showAll, scaleDown, noBordernoScale
source
style
styleFile
theme
tooltip
url
vAligntop, middle, bottommiddle
visibletrue
width
x
y

This element is always empty.


@height Attribute of Banner

The height of the element in percent or pixels.


@id Attribute of Banner

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.


@includeInLayout Attribute of Banner

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

Default value: true


@visible Attribute of Banner

Whether the component should be visible.

Default value: true


@width Attribute of Banner

The width of the element in pixels or percent.


@x Attribute of Banner

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


@y Attribute of Banner

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


@theme Attribute of Banner

The name of the theme to apply to the element.


@style Attribute of Banner

Inline CSS to apply to the element.


@styleFile Attribute of Banner

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


@alpha Attribute of Banner

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of Banner

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of Banner

The depth of the component in levels.


@enabled Attribute of Banner

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of Banner

The rotation of the component in degrees.

Default value: 0


@bannerFormats Attribute of Banner

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.


@hAlign Attribute of Banner

Horizontal alignment.

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


@scaleMode Attribute of Banner

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

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


@source Attribute of Banner

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


@tooltip Attribute of Banner

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


@url Attribute of Banner

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


@vAlign Attribute of Banner

Vertical alignment.

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


<Button/> Child of Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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

<Button>'s attributes
NameValuesDefault
accessibleName
alpha1
autoSizetrue, falsefalse
blendModenormal
click
data
depth
enabledtrue
font
height
iconAlignmentHright, center, leftcenter
iconAlignmentVtop, middle, bottommiddle
iconName
iconOffsetX0
iconOffsetY0
iconScale1
idMatch the ID rules.
includeInLayouttrue
label
labelAlignmentHleft, center, rightcenter
labelAlignmentVtop, middle, bottommiddle
labelBuffer0
labelOffsetX0
labelOffsetY0
lockHeighttrue, falsefalse
maxWidth
multilinetrue, falsefalse
rotation0
showBacktrue, falsetrue
size
style
styleFile
tabIndex
theme
tooltip
truncateLabeltrue, falsefalse
visibletrue
width
x
y

This element is always empty.


@height Attribute of Button

The height of the element in percent or pixels.


@id Attribute of Button

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.


@includeInLayout Attribute of Button

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

Default value: true


@visible Attribute of Button

Whether the component should be visible.

Default value: true


@width Attribute of Button

The width of the element in pixels or percent.


@x Attribute of Button

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


@y Attribute of Button

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


@theme Attribute of Button

The name of the theme to apply to the element.


@style Attribute of Button

Inline CSS to apply to the element


@styleFile Attribute of Button

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


@alpha Attribute of Button

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of Button

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of Button

The depth of the component in levels.


@enabled Attribute of Button

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of Button

The rotation of the component in degrees.

Default value: 0


@autoSize Attribute of Button

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

Possible values: true, false - Default value: false


@click Attribute of Button

The function to call when the button is clicked.


@data Attribute of Button

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


@font Attribute of Button

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


@iconAlignmentH Attribute of Button

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

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


@iconAlignmentV Attribute of Button

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

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


@iconOffsetX Attribute of Button

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

Default value: 0


@iconOffsetY Attribute of Button

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

Default value: 0


@iconName Attribute of Button

The name of icon to use for the button.


@iconScale Attribute of Button

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

Default value: 1


@label Attribute of Button

The text to display on the button.


@labelAlignmentH Attribute of Button

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

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


@labelAlignmentV Attribute of Button

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

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


@labelBuffer Attribute of Button

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

Default value: 0


@labelOffsetX Attribute of Button

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

Default value: 0


@labelOffsetY Attribute of Button

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

Default value: 0


@lockHeight Attribute of Button

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


@maxWidth Attribute of Button

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


@multiline Attribute of Button

Whether the button label should display multiple lines of text.

Possible values: true, false - Default value: false


@showBack Attribute of Button

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


@size Attribute of Button

The size of the text to display, in points.


@tooltip Attribute of Button

The tooltip to display on rollover of the text.


@truncateLabel Attribute of Button

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

Possible values: true, false - Default value: false


@tabIndex Attribute of Button

The index of the element in the player tab order.


@accessibleName Attribute of Button

The text read by screenreader when element received focus.


<ChromelessVideoPlayer> Child of Layout, Row, VBox, ViewStack, HBox, Canvas

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
NameCardinality
ChromelessControlsOne or none
<ChromelessVideoPlayer>'s attributes
NameValuesDefault
alpha1
autoStarttrue, falsefalse
blendModenormal
compactViewThreshold320
depth
enabledtrue
height
hideControlsOnLoadtrue, falsefalse
idMatch the ID rules.
includeInLayouttrue
preventFullScreentrue, falsefalse
rotation0
style
styleFile
theme
useOverlayMenutrue, falsetrue
video
visibletrue
width
x
y
Element's model:

(ChromelessControls?)


@height Attribute of ChromelessVideoPlayer

The height of the element in percent or pixels.


@id Attribute of ChromelessVideoPlayer

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.


@includeInLayout Attribute of ChromelessVideoPlayer

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

Default value: true


@visible Attribute of ChromelessVideoPlayer

Whether the component should be visible.

Default value: true


@width Attribute of ChromelessVideoPlayer

The width of the element in pixels or percent.


@x Attribute of ChromelessVideoPlayer

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


@y Attribute of ChromelessVideoPlayer

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


@theme Attribute of ChromelessVideoPlayer

The name of the theme to apply to the element.


@style Attribute of ChromelessVideoPlayer

Inline CSS to apply to the element


@styleFile Attribute of ChromelessVideoPlayer

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


@alpha Attribute of ChromelessVideoPlayer

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of ChromelessVideoPlayer

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of ChromelessVideoPlayer

The depth of the component in levels.


@enabled Attribute of ChromelessVideoPlayer

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of ChromelessVideoPlayer

The rotation of the component in degrees.

Default value: 0


@autoStart Attribute of ChromelessVideoPlayer

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

Possible values: true, false - Default value: false


@preventFullScreen Attribute of ChromelessVideoPlayer

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

Possible values: true, false - Default value: false


@video Attribute of ChromelessVideoPlayer

The videoDTO currently loaded into the video player


@compactViewThreshold Attribute of ChromelessVideoPlayer

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

Default value: 320


@hideControlsOnLoad Attribute of ChromelessVideoPlayer

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

Possible values: true, false - Default value: false


@useOverlayMenu Attribute of ChromelessVideoPlayer

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

Possible values: true, false - Default value: true


<ChromelessControls> Child of ChromelessVideoPlayer

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

<ChromelessControls>'s children
NameCardinality
BannerAny number
ButtonAny number
CanvasAny number
ComboBoxAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
ListAny number
LiveButtonAny number
MediaControlsAny number
SpacerAny number
SWFLoaderAny number
TabBarAny number
TextRegionAny number
ThumbnailButtonAny number
TileListAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
ViewStackAny number
VolumeControlAny number
<ChromelessControls>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
boxTypevbox, hbox
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
padding0
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

(ViewStack | Canvas | HBox | VBox | Grid | MediaControls | TextRegion | GraphicBlock | Label | Image | Link | Button | LiveButton | ToggleButton | ThumbnailButton | TitleLabel | ComboBox | List | TileList | TabBar | Banner | Spacer | SWFLoader | VolumeControl)*


@height Attribute of ChromelessControls

The height of the element in percent or pixels.


@id Attribute of ChromelessControls

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.


@includeInLayout Attribute of ChromelessControls

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

Default value: true


@visible Attribute of ChromelessControls

Whether the component should be visible.

Default value: true


@width Attribute of ChromelessControls

The width of the element in pixels or percent.


@x Attribute of ChromelessControls

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


@y Attribute of ChromelessControls

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


@theme Attribute of ChromelessControls

The name of the theme to apply to the element.


@style Attribute of ChromelessControls

Inline CSS to apply to the element.


@styleFile Attribute of ChromelessControls

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


@backgroundColor Attribute of ChromelessControls

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


@backgroundImage Attribute of ChromelessControls

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


@boxType Attribute of ChromelessControls

The type of layout box.

Possible values: vbox, hbox


@gutter Attribute of ChromelessControls

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

Default value: 0


@hAlign Attribute of ChromelessControls

Horizontal alignment.

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


@padding Attribute of ChromelessControls

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

Default value: 0


@vAlign Attribute of ChromelessControls

Vertical alignment.

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


<ComboBox> Child of Layout, MediaControls, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

Renders a drop down list of scrollable items.

<ComboBox>'s children
NameCardinality
dataOne or none
<ComboBox>'s attributes
NameValuesDefault
accessibleName
alpha1
animatedtrue, falsetrue
blendModenormal
data
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
itemInsetH0
itemInsetV0
itemLeading0
label
labelBufferLeft6
labelBufferRight16
labelBufferTop1
labelFieldlabel
noInitialSelectiontrue, falsefalse
numRows5
rotation0
rowHeight22
scrollerInset0
scrollerWidth23
style
styleFile
tabIndex
theme
useComboOverlaytrue, falsefalse
visibletrue
width
x
y
Element's model:

(data?)


@height Attribute of ComboBox

The height of the element in percent or pixels.


@id Attribute of ComboBox

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.


@includeInLayout Attribute of ComboBox

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

Default value: true


@visible Attribute of ComboBox

Whether the component should be visible.

Default value: true


@width Attribute of ComboBox

The width of the element in pixels or percent.


@x Attribute of ComboBox

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


@y Attribute of ComboBox

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


@theme Attribute of ComboBox

The name of the theme to apply to the element.


@style Attribute of ComboBox

Inline CSS to apply to the element.


@styleFile Attribute of ComboBox

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


@alpha Attribute of ComboBox

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of ComboBox

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of ComboBox

The depth of the component in levels.


@enabled Attribute of ComboBox

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of ComboBox

The rotation of the component in degrees.

Default value: 0


@animated Attribute of ComboBox

Whether the list should animate when opening.

Possible values: true, false - Default value: true


@data Attribute of ComboBox

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.


@itemInsetH Attribute of ComboBox

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

Default value: 0


@itemInsetV Attribute of ComboBox

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

Default value: 0


@itemLeading Attribute of ComboBox

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

Default value: 0


@label Attribute of ComboBox

The text that should display when no item is selected.


@labelBufferLeft Attribute of ComboBox

The pixel buffer to the left of the label.

Default value: 6


@labelBufferRight Attribute of ComboBox

The pixel buffer to the right of the label.

Default value: 16


@labelBufferTop Attribute of ComboBox

The pixel buffer to the top of the label.

Default value: 1


@labelField Attribute of ComboBox

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

Default value: label


@noInitialSelection Attribute of ComboBox

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


@numRows Attribute of ComboBox

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

Default value: 5


@rowHeight Attribute of ComboBox

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

Default value: 22


@scrollerInset Attribute of ComboBox

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

Default value: 0


@scrollerWidth Attribute of ComboBox

The width in pixels of the vertical scrollbar.

Default value: 23


@tabIndex Attribute of ComboBox

The index of the element in the player tab order.


@accessibleName Attribute of ComboBox

The text read by screenreader when element received focus.


@useComboOverlay Attribute of ComboBox

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

Possible values: true, false - Default value: false


<data> Child of ComboBox

The data provider for a ComboBox

<data>'s children
NameCardinality
StringAny number
Element's model:

(String)*


<String> Child of data

The String datatype for use in list item data.


<ExpandingBanner/> Child of Layout, Row, VBox, ViewStack, HBox, Canvas

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
NameValuesDefault
alpha1
animationTypefade, expandexpand
bannerFormats
blendModenormal
buttonHeight10
buttonWidth60
collapsedHAlignleft, center, rightleft
collapsedVAligntop, middle, bottomtop
depth
disableOnExpand
enabledtrue
expandDirectionup, downup
expandedHeight250
expandedOffsetX0
expandedOffsetY0
expandedWidth-1
height
idMatch the ID rules.
includeInLayouttrue
rotation0
showButtonstrue, falsetrue
style
styleFile
theme
visibletrue
width
x
y

This element is always empty.


@height Attribute of ExpandingBanner

The height of the element in percent or pixels.


@id Attribute of ExpandingBanner

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.


@includeInLayout Attribute of ExpandingBanner

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

Default value: true


@visible Attribute of ExpandingBanner

Whether the component should be visible.

Default value: true


@width Attribute of ExpandingBanner

The width of the element in pixels or percent.


@x Attribute of ExpandingBanner

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


@y Attribute of ExpandingBanner

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


@theme Attribute of ExpandingBanner

The name of the theme to apply to the element.


@style Attribute of ExpandingBanner

Inline CSS to apply to the element


@styleFile Attribute of ExpandingBanner

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


@alpha Attribute of ExpandingBanner

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of ExpandingBanner

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of ExpandingBanner

The depth of the component in levels.


@enabled Attribute of ExpandingBanner

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of ExpandingBanner

The rotation of the component in degrees.

Default value: 0


@animationType Attribute of ExpandingBanner

How the banner animates when it expands or collapses.

Possible values: fade, expand - Default value: expand


@bannerFormats Attribute of ExpandingBanner

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.


@buttonHeight Attribute of ExpandingBanner

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

Default value: 10


@buttonWidth Attribute of ExpandingBanner

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

Default value: 60


@collapsedHAlign Attribute of ExpandingBanner

The horizontal alignment of the collapsed image within its dimensions.

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


@collapsedVAlign Attribute of ExpandingBanner

The vertical alignment of the collapsed image within its dimensions.

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


@disableOnExpand Attribute of ExpandingBanner

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


@expandDirection Attribute of ExpandingBanner

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

Possible values: up, down - Default value: up


@expandedHeight Attribute of ExpandingBanner

The height in pixels of the expanded unit.

Default value: 250


@expandedOffsetX Attribute of ExpandingBanner

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


@expandedOffsetY Attribute of ExpandingBanner

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


@expandedWidth Attribute of ExpandingBanner

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

Default value: -1


@showButtons Attribute of ExpandingBanner

Whether the expand/collapse buttons are visible.

Possible values: true, false - Default value: true


<GraphicBlock/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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

<GraphicBlock>'s attributes
NameValuesDefault
alpha1
blendModenormal
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
rotation0
style
styleFile
theme
visibletrue
width
x
y

This element is always empty.


@height Attribute of GraphicBlock

The height of the element in percent or pixels.


@id Attribute of GraphicBlock

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.


@includeInLayout Attribute of GraphicBlock

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

Default value: true


@visible Attribute of GraphicBlock

Whether the component should be visible.

Default value: true


@width Attribute of GraphicBlock

The width of the element in pixels or percent.


@x Attribute of GraphicBlock

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


@y Attribute of GraphicBlock

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


@theme Attribute of GraphicBlock

The name of the theme to apply to the element.


@style Attribute of GraphicBlock

Inline CSS to apply to the element.


@styleFile Attribute of GraphicBlock

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


@alpha Attribute of GraphicBlock

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of GraphicBlock

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of GraphicBlock

The depth of the component in levels.


@enabled Attribute of GraphicBlock

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of GraphicBlock

The rotation of the component in degrees.

Default value: 0


<Image/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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
NameValuesDefault
accessibleName
alpha1
blendModenormal
click
data
depth
enabledtrue
hAlignleft, center, rightcenter
height
idMatch the ID rules.
includeInLayouttrue
rotation0
scaleModenoScale, exactFit, showAll, scaleDown, noBorderexactFit
source
style
styleFile
tabIndex
theme
tooltip
url
vAligntop, middle, bottommiddle
visibletrue
width
x
y

This element is always empty.


@height Attribute of Image

The height of the element in percent or pixels.


@id Attribute of Image

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.


@includeInLayout Attribute of Image

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

Default value: true


@visible Attribute of Image

Whether the component should be visible.

Default value: true


@width Attribute of Image

The width of the element in pixels or percent.


@x Attribute of Image

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


@y Attribute of Image

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


@theme Attribute of Image

The name of the theme to apply to the element.


@style Attribute of Image

Inline CSS to apply to the element


@styleFile Attribute of Image

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


@alpha Attribute of Image

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of Image

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of Image

The depth of the component in levels.


@enabled Attribute of Image

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of Image

The rotation of the component in degrees.

Default value: 0


@click Attribute of Image

The function to call when the button is clicked.


@data Attribute of Image

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


@hAlign Attribute of Image

Horizontal alignment.

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


@scaleMode Attribute of Image

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

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


@source Attribute of Image

The path to the image to load.


@tooltip Attribute of Image

The tooltip to display on rollover of the image.


@url Attribute of Image

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


@vAlign Attribute of Image

Vertical alignment.

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


@tabIndex Attribute of Image

The index of the element in the player tab order.


@accessibleName Attribute of Image

The text read by screenreader when element received focus.


<Label/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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
NameValuesDefault
alpha1
autoSizetrue, falsefalse
blendModenormal
color
depth
enabledtrue
font
hAlignleft, center, rightleft
height
htmlEnabledtrue, falsefalse
idMatch the ID rules.
includeInLayouttrue
multilinetrue, falsefalse
resizetrue, falsefalse
rotation0
size
style
styleFile
tabIndex
text
theme
translationText
truncatetrue, falsefalse
typebody, title, linkbody
underlinetrue, falsefalse
vAligntop, middle, bottomtop
visibletrue
width
x
y

This element is always empty.


@height Attribute of Label

The height of the element in percent or pixels.


@id Attribute of Label

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.


@includeInLayout Attribute of Label

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

Default value: true


@visible Attribute of Label

Whether the component should be visible.

Default value: true


@width Attribute of Label

The width of the element in pixels or percent.


@x Attribute of Label

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


@y Attribute of Label

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


@theme Attribute of Label

The name of the theme to apply to the element.


@style Attribute of Label

Inline CSS to apply to the element


@styleFile Attribute of Label

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


@alpha Attribute of Label

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of Label

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of Label

The depth of the component in levels.


@enabled Attribute of Label

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of Label

The rotation of the component in degrees.

Default value: 0


@color Attribute of Label

The color of the text to display.


@font Attribute of Label

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


@hAlign Attribute of Label

Horizontal alignment.

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


@htmlEnabled Attribute of Label

Whether the label should render HTML text.

Possible values: true, false - Default value: false


@multiline Attribute of Label

Whether the label should display multiple lines of text.

Possible values: true, false - Default value: false


@resize Attribute of Label

Deprecated.

Possible values: true, false - Default value: false


@autoSize Attribute of Label

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

Possible values: true, false - Default value: false


@size Attribute of Label

The size of the text, in points.


@text Attribute of Label

The text of the label.


@translationText Attribute of Label

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


@truncate Attribute of Label

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

Possible values: true, false - Default value: false


@type Attribute of Label

A type which corresponds to the desired style to apply.

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


@underline Attribute of Label

Whether the text should be underlined.

Possible values: true, false - Default value: false


@vAlign Attribute of Label

Vertical alignment.

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


@tabIndex Attribute of Label

The index of the element in the player tab order.


<Link/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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

<Link>'s attributes
NameValuesDefault
alpha1
blendModenormal
click
data
depth
enabledtrue
font
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
multilinetrue, falsefalse
rotation0
size
style
styleFile
tabIndex
text
theme
tooltip
url
vAligntop, middle, bottomtop
visibletrue
width
x
y

This element is always empty.


@height Attribute of Link

The height of the element in percent or pixels.


@id Attribute of Link

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.


@includeInLayout Attribute of Link

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

Default value: true


@visible Attribute of Link

Whether the component should be visible.

Default value: true


@width Attribute of Link

The width of the element in pixels or percent.


@x Attribute of Link

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


@y Attribute of Link

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


@theme Attribute of Link

The name of the theme to apply to the element.


@style Attribute of Link

Inline CSS to apply to the element


@styleFile Attribute of Link

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


@alpha Attribute of Link

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of Link

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of Link

The depth of the component in levels.


@enabled Attribute of Link

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of Link

The rotation of the component in degrees.

Default value: 0


@click Attribute of Link

The function to call when the link is clicked.


@data Attribute of Link

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


@font Attribute of Link

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


@hAlign Attribute of Link

Horizontal alignment.

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


@multiline Attribute of Link

Whether the link should display multiple lines of text.

Possible values: true, false - Default value: false


@size Attribute of Link

The size of the link text, in points.


@text Attribute of Link

The text of the link.


@tooltip Attribute of Link

The tooltip to display on rollover of the image.


@url Attribute of Link

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


@vAlign Attribute of Link

Vertical alignment.

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


@tabIndex Attribute of Link

The index of the element in the player tab order.


<List> Child of Layout, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

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
NameCardinality
ListItemOnly one
<List>'s attributes
NameValuesDefault
alpha1
automaticAdvancetrue, falsefalse
blendModenormal
data
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
itemInsetH3
itemInsetV4
itemLeading3
noInitialSelectiontrue, falsefalse
noSelecttrue, falsefalse
rotation0
rowHeight50
scrollerInset3
scrollerWidth13
selectOnClicktrue, falsefalse
showBacktrue, falsetrue
style
styleFile
theme
visibletrue
width
x
y
Element's model:

(ListItem)


@height Attribute of List

The height of the element in percent or pixels.


@id Attribute of List

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.


@includeInLayout Attribute of List

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

Default value: true


@visible Attribute of List

Whether the component should be visible.

Default value: true


@width Attribute of List

The width of the element in pixels or percent.


@x Attribute of List

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


@y Attribute of List

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


@theme Attribute of List

The name of the theme to apply to the element.


@style Attribute of List

Inline CSS to apply to the element.


@styleFile Attribute of List

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


@alpha Attribute of List

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of List

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of List

The depth of the component in levels.


@enabled Attribute of List

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of List

The rotation of the component in degrees.

Default value: 0


@automaticAdvance Attribute of List

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

Possible values: true, false - Default value: false


@data Attribute of List

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.


@itemInsetH Attribute of List

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

Default value: 3


@itemInsetV Attribute of List

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

Default value: 4


@itemLeading Attribute of List

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

Default value: 3


@noInitialSelection Attribute of List

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


@noSelect Attribute of List

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


@rowHeight Attribute of List

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

Default value: 50


@scrollerInset Attribute of List

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

Default value: 3


@scrollerWidth Attribute of List

The width in pixels of the vertical scrollbar.

Default value: 13


@selectOnClick Attribute of List

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

Possible values: true, false - Default value: false


@showBack Attribute of List

Deprecated.

Possible values: true, false - Default value: true


<ListItem> Child of TileList, List

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
NameCardinality
ButtonAny number
CanvasAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
SpacerAny number
SWFLoaderAny number
ThumbnailButtonAny number
TitleLabelAny number
VBoxAny number
<ListItem>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
boxTypevbox, hbox
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
padding0
showBacktrue, falsetrue
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

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


@height Attribute of ListItem

The height of the element in percent or pixels.


@id Attribute of ListItem

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.


@includeInLayout Attribute of ListItem

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

Default value: true


@visible Attribute of ListItem

Whether the component should be visible.

Default value: true


@width Attribute of ListItem

The width of the element in pixels or percent.


@x Attribute of ListItem

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


@y Attribute of ListItem

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


@theme Attribute of ListItem

The name of the theme to apply to the element.


@style Attribute of ListItem

Inline CSS to apply to the element.


@styleFile Attribute of ListItem

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


@backgroundColor Attribute of ListItem

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


@backgroundImage Attribute of ListItem

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


@boxType Attribute of ListItem

The type of layout box.

Possible values: vbox, hbox


@gutter Attribute of ListItem

The pixel space between child elements.

Default value: 0


@hAlign Attribute of ListItem

Horizontal alignment.

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


@vAlign Attribute of ListItem

Vertical alignment.

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


@padding Attribute of ListItem

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

Default value: 0


@showBack Attribute of ListItem

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


<MediaControls> Child of Layout, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

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

<MediaControls>'s children
NameCardinality
ButtonAny number
CanvasAny number
ComboBoxAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
LiveButtonAny number
PlayheadAny number
SpacerAny number
SWFLoaderAny number
TitleLabelAny number
ToggleButtonAny number
VBoxAny number
ViewStackAny number
VolumeControlAny number
<MediaControls>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
boxTypevbox, hbox
depth
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
padding0
showBacktrue, falsetrue
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

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


@height Attribute of MediaControls

The height of the element in percent or pixels.


@id Attribute of MediaControls

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.


@includeInLayout Attribute of MediaControls

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

Default value: true


@visible Attribute of MediaControls

Whether the component should be visible.

Default value: true


@width Attribute of MediaControls

The width of the element in pixels or percent.


@x Attribute of MediaControls

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


@y Attribute of MediaControls

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


@theme Attribute of MediaControls

The name of the theme to apply to the element.


@style Attribute of MediaControls

Inline CSS to apply to the element.


@styleFile Attribute of MediaControls

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


@backgroundColor Attribute of MediaControls

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


@backgroundImage Attribute of MediaControls

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


@boxType Attribute of MediaControls

The type of layout box.

Possible values: vbox, hbox


@depth Attribute of MediaControls

The depth of the component in levels.


@gutter Attribute of MediaControls

The pixel space between child elements.

Default value: 0


@hAlign Attribute of MediaControls

Horizontal alignment.

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


@vAlign Attribute of MediaControls

Vertical alignment.

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


@padding Attribute of MediaControls

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

Default value: 0


@showBack Attribute of MediaControls

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


<Playhead/> Child of MediaControls, Row, VBox, ViewStack, HBox, Canvas

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

<Playhead>'s attributes
NameValuesDefault
accessibleName
alpha1
autohideSlidertrue, falsetrue
blendModenormal
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
mediaController
rotation0
sliderWidth20
style
styleFile
tabIndex
theme
useTimeToolTiptrue, falsefalse
visibletrue
width
x
y

This element is always empty.


@height Attribute of Playhead

The height of the element in percent or pixels.


@id Attribute of Playhead

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.


@includeInLayout Attribute of Playhead

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

Default value: true


@visible Attribute of Playhead

Whether the component should be visible.

Default value: true


@width Attribute of Playhead

The width of the element in pixels or percent.


@x Attribute of Playhead

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


@y Attribute of Playhead

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


@theme Attribute of Playhead

The name of the theme to apply to the element.


@style Attribute of Playhead

Inline CSS to apply to the element


@styleFile Attribute of Playhead

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


@alpha Attribute of Playhead

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of Playhead

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of Playhead

The depth of the component in levels.


@enabled Attribute of Playhead

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of Playhead

The rotation of the component in degrees.

Default value: 0


@mediaController Attribute of Playhead

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


@autohideSlider Attribute of Playhead

Whether the slider should only appear on rollover.

Possible values: true, false - Default value: true


@sliderWidth Attribute of Playhead

The width of the draggable slider in pixels.

Default value: 20


@useTimeToolTip Attribute of Playhead

Whether a tooltip with the time of the mouse position should appear on rollover.

Possible values: true, false - Default value: false


@tabIndex Attribute of Playhead

The index of the element in the player tab order.


@accessibleName Attribute of Playhead

The text read by screenreader when element received focus.


<Spacer/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

A formatting component that creates space between other elements.

<Spacer>'s attributes
NameValuesDefault
height
id
includeInLayouttrue
width

This element is always empty.


@id Attribute of Spacer

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


@height Attribute of Spacer

The height of the element in percent or pixels.


@width Attribute of Spacer

The width of the element in pixels or percent.


@includeInLayout Attribute of Spacer

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

Default value: true


<SWFLoader/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

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
NameValuesDefault
alpha1
blendModenormal
data
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
rotation0
source
style
styleFile
theme
visibletrue
width
x
y

This element is always empty.


@height Attribute of SWFLoader

The height of the element in percent or pixels.


@id Attribute of SWFLoader

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.


@includeInLayout Attribute of SWFLoader

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

Default value: true


@visible Attribute of SWFLoader

Whether the component should be visible.

Default value: true


@width Attribute of SWFLoader

The width of the element in pixels or percent.


@x Attribute of SWFLoader

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


@y Attribute of SWFLoader

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


@theme Attribute of SWFLoader

The name of the theme to apply to the element.


@style Attribute of SWFLoader

Inline CSS to apply to the element.


@styleFile Attribute of SWFLoader

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


@alpha Attribute of SWFLoader

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of SWFLoader

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of SWFLoader

The depth of the component in levels.


@enabled Attribute of SWFLoader

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of SWFLoader

The rotation of the component in degrees.

Default value: 0


@data Attribute of SWFLoader

Additional data that is passed to the loaded SWF.


@source Attribute of SWFLoader

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


<TabBar/> Child of Layout, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

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
NameValuesDefault
alpha1
autoSizeTabstrue, falsetrue
blendModenormal
data
depth
enabledtrue
height
hideSingleTabtrue, falsefalse
idMatch the ID rules.
includeInLayouttrue
includeMenutrue, falsetrue
labelBuffer6
labelFieldlabel
maxMenuRows8
menuItemInset5
menuRowHeight20
menuWidth160
rotation0
style
styleFile
tabAlignleft, center, rightleft
tabPadding-1
tabWidth60
theme
visibletrue
width
x
y

This element is always empty.


@height Attribute of TabBar

The height of the element in percent or pixels.


@id Attribute of TabBar

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.


@includeInLayout Attribute of TabBar

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

Default value: true


@visible Attribute of TabBar

Whether the component should be visible.

Default value: true


@width Attribute of TabBar

The width of the element in pixels or percent.


@x Attribute of TabBar

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


@y Attribute of TabBar

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


@theme Attribute of TabBar

The name of the theme to apply to the element.


@style Attribute of TabBar

Inline CSS to apply to the element.


@styleFile Attribute of TabBar

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


@alpha Attribute of TabBar

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of TabBar

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of TabBar

The depth of the component in levels.


@enabled Attribute of TabBar

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of TabBar

The rotation of the component in degrees.

Default value: 0


@autoSizeTabs Attribute of TabBar

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

Possible values: true, false - Default value: true


@data Attribute of TabBar

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.


@hideSingleTab Attribute of TabBar

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

Possible values: true, false - Default value: false


@includeMenu Attribute of TabBar

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

Possible values: true, false - Default value: true


@labelBuffer Attribute of TabBar

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

Default value: 6


@labelField Attribute of TabBar

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

Default value: label


@maxMenuRows Attribute of TabBar

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

Default value: 8


@menuItemInset Attribute of TabBar

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

Default value: 5


@menuRowHeight Attribute of TabBar

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

Default value: 20


@menuWidth Attribute of TabBar

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

Default value: 160


@tabAlign Attribute of TabBar

The horizontal alignment of tabs within the component.

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


@tabPadding Attribute of TabBar

The horizontal space between tabs, in pixels.

Default value: -1


@tabWidth Attribute of TabBar

The fixed width of a tab if autoSizeTabs is false.

Default value: 60


<TextRegion> Child of Layout, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

A layout container for text elements.

<TextRegion>'s children
NameCardinality
CanvasAny number
GraphicBlockAny number
GridAny number
HBoxAny number
ImageAny number
LabelAny number
LinkAny number
SpacerAny number
SWFLoaderAny number
TitleLabelAny number
VBoxAny number
ViewStackAny number
<TextRegion>'s attributes
NameValuesDefault
backgroundColor
backgroundImage
boxTypevbox, hbox
depth
gutter0
hAlignleft, center, rightleft
height
idMatch the ID rules.
includeInLayouttrue
padding0
showBacktrue, falsetrue
style
styleFile
theme
vAligntop, middle, bottomtop
visibletrue
width
x
y
Element's model:

(ViewStack | Canvas | HBox | VBox | Grid | GraphicBlock | Label | Image | Link | TitleLabel | Spacer | SWFLoader)*


@height Attribute of TextRegion

The height of the element in percent or pixels.


@id Attribute of TextRegion

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.


@includeInLayout Attribute of TextRegion

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

Default value: true


@visible Attribute of TextRegion

Whether the component should be visible.

Default value: true


@width Attribute of TextRegion

The width of the element in pixels or percent.


@x Attribute of TextRegion

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


@y Attribute of TextRegion

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


@theme Attribute of TextRegion

The name of the theme to apply to the element.


@style Attribute of TextRegion

Inline CSS to apply to the element.


@styleFile Attribute of TextRegion

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


@backgroundColor Attribute of TextRegion

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


@backgroundImage Attribute of TextRegion

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


@boxType Attribute of TextRegion

The type of layout box.

Possible values: vbox, hbox


@depth Attribute of TextRegion

The depth of the component in levels.


@gutter Attribute of TextRegion

The pixel space between child elements.

Default value: 0


@hAlign Attribute of TextRegion

Horizontal alignment.

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


@vAlign Attribute of TextRegion

Vertical alignment.

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


@padding Attribute of TextRegion

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

Default value: 0


@showBack Attribute of TextRegion

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


<ThumbnailButton/> Child of Layout, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

Displays an image. When the viewer moves the cursor over the image, the button displays a play icon.

<ThumbnailButton>'s attributes
NameValuesDefault
alpha1
blendModenormal
click
data
depth
enabledtrue
height
idMatch the ID rules.
imageInset0
includeInLayouttrue
rotation0
source
style
styleFile
theme
tooltip
visibletrue
width
x
y

This element is always empty.


@height Attribute of ThumbnailButton

The height of the element in percent or pixels.


@id Attribute of ThumbnailButton

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.


@includeInLayout Attribute of ThumbnailButton

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

Default value: true


@visible Attribute of ThumbnailButton

Whether the component should be visible.

Default value: true


@width Attribute of ThumbnailButton

The width of the element in pixels or percent.


@x Attribute of ThumbnailButton

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


@y Attribute of ThumbnailButton

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


@theme Attribute of ThumbnailButton

The name of the theme to apply to the element.


@style Attribute of ThumbnailButton

Inline CSS to apply to the element.


@styleFile Attribute of ThumbnailButton

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


@alpha Attribute of ThumbnailButton

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of ThumbnailButton

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of ThumbnailButton

The depth of the component in levels.


@enabled Attribute of ThumbnailButton

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of ThumbnailButton

The rotation of the component in degrees.

Default value: 0


@click Attribute of ThumbnailButton

The function to call when the button is clicked.


@data Attribute of ThumbnailButton

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


@source Attribute of ThumbnailButton

The path to the image to load.


@tooltip Attribute of ThumbnailButton

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


@imageInset Attribute of ThumbnailButton

The amount in pixels to inset the image within the button.

Default value: 0


<TileList> Child of Layout, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

A grid list with user-defined list items. A TileList contains ListItems, each of which can contain other components.

<TileList>'s children
NameCardinality
ListItemOnly one
<TileList>'s attributes
NameValuesDefault
alpha1
animationTypemove, fade, scale, nonemove
automaticAdvancetrue, falsefalse
blendModenormal
buttonOffsetX0
buttonOffsetY0
buttonSize30
centerContenttrue, falsetrue
columnGutter5
columnWidth50
contentInsetH0
contentInsetV0
data
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
noInitialSelectiontrue, falsefalse
noSelecttrue, falsefalse
numColumns-1
numRows-1
rotation0
rowGutter5
rowHeight50
scrollDirectionhorizontal, verticalhorizontal
selectOnClicktrue, falsetrue
style
styleFile
theme
useBlurtrue, falsefalse
visibletrue
width
x
y
Element's model:

(ListItem)


@height Attribute of TileList

The height of the element in percent or pixels.


@id Attribute of TileList

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.


@includeInLayout Attribute of TileList

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

Default value: true


@visible Attribute of TileList

Whether the component should be visible.

Default value: true


@width Attribute of TileList

The width of the element in pixels or percent.


@x Attribute of TileList

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


@y Attribute of TileList

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


@theme Attribute of TileList

The name of the theme to apply to the element.


@style Attribute of TileList

Inline CSS to apply to the element.


@styleFile Attribute of TileList

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


@alpha Attribute of TileList

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of TileList

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of TileList

The depth of the component in levels.


@enabled Attribute of TileList

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of TileList

The rotation of the component in degrees.

Default value: 0


@animationType Attribute of TileList

How the list animates its items when paging.

Possible values: move, fade, scale, none - Default value: move


@automaticAdvance Attribute of TileList

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

Possible values: true, false - Default value: false


@buttonOffsetX Attribute of TileList

The pixel position offset from center on the x axis for navigation buttons when the list is set to scroll vertically.

Default value: 0


@buttonOffsetY Attribute of TileList

The pixel position offset from center on the y axis for navigation buttons when the list is set to scroll horizontally.

Default value: 0


@buttonSize Attribute of TileList

The width and height in pixels of the navigation buttons.

Default value: 30


@centerContent Attribute of TileList

Whether content should be centered in the list.

Possible values: true, false - Default value: true


@columnGutter Attribute of TileList

The distance between columns, in pixels.

Default value: 5


@columnWidth Attribute of TileList

The width of each column, in pixels (defaults to 50).

Default value: 50


@contentInsetH Attribute of TileList

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

Default value: 0


@contentInsetV Attribute of TileList

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

Default value: 0


@data Attribute of TileList

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.


@noInitialSelection Attribute of TileList

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


@noSelect Attribute of TileList

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


@numColumns Attribute of TileList

The number of columns that should render in the list. Defaults to -1, which denotes that the size of the list determines the number of columns.

Default value: -1


@numRows Attribute of TileList

The number of rows that should render in the list. Defaults to -1, which denotes that the size of the list determines the number of rows.

Default value: -1


@rowHeight Attribute of TileList

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

Default value: 50


@rowGutter Attribute of TileList

The distance between rows, in pixels.

Default value: 5


@scrollDirection Attribute of TileList

Whether the list should scroll vertically or horizontally.

Possible values: horizontal, vertical - Default value: horizontal


@selectOnClick Attribute of TileList

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

Possible values: true, false - Default value: true


@useBlur Attribute of TileList

Whether the list should blur its items as it is animated, if the animationType is move.

Possible values: true, false - Default value: false


<TitleLabel/> Child of TextRegion, Layout, MediaControls, Row, VBox, ListItem, ViewStack, HBox, ChromelessControls, Canvas

The TitleLabel is similar to a Label component that can render a "selected" state. This is useful for lists where you need to distinguish the selected item.

<TitleLabel>'s attributes
NameValuesDefault
alpha1
autoSizetrue, falsefalse
blendModenormal
color
depth
enabledtrue
font
hAlignleft, center, rightleft
height
htmlEnabledtrue, falsefalse
idMatch the ID rules.
includeInLayouttrue
multilinetrue, falsefalse
resizetrue, falsefalse
rotation0
selectedtrue, falsefalse
size
style
styleFile
tabIndex
text
theme
truncatetrue, falsefalse
typebody, title, linktitle
vAligntop, middle, bottomtop
visibletrue
width
x
y

This element is always empty.


@height Attribute of TitleLabel

The height of the element in percent or pixels.


@id Attribute of TitleLabel

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.


@includeInLayout Attribute of TitleLabel

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

Default value: true


@visible Attribute of TitleLabel

Whether the component should be visible.

Default value: true


@width Attribute of TitleLabel

The width of the element in pixels or percent.


@x Attribute of TitleLabel

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


@y Attribute of TitleLabel

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


@theme Attribute of TitleLabel

The name of the theme to apply to the element.


@style Attribute of TitleLabel

Inline CSS to apply to the element.


@styleFile Attribute of TitleLabel

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


@alpha Attribute of TitleLabel

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of TitleLabel

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of TitleLabel

The depth of the component in levels.


@enabled Attribute of TitleLabel

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of TitleLabel

The rotation of the component in degrees.

Default value: 0


@color Attribute of TitleLabel

Deprecated.


@font Attribute of TitleLabel

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


@hAlign Attribute of TitleLabel

Horizontal alignment.

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


@htmlEnabled Attribute of TitleLabel

Deprecated.

Possible values: true, false - Default value: false


@multiline Attribute of TitleLabel

Whether the label should display multiple lines of text.

Possible values: true, false - Default value: false


@autoSize Attribute of TitleLabel

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

Possible values: true, false - Default value: false


@resize Attribute of TitleLabel

Deprecated.

Possible values: true, false - Default value: false


@selected Attribute of TitleLabel

Whether the item is in selected state.

Possible values: true, false - Default value: false


@size Attribute of TitleLabel

The size of the text, in points.


@text Attribute of TitleLabel

The text of the label.


@truncate Attribute of TitleLabel

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

Possible values: true, false - Default value: false


@type Attribute of TitleLabel

Deprecated.

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


@vAlign Attribute of TitleLabel

Vertical alignment.

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


@tabIndex Attribute of TitleLabel

The index of the element in the player tab order.


<ToggleButton/> Child of Layout, MediaControls, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

Defines a clickable graphic with a label that can broadcast events and toggle between two states.

<ToggleButton>'s attributes
NameValuesDefault
accessibleName
alpha1
autoSizetrue, falsefalse
blendModenormal
click
data
depth
enabledtrue
font
height
iconAlignmentHright, center, leftcenter
iconAlignmentVtop, middle, bottommiddle
iconName
iconOffsetX0
iconOffsetY0
iconScale1
idMatch the ID rules.
includeInLayouttrue
label
labelAlignmentHleft, center, rightcenter
labelAlignmentVtop, middle, bottommiddle
labelBuffer0
labelOffsetX0
labelOffsetY0
lockHeighttrue, falsefalse
maxWidth
multilinetrue, falsefalse
rotation0
showBacktrue, falsetrue
size
style
styleFile
tabIndex
theme
toggledfalse
toggledClick
toggledIconName
toggledLabel
toggledTooltip
tooltip
truncateLabeltrue, falsefalse
visibletrue
width
x
y

This element is always empty.


@height Attribute of ToggleButton

The height of the element in percent or pixels.


@id Attribute of ToggleButton

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.


@includeInLayout Attribute of ToggleButton

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

Default value: true


@visible Attribute of ToggleButton

Whether the component should be visible.

Default value: true


@width Attribute of ToggleButton

The width of the element in pixels or percent.


@x Attribute of ToggleButton

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


@y Attribute of ToggleButton

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


@theme Attribute of ToggleButton

The name of the theme to apply to the element.


@style Attribute of ToggleButton

Inline CSS to apply to the element


@styleFile Attribute of ToggleButton

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


@alpha Attribute of ToggleButton

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of ToggleButton

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of ToggleButton

The depth of the component in levels.


@enabled Attribute of ToggleButton

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of ToggleButton

The rotation of the component in degrees.

Default value: 0


@autoSize Attribute of ToggleButton

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

Possible values: true, false - Default value: false


@click Attribute of ToggleButton

The function to call when the button is clicked.


@data Attribute of ToggleButton

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


@font Attribute of ToggleButton

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


@iconAlignmentH Attribute of ToggleButton

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

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


@iconAlignmentV Attribute of ToggleButton

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

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


@iconOffsetX Attribute of ToggleButton

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

Default value: 0


@iconOffsetY Attribute of ToggleButton

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

Default value: 0


@iconName Attribute of ToggleButton

The name of icon to use for the button.


@iconScale Attribute of ToggleButton

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

Default value: 1


@label Attribute of ToggleButton

The text to display on the button.


@labelAlignmentH Attribute of ToggleButton

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

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


@labelAlignmentV Attribute of ToggleButton

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

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


@labelBuffer Attribute of ToggleButton

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

Default value: 0


@labelOffsetX Attribute of ToggleButton

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

Default value: 0


@labelOffsetY Attribute of ToggleButton

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

Default value: 0


@lockHeight Attribute of ToggleButton

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


@maxWidth Attribute of ToggleButton

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


@multiline Attribute of ToggleButton

Whether the button label should display multiple lines of text.

Possible values: true, false - Default value: false


@showBack Attribute of ToggleButton

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


@size Attribute of ToggleButton

The size of the text to display, in points.


@toggled Attribute of ToggleButton

Whether the button is toggled into its selected state, used with binding.

Default value: false


@toggledClick Attribute of ToggleButton

The function to call when the button is clicked when in toggled state.


@toggledIconName Attribute of ToggleButton

The name of icon to use for the button.


@toggledLabel Attribute of ToggleButton

The text to display on the button when in toggled state.


@toggledTooltip Attribute of ToggleButton

The tooltip to display on rollover of the text when in toggled state.


@tooltip Attribute of ToggleButton

The tooltip to display on rollover of the text.


@truncateLabel Attribute of ToggleButton

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

Possible values: true, false - Default value: false


@tabIndex Attribute of ToggleButton

The index of the element in the player tab order.


@accessibleName Attribute of ToggleButton

The text read by screenreader when element received focus.


<LiveButton/> Child of Layout, MediaControls, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

Defines a clickable graphic with a label that can broadcast events. The primary purpose of the LiveButton is to indicate to the user whether the player is in live or DVR mode. If in DVR mode, the button should be clickable to go to live mode.

<LiveButton>'s attributes
NameValuesDefault
accessibleName
alpha1
autoSizetrue, falsefalse
blendModenormal
click
data
depth
enabledtrue
font
height
iconAlignmentHright, center, leftcenter
iconAlignmentVtop, middle, bottommiddle
iconName
iconOffsetX0
iconOffsetY0
iconScale1
idMatch the ID rules.
includeInLayouttrue
label
labelAlignmentHleft, center, rightcenter
labelAlignmentVtop, middle, bottommiddle
labelBuffer0
labelOffsetX0
labelOffsetY0
lockHeighttrue, falsefalse
maxWidth
multilinetrue, falsefalse
rotation0
showBacktrue, falsetrue
size
style
styleFile
tabIndex
theme
tooltip
truncateLabeltrue, falsefalse
visibletrue
width
x
y

This element is always empty.


@height Attribute of LiveButton

The height of the element in percent or pixels.


@id Attribute of LiveButton

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.


@includeInLayout Attribute of LiveButton

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

Default value: true


@visible Attribute of LiveButton

Whether the component should be visible.

Default value: true


@width Attribute of LiveButton

The width of the element in pixels or percent.


@x Attribute of LiveButton

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


@y Attribute of LiveButton

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


@theme Attribute of LiveButton

The name of the theme to apply to the element.


@style Attribute of LiveButton

Inline CSS to apply to the element


@styleFile Attribute of LiveButton

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


@alpha Attribute of LiveButton

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of LiveButton

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of LiveButton

The depth of the component in levels.


@enabled Attribute of LiveButton

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of LiveButton

The rotation of the component in degrees.

Default value: 0


@autoSize Attribute of LiveButton

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

Possible values: true, false - Default value: false


@click Attribute of LiveButton

The action to perform when the component is clicked.


@data Attribute of LiveButton

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


@font Attribute of LiveButton

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


@iconAlignmentH Attribute of LiveButton

Sorry, no documentation.

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


@iconAlignmentV Attribute of LiveButton

Sorry, no documentation.

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


@iconOffsetX Attribute of LiveButton

Sorry, no documentation.

Default value: 0


@iconOffsetY Attribute of LiveButton

Sorry, no documentation.

Default value: 0


@iconName Attribute of LiveButton

Sorry, no documentation.


@iconScale Attribute of LiveButton

Sorry, no documentation.

Default value: 1


@label Attribute of LiveButton

The text to display on the button.


@labelAlignmentH Attribute of LiveButton

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

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


@labelAlignmentV Attribute of LiveButton

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

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


@labelBuffer Attribute of LiveButton

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

Default value: 0


@labelOffsetX Attribute of LiveButton

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

Default value: 0


@labelOffsetY Attribute of LiveButton

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

Default value: 0


@lockHeight Attribute of LiveButton

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


@maxWidth Attribute of LiveButton

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


@multiline Attribute of LiveButton

Whether the button label should display multiple lines of text.

Possible values: true, false - Default value: false


@showBack Attribute of LiveButton

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


@size Attribute of LiveButton

The size of the text to display, in points.


@tooltip Attribute of LiveButton

The tooltip to display on rollover of the text.


@truncateLabel Attribute of LiveButton

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

Possible values: true, false - Default value: false


@tabIndex Attribute of LiveButton

Sorry, no documentation.


@accessibleName Attribute of LiveButton

Sorry, no documentation.


<VideoDisplay/> Child of Layout, Row, VBox, ViewStack, HBox, Canvas

A video window without the standard media control bar. Controls appear when the viewer clicks in the video window.

<VideoDisplay>'s attributes
NameValuesDefault
alpha1
autoStarttrue, falsefalse
blendModenormal
depth
enabledtrue
height
idMatch the ID rules.
includeFullscreenControlstrue, falsefalse
includeInLayouttrue
rotation0
showBacktrue, falsefalse
style
styleFile
theme
togglePlaybackOnClicktrue, falsetrue
video
visibletrue
width
x
y

This element is always empty.


@height Attribute of VideoDisplay

The height of the element in percent or pixels.


@id Attribute of VideoDisplay

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.


@includeInLayout Attribute of VideoDisplay

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

Default value: true


@visible Attribute of VideoDisplay

Whether the component should be visible.

Default value: true


@width Attribute of VideoDisplay

The width of the element in pixels or percent.


@x Attribute of VideoDisplay

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


@y Attribute of VideoDisplay

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


@theme Attribute of VideoDisplay

The name of the theme to apply to the element.


@style Attribute of VideoDisplay

Inline CSS to apply to the element


@styleFile Attribute of VideoDisplay

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


@alpha Attribute of VideoDisplay

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of VideoDisplay

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of VideoDisplay

The depth of the component in levels.


@enabled Attribute of VideoDisplay

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of VideoDisplay

The rotation of the component in degrees.

Default value: 0


@autoStart Attribute of VideoDisplay

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

Possible values: true, false - Default value: false


@includeFullscreenControls Attribute of VideoDisplay

Whether the default Brightcove fullscreen controls are used.

Possible values: true, false - Default value: false


@togglePlaybackOnClick Attribute of VideoDisplay

Whether to toggle playback when the video window is clicked.

Possible values: true, false - Default value: true


@showBack Attribute of VideoDisplay

Whether a background graphic should render behind the video.

Possible values: true, false - Default value: false


@video Attribute of VideoDisplay

The videoDTO currently loaded into the video player


<VideoPlayer/> Child of Layout, Row, VBox, ViewStack, HBox, Canvas

A combination of a video window and a set of standard Brightcove media controls including a play/pause toggle, a timeline scrubber, volume controls, maximize controls and a menu access button.

<VideoPlayer>'s attributes
NameValuesDefault
alpha1
autoStarttrue, falsefalse
blendModenormal
depth
enabledtrue
height
idMatch the ID rules.
includeInLayouttrue
preventFullScreentrue, falsefalse
rotation0
style
styleFile
theme
video
visibletrue
width
x
y

This element is always empty.


@height Attribute of VideoPlayer

The height of the element in percent or pixels.


@id Attribute of VideoPlayer

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.


@includeInLayout Attribute of VideoPlayer

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

Default value: true


@visible Attribute of VideoPlayer

Whether the component should be visible.

Default value: true


@width Attribute of VideoPlayer

The width of the element in pixels or percent.


@x Attribute of VideoPlayer

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


@y Attribute of VideoPlayer

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


@theme Attribute of VideoPlayer

The name of the theme to apply to the element.


@style Attribute of VideoPlayer

Inline CSS to apply to the element.


@styleFile Attribute of VideoPlayer

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


@alpha Attribute of VideoPlayer

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of VideoPlayer

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of VideoPlayer

The depth of the component in levels.


@enabled Attribute of VideoPlayer

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of VideoPlayer

The rotation of the component in degrees.

Default value: 0


@autoStart Attribute of VideoPlayer

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

Possible values: true, false - Default value: false


@preventFullScreen Attribute of VideoPlayer

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

Possible values: true, false - Default value: false


@video Attribute of VideoPlayer

The videoDTO currently loaded into the video player.


<VolumeControl/> Child of MediaControls, Row, VBox, ViewStack, HBox, ChromelessControls, Canvas

Defines a button with a popup overlay to control muting and volume settings of media.

<VolumeControl>'s attributes
NameValuesDefault
accessibleName
alpha1
animatedtrue, falsetrue
blendModenormal
depth
directionup, down, autoauto
enabledtrue
height
horizontalPadding5
iconAlignmentHright, center, leftcenter
iconAlignmentVtop, middle, bottommiddle
iconName
iconOffsetX0
iconOffsetY0
iconScale1
idMatch the ID rules.
includeInLayouttrue
mediaController
mutedIconName
mutedTooltip
popupGutter0
popupHeight80
rotation0
showBacktrue, falsetrue
size
sliderHeight13
style
styleFile
tabIndex
theme
tooltip
useOverlayLayertrue, falsetrue
useZeroWidthtrue, falsefalse
verticalPadding3
visibletrue
width
x
y

This element is always empty.


@height Attribute of VolumeControl

The height of the element in percent or pixels.


@id Attribute of VolumeControl

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.


@includeInLayout Attribute of VolumeControl

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

Default value: true


@visible Attribute of VolumeControl

Whether the component should be visible.

Default value: true


@width Attribute of VolumeControl

The width of the element in pixels or percent.


@x Attribute of VolumeControl

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


@y Attribute of VolumeControl

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


@theme Attribute of VolumeControl

The name of the theme to apply to the element.


@style Attribute of VolumeControl

Inline CSS to apply to the element


@styleFile Attribute of VolumeControl

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


@alpha Attribute of VolumeControl

The opacity of the component between 0 and 1.

Default value: 1


@blendMode Attribute of VolumeControl

The ActionScript DisplayObject blend mode of the component.

Default value: normal


@depth Attribute of VolumeControl

The depth of the component in levels.


@enabled Attribute of VolumeControl

Whether a component will receive mouse events.

Default value: true


@rotation Attribute of VolumeControl

The rotation of the component in degrees.

Default value: 0


@animated Attribute of VolumeControl

Whether the list should animate when opening.

Possible values: true, false - Default value: true


@iconAlignmentH Attribute of VolumeControl

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

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


@iconAlignmentV Attribute of VolumeControl

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

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


@iconOffsetX Attribute of VolumeControl

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

Default value: 0


@iconOffsetY Attribute of VolumeControl

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

Default value: 0


@iconName Attribute of VolumeControl

The name of icon to use for the button when audio is audible.


@mediaController Attribute of VolumeControl

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


@mutedIconName Attribute of VolumeControl

The name of icon to use for the button when audio is muted.


@iconScale Attribute of VolumeControl

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

Default value: 1


@popupHeight Attribute of VolumeControl

The height of the popup control with volume slider.

Default value: 80


@sliderHeight Attribute of VolumeControl

The height of the volume slider in the popup.

Default value: 13


@horizontalPadding Attribute of VolumeControl

The horizontal padding around the controls in the popup.

Default value: 5


@verticalPadding Attribute of VolumeControl

The vertical padding around the controls in the popup.

Default value: 3


@showBack Attribute of VolumeControl

Whether the background of the graphic should be shown.

Possible values: true, false - Default value: true


@size Attribute of VolumeControl

Deprecated.


@tooltip Attribute of VolumeControl

The tooltip to display on rollover of control when audio is audible.


@mutedTooltip Attribute of VolumeControl

The tooltip to display on rollover of control when audio is muted.


@direction Attribute of VolumeControl

The direction the rollover popup should be placed in relation to the button

Possible values: up, down, auto - Default value: auto


@popupGutter Attribute of VolumeControl

The pixel space between the button and popup slider that appears on rollover.

Default value: 0


@useOverlayLayer Attribute of VolumeControl

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

Possible values: true, false - Default value: true


@useZeroWidth Attribute of VolumeControl

Whether the slider itself on the track is not rendered as a button, but appears hidden.

Possible values: true, false - Default value: false


@tabIndex Attribute of VolumeControl

The index of the element in the player tab order.


@accessibleName Attribute of VolumeControl

The text read by screenreader when element received focus.