beml_rt.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES
Brightcove BEML "Runtime"
| <Runtime> | Root element |
The root element.
Element's model:
<Runtime>'s children Name Cardinality Labels Any number Layout Any number Modules Any number Theme Any number
(Modules | Theme | Labels | Layout)+
| <Modules> | Child of Runtime |
top level nodes other than the Layout
Element's model:
<Modules>'s children Name Cardinality Module At least one
(Module)+
| <Module/> | Child of Modules |
Enables loading a custom module.
<Module>'s attributes Name Values Default file id
This element is always empty.
| @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.
| <Theme> | Child of Runtime |
Sets a theme and style for all visual components that allow for configurable themes and styles.
Element's model:
<Theme>'s children Name Cardinality Font Any number Style Any number
<Theme>'s attributes Name Values Default bodyFont linkFont name style titleFont
| @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 Name Values Default 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 |
The class of components to apply this style to.
| <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 Name Values Default 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.
Element's model:
<Labels>'s children Name Cardinality label Any number
<Labels>'s attributes Name Values Default file
(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 Name Values Default 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.
Element's model:
<Layout>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number
<Layout>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | MediaControls | TextRegion | Label | Image | Link | Button | 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.
| @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.
Possible values: vbox, hbox
| @gutter | Attribute of Layout |
The pixel space between child elements; only applicable if the boxType is "hbox" or "vbox."
| @hAlign | Attribute of Layout |
Horizontal alignment.
Possible values: left, center, right
| @padding | Attribute of Layout |
The pixel padding within the borders of the box, from which all positioning is made.
| @vAlign | Attribute of Layout |
Vertical alignment.
Possible values: top, middle, bottom
| <Canvas> | Child of HBox, Row, TextRegion, ListItem, VBox, Layout, MediaControls |
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.
Element's model:
<Canvas>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number
<Canvas>'s attributes Name Values Default backgroundColor backgroundImage height id Match the ID rules. padding style styleFile theme width x y
(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | 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.
| @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.
| @padding | Attribute of Canvas |
The pixel padding within the borders of the element, from which all positioning is made.
| <Grid> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
A layout box that allows for a more complex layout, with child elements laid out in columns and rows.
Element's model:
<Grid>'s children Name Cardinality Columns Only one Rows Only one
<Grid>'s attributes Name Values Default backgroundColor backgroundImage height id Match the ID rules. padding style styleFile theme width x y
| @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.
| @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.
| @padding | Attribute of Grid |
The pixel padding within the borders of the element, from which all positioning is made.
| <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.
Element's model:
<Columns>'s children Name Cardinality Column At least one
<Columns>'s attributes Name Values Default gutter
(Column)+
| @gutter | Attribute of Columns |
The pixel space between columns.
| <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 Name Values Default 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.
Element's model:
<Rows>'s children Name Cardinality Row At least one
<Rows>'s attributes Name Values Default gutter
(Row)+
| @gutter | Attribute of Rows |
The pixel space between rows.
| <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.
Element's model:
<Row>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number
<Row>'s attributes Name Values Default backgroundColor backgroundImage gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | 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.
| @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.
| @hAlign | Attribute of Row |
Horizontal alignment.
Possible values: left, center, right
| @padding | Attribute of Row |
The pixel padding within the borders of the row, from which all positioning is made.
| @vAlign | Attribute of Row |
Vertical alignment.
Possible values: top, middle, bottom
| <VBox> | Child of HBox, Row, Canvas, TextRegion, ListItem, Layout, MediaControls |
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.
Element's model:
<VBox>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number
<VBox>'s attributes Name Values Default backgroundColor backgroundImage gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | 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.
| @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.
| @hAlign | Attribute of VBox |
Horizontal alignment.
Possible values: left, center, right
| @padding | Attribute of VBox |
The pixel padding within the borders of the box, from which all positioning is made.
| @vAlign | Attribute of VBox |
Vertical alignment.
Possible values: top, middle, bottom
| <HBox> | Child of Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
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.
Element's model:
<HBox>'s children Name Cardinality Banner Any number Button Any number Canvas Any number ComboBox Any number ExpandingBanner Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number List Any number MediaControls Any number Playhead Any number Spacer Any number SWFLoader Any number TabBar Any number TextRegion Any number ThumbnailButton Any number TileList Any number TitleLabel Any number ToggleButton Any number VBox Any number VideoDisplay Any number VideoPlayer Any number VolumeControl Any number
<HBox>'s attributes Name Values Default backgroundColor backgroundImage gutter hAlign left, center, right height id Match the ID rules. padding style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | VideoPlayer | VideoDisplay | MediaControls | TextRegion | Playhead | VolumeControl | Label | Image | Link | Button | 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.
| @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.
| @hAlign | Attribute of HBox |
Horizontal alignment.
Possible values: left, center, right
| @padding | Attribute of HBox |
The pixel padding within the borders of the box, from which all positioning is made.
| @vAlign | Attribute of HBox |
Vertical alignment.
Possible values: top, middle, bottom
| <Banner/> | Child of HBox, Row, Canvas, VBox, Layout |
The Banner plugs into the advertising capabilities in a player. When a Banner element is included, a new format is allowed and are appended to all ad server calls, informing the ad server that a banner can be displayed. The size of the banner dictates the ad format supported, so a 468x60 banner element by default supports a 468x60 banner ad format. Additional ad formats can be specified as well, so that you can use a large banner area to support several smaller sizes of banner. How those banners are scaled and aligned within the larger area is controlled by the Banner's attributes.
<Banner>'s attributes Name Values Default alpha bannerFormats blendMode depth hAlign left, center, right height id Match the ID rules. rotation scaleMode noScale, exactFit, showAll, scaleDown, noBorder source style styleFile theme tooltip url vAlign top, middle, bottom visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of Banner |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of Banner |
The depth of the component in levels.
| @rotation | Attribute of Banner |
The rotation of the component in degrees.
| @visible | Attribute of Banner |
Whether the component should be visible.
| @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
| @scaleMode | Attribute of Banner |
How the Banner image should be scaled within the dimensions of the element.
Possible values: noScale, exactFit, showAll, scaleDown, noBorder
| @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
| <Button/> | Child of HBox, Row, Canvas, ListItem, VBox, Layout, MediaControls |
Defines a clickable graphic with a label that can broadcast events.
<Button>'s attributes Name Values Default alpha autoSize true, false blendMode click data depth font height iconAlignmentH right, center, left iconAlignmentV top, middle, bottom iconName iconOffsetX iconOffsetY iconScale id Match the ID rules. label labelAlignmentH left, center, right labelAlignmentV top, middle, bottom labelBuffer labelOffsetX labelOffsetY lockHeight true, false maxWidth multiline true, false rotation showBack true, false size style styleFile theme tooltip truncateLabel true, false visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of Button |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of Button |
The depth of the component in levels.
| @rotation | Attribute of Button |
The rotation of the component in degrees.
| @visible | Attribute of Button |
Whether the component should be visible.
| @autoSize | Attribute of Button |
Whether the button should automatically resize based on the amount of text.
Possible values: true, 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
| @iconAlignmentV | Attribute of Button |
The vertical alignment of the icon within the button's dimensions.
Possible values: top, middle, bottom
| @iconOffsetX | Attribute of Button |
The pixel offset on the x axis to apply to the icon.
| @iconOffsetY | Attribute of Button |
The pixel offset on the y axis to apply to the icon.
| @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.
| @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
| @labelAlignmentV | Attribute of Button |
The vertical alignment of the label within the button's dimensions.
Possible values: top, middle, bottom
| @labelBuffer | Attribute of Button |
The distance in pixels between the edge of the button and its label.
| @labelOffsetX | Attribute of Button |
The pixel offset on the x axis to apply to the label.
| @labelOffsetY | Attribute of Button |
The pixel offset on the y axis to apply to the label.
| @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
| @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
| @showBack | Attribute of Button |
Whether the background of the graphic should be shown.
Possible values: true, false
| @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
| <ComboBox> | Child of HBox, Row, Canvas, VBox, Layout |
Renders a drop down list of scrollable items.
Element's model:
<ComboBox>'s children Name Cardinality data One or none
<ComboBox>'s attributes Name Values Default alpha animated true, false blendMode data depth height id Match the ID rules. itemInsetH itemInsetV itemLeading label labelBufferLeft labelBufferRight labelBufferTop labelField noInitialSelection numRows rotation rowHeight scrollerInset scrollerWidth style styleFile theme visible width x y
(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.
| @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.
| @blendMode | Attribute of ComboBox |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of ComboBox |
The depth of the component in levels.
| @rotation | Attribute of ComboBox |
The rotation of the component in degrees.
| @visible | Attribute of ComboBox |
Whether the component should be visible.
| @animated | Attribute of ComboBox |
Whether the list should animate when opening.
Possible values: true, false
| @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.
| @itemInsetV | Attribute of ComboBox |
The amount in pixels that items within the list are inset vertically from the borders of the list.
| @itemLeading | Attribute of ComboBox |
The vertical space in pixels between each item (defaults to 5).
| @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.
| @labelBufferRight | Attribute of ComboBox |
The pixel buffer to the right of the label.
| @labelBufferTop | Attribute of ComboBox |
The pixel buffer to the top of the label.
| @labelField | Attribute of ComboBox |
The property of the list item that should be used for the item label.
| @noInitialSelection | Attribute of ComboBox |
Whether the first item in the list should be in a selected state when the list is initially rendered.
| @numRows | Attribute of ComboBox |
The maximum number of rows that should display when the list is opened.
| @rowHeight | Attribute of ComboBox |
The height of each row in pixels (defaults to 50).
| @scrollerInset | Attribute of ComboBox |
The amount in pixels that the vertical scrollbar is inset horizontally from the borders of the list.
| @scrollerWidth | Attribute of ComboBox |
The width in pixels of the vertical scrollbar.
| <data> | Child of ComboBox |
The data provider for a ComboBox
Element's model:
<data>'s children Name Cardinality String Any number
(String)*
| <String> | Child of data |
The String datatype for use in list item data.
| <ExpandingBanner/> | Child of HBox, Row, Canvas, VBox, Layout |
The ExpandingBanner plugs into the advertising capabilities in a player. When an Expanding Banner element is included, two new formats are allowed and are appended all ad server calls informing the ad server that a banner can be displayed. The size of the banner dictates the ad formats supported, so a 468x60 banner element by default supports a 468x60 banner ad format and a 468x60 synched banner unit. Additional ad formats can be specified as well, so that a large banner area can actually be made to support several smaller sizes of banner. How those banners are scaled and aligned within the larger area is controlled by the ExpandingBanner's attributes.
<ExpandingBanner>'s attributes Name Values Default alpha animationType fade, expand bannerFormats blendMode buttonHeight buttonWidth collapsedHAlign left, center, right collapsedVAlign top, middle, bottom depth disableOnExpand expandDirection up, down expandedHeight expandedOffsetX expandedOffsetY expandedWidth height id Match the ID rules. rotation showButtons true, false style styleFile theme visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of ExpandingBanner |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of ExpandingBanner |
The depth of the component in levels.
| @rotation | Attribute of ExpandingBanner |
The rotation of the component in degrees.
| @visible | Attribute of ExpandingBanner |
Whether the component should be visible.
| @animationType | Attribute of ExpandingBanner |
How the banner animates when it expands or collapses.
Possible values: fade, 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.
| @buttonWidth | Attribute of ExpandingBanner |
The width in pixels of the expand/collapse buttons; the default is 60.
| @collapsedHAlign | Attribute of ExpandingBanner |
The horizontal alignment of the collapsed image within its dimensions.
Possible values: left, center, right
| @collapsedVAlign | Attribute of ExpandingBanner |
The vertical alignment of the collapsed image within its dimensions.
Possible values: top, middle, bottom
| @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
| @expandedHeight | Attribute of ExpandingBanner |
The height in pixels of the expanded unit.
| @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.
| @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.
| @expandedWidth | Attribute of ExpandingBanner |
The width in pixels of the expanded unit; the default is the full width of the ExpandingBanner component.
| @showButtons | Attribute of ExpandingBanner |
Whether the expand/collapse buttons are visible.
Possible values: true, false
| <Image/> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
Allows for any JPG, GIF or SWF to be loaded into a player, scaled according to the scaleMode attribute of the component.
<Image>'s attributes Name Values Default alpha blendMode click data depth hAlign left, center, right height id Match the ID rules. rotation scaleMode noScale, exactFit, showAll, scaleDown, noBorder source style styleFile theme tooltip url vAlign top, middle, bottom visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of Image |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of Image |
The depth of the component in levels.
| @rotation | Attribute of Image |
The rotation of the component in degrees.
| @visible | Attribute of Image |
Whether the component should be visible.
| @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
| @scaleMode | Attribute of Image |
How the image should be scaled within the dimensions of the element.
Possible values: noScale, exactFit, showAll, scaleDown, noBorder
| @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
| <Label/> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
A simple text component that allows for any text to be added to an experience. The text can be bound dynamically to any other component's property, for instance to display the name of the currently playing video.
<Label>'s attributes Name Values Default alpha blendMode color depth font hAlign left, center, right height htmlEnabled true, false id Match the ID rules. multiline true, false resize true, false rotation size style styleFile text theme translationText truncate true, false type body, title, link vAlign top, middle, bottom visible 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.
| @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.
| @blendMode | Attribute of Label |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of Label |
The depth of the component in levels.
| @rotation | Attribute of Label |
The rotation of the component in degrees.
| @visible | Attribute of Label |
Whether the component should be visible.
| @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
| @htmlEnabled | Attribute of Label |
Whether the label should render HTML text.
Possible values: true, false
| @multiline | Attribute of Label |
Whether the label should display multiple lines of text.
Possible values: true, false
| @resize | Attribute of Label |
Whether the label should automatically resize with the amount of text.
Possible values: true, 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
| @type | Attribute of Label |
A type which corresponds to the desired style to apply.
Possible values: body, title, link
| @vAlign | Attribute of Label |
Vertical alignment.
Possible values: top, middle, bottom
| <Link/> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
Provides a means to display clickable text within a player to be used to navigate to another URL or call JavaScript.
<Link>'s attributes Name Values Default alpha blendMode click data depth font hAlign left, center, right height id Match the ID rules. multiline true, false rotation size style styleFile text theme tooltip url vAlign top, middle, bottom visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of Link |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of Link |
The depth of the component in levels.
| @rotation | Attribute of Link |
The rotation of the component in degrees.
| @visible | Attribute of Link |
Whether the component should be visible.
| @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
| @multiline | Attribute of Link |
Whether the link should display multiple lines of text.
Possible values: true, 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
| <List> | Child of HBox, Row, Canvas, VBox, Layout |
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.
Element's model:
<List>'s children Name Cardinality ListItem Only one
<List>'s attributes Name Values Default alpha automaticAdvance true, false blendMode data depth height id Match the ID rules. itemInsetH itemInsetV itemLeading noInitialSelection noSelect true, false rotation rowHeight scrollerInset scrollerWidth selectOnClick true, false showBack true, false style styleFile theme visible width x y
(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.
| @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.
| @blendMode | Attribute of List |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of List |
The depth of the component in levels.
| @rotation | Attribute of List |
The rotation of the component in degrees.
| @visible | Attribute of List |
Whether the component should be visible.
| @automaticAdvance | Attribute of List |
Whether videos (if a video list) should automatically advance when play is complete.
Possible values: true, 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.
| @itemInsetV | Attribute of List |
The amount in pixels that items within the list are inset vertically from the borders of the list.
| @itemLeading | Attribute of List |
The vertical space in pixels between each item (defaults to 5).
| @noInitialSelection | Attribute of List |
Whether the first item in the list should be in a selected state when the list is initially rendered.
| @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
| @rowHeight | Attribute of List |
The height of each row in pixels (defaults to 50).
| @scrollerInset | Attribute of List |
The amount in pixels that the vertical scrollbar is inset horizontally from the borders of the list.
| @scrollerWidth | Attribute of List |
The width in pixels of the vertical scrollbar.
| @selectOnClick | Attribute of List |
Whether clicking subelements in the list items automatically selects the associated list item.
Possible values: true, false
| @showBack | Attribute of List |
Whether to display a 'Back' button.
Possible values: true, false
| <ListItem> | Child of List, TileList |
A ListItem must be defined within a List or TileList component. A ListItem can contain any supported component except a VideoPlayer or another list.
Element's model:
<ListItem>'s children Name Cardinality Button Any number Canvas Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number Spacer Any number SWFLoader Any number ThumbnailButton Any number TitleLabel Any number VBox Any number
<ListItem>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox gutter hAlign left, center, right height id Match the ID rules. padding showBack true, false style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | Label | Image | Link | Button | ThumbnailButton | TitleLabel | Spacer | SWFLoader)*
| @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.
| @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.
| @hAlign | Attribute of ListItem |
Horizontal alignment.
Possible values: left, center, right
| @vAlign | Attribute of ListItem |
Vertical alignment.
Possible values: top, middle, bottom
| @padding | Attribute of ListItem |
The pixel padding within the borders of the box, from which all positioning is made.
| @showBack | Attribute of ListItem |
Whether to display a 'Back' button.
Possible values: true, false
| <MediaControls> | Child of HBox, Row, Canvas, VBox, Layout |
A layout container for media UI controls to control playback of video.
Element's model:
<MediaControls>'s children Name Cardinality Button Any number Canvas Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number Playhead Any number Spacer Any number SWFLoader Any number TitleLabel Any number ToggleButton Any number VBox Any number VolumeControl Any number
<MediaControls>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox gutter hAlign left, center, right height id Match the ID rules. padding showBack true, false style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | Label | Image | Link | Button | ToggleButton | TitleLabel | Spacer | SWFLoader | Playhead | VolumeControl)*
| @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.
| @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
| @gutter | Attribute of MediaControls |
The pixel space between child elements.
| @hAlign | Attribute of MediaControls |
Horizontal alignment.
Possible values: left, center, right
| @vAlign | Attribute of MediaControls |
Vertical alignment.
Possible values: top, middle, bottom
| @padding | Attribute of MediaControls |
The pixel padding within the borders of the box, from which all positioning is made.
| @showBack | Attribute of MediaControls |
Whether to display a 'Back' button.
Possible values: true, false
| <Playhead/> | Child of HBox, Row, Canvas, VBox, MediaControls |
A scrubber bar to control media playback and show current media position.
<Playhead>'s attributes Name Values Default alpha blendMode depth height id Match the ID rules. mediaController rotation sliderWidth style styleFile theme visible 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.
| @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.
| @blendMode | Attribute of Playhead |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of Playhead |
The depth of the component in levels.
| @rotation | Attribute of Playhead |
The rotation of the component in degrees.
| @visible | Attribute of Playhead |
Whether the component should be visible.
| @mediaController | Attribute of Playhead |
The media controller (e.g., VideoPlayer, VideoDisplay) to receive events from and control playback of.
| @sliderWidth | Attribute of Playhead |
The width of the draggable slider in pixels.
| <Spacer/> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
A formatting component that creates space between other elements.
<Spacer>'s attributes Name Values Default height id 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.
| <SWFLoader/> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
The SWFLoader component allows you to specify a custom-developed SWF to be loaded, positioned and sized within a player. You can develop a custom component using ActionScript 3 and the Brightcove Player API. In order for the loaded SWF to be passed a handle to the runtime API, so that it can listen for events and interact with the rest of the player, it should implement the interface defined by this method signature:
function setInterface(obj:Object):void;
<SWFLoader>'s attributes Name Values Default alpha blendMode data depth height id Match the ID rules. rotation source style styleFile theme visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of SWFLoader |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of SWFLoader |
The depth of the component in levels.
| @rotation | Attribute of SWFLoader |
The rotation of the component in degrees.
| @visible | Attribute of SWFLoader |
Whether the component should be visible.
| @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 HBox, Row, Canvas, VBox, Layout |
Displays a horizontally-paging series of tabs. The TabBar allows for a single selection in the collection. The TabBar displays left and right navigation when the number of tabs exceeds the component dimensions. Optionally, the TabBar can display a tab that produces a dropdown list on rollover.
<TabBar>'s attributes Name Values Default alpha autoSizeTabs true, false blendMode data depth height hideSingleTab true, false id Match the ID rules. includeMenu true, false labelBuffer labelField maxMenuRows menuItemInset menuRowHeight menuWidth rotation style styleFile tabAlign left, center, right tabPadding tabWidth theme visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of TabBar |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of TabBar |
The depth of the component in levels.
| @rotation | Attribute of TabBar |
The rotation of the component in degrees.
| @visible | Attribute of TabBar |
Whether the component should be visible.
| @autoSizeTabs | Attribute of TabBar |
Whether tabs are sized based on the length of their labels or are a fixed width.
Possible values: true, false
| @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
| @includeMenu | Attribute of TabBar |
Whether to display the tab with the drop down quick navigation menu when necessary.
Possible values: true, false
| @labelBuffer | Attribute of TabBar |
The pixel space to the left and right of labels within a tab.
| @labelField | Attribute of TabBar |
The field in the data object that determines the label of a tab.
| @maxMenuRows | Attribute of TabBar |
The maximum number of menu rows that can display in the drop down quick navigation menu before paging is forced.
| @menuItemInset | Attribute of TabBar |
The horizontal pixel inset of labels within the drop down quick navigation menu.
| @menuRowHeight | Attribute of TabBar |
The height in pixels of each item in the drop down quick navigation menu .
| @menuWidth | Attribute of TabBar |
The width of the drop down quick navigation menu when it opens.
| @tabAlign | Attribute of TabBar |
The horizontal alignment of tabs within the component.
Possible values: left, center, right
| @tabPadding | Attribute of TabBar |
The horizontal space between tabs, in pixels.
| @tabWidth | Attribute of TabBar |
The fixed width of a tab if autoSizeTabs is false.
| <TextRegion> | Child of HBox, Row, Canvas, VBox, Layout |
A layout container for text elements.
Element's model:
<TextRegion>'s children Name Cardinality Canvas Any number Grid Any number HBox Any number Image Any number Label Any number Link Any number Spacer Any number SWFLoader Any number TitleLabel Any number VBox Any number
<TextRegion>'s attributes Name Values Default backgroundColor backgroundImage boxType vbox, hbox gutter hAlign left, center, right height id Match the ID rules. padding showBack true, false style styleFile theme vAlign top, middle, bottom width x y
(Canvas | HBox | VBox | Grid | Label | Image | Link | 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.
| @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
| @gutter | Attribute of TextRegion |
The pixel space between child elements.
| @hAlign | Attribute of TextRegion |
Horizontal alignment.
Possible values: left, center, right
| @vAlign | Attribute of TextRegion |
Vertical alignment.
Possible values: top, middle, bottom
| @padding | Attribute of TextRegion |
The pixel padding within the borders of the box, from which all positioning is made.
| @showBack | Attribute of TextRegion |
Whether to display a 'Back' button.
Possible values: true, false
| <ThumbnailButton/> | Child of HBox, Row, Canvas, ListItem, VBox, Layout |
Displays an image. When the viewer moves the cursor over the image, the button displays a play icon.
<ThumbnailButton>'s attributes Name Values Default alpha blendMode click data depth height id Match the ID rules. imageInset rotation source style styleFile theme tooltip visible 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.
| @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.
| @blendMode | Attribute of ThumbnailButton |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of ThumbnailButton |
The depth of the component in levels.
| @rotation | Attribute of ThumbnailButton |
The rotation of the component in degrees.
| @visible | Attribute of ThumbnailButton |
Whether the component should be visible.
| @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; this is dynamically populated for incoming ads.
| @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.
| <TileList> | Child of HBox, Row, Canvas, VBox, Layout |
A grid list with user-defined list items. A TileList contains ListItems, each of which can contain other components.
Element's model:
<TileList>'s children Name Cardinality ListItem Only one
<TileList>'s attributes Name Values Default alpha animationType move, fade, scale, none automaticAdvance true, false blendMode buttonOffsetX buttonOffsetY buttonSize centerContent true, false columnGutter columnWidth contentInsetH contentInsetV data depth height id Match the ID rules. noInitialSelection noSelect true, false numColumns numRows rotation rowGutter rowHeight scrollDirection horizontal, vertical selectOnClick true, false style styleFile theme useBlur true, false visible width x y
(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.
| @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.
| @blendMode | Attribute of TileList |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of TileList |
The depth of the component in levels.
| @rotation | Attribute of TileList |
The rotation of the component in degrees.
| @visible | Attribute of TileList |
Whether the component should be visible.
| @animationType | Attribute of TileList |
How the list animates its items when paging.
Possible values: move, fade, scale, none
| @automaticAdvance | Attribute of TileList |
Whether videos (if a video list) should automatically advance when play is complete.
Possible values: true, 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.
| @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.
| @buttonSize | Attribute of TileList |
The width and height in pixels of the navigation buttons.
| @centerContent | Attribute of TileList |
Whether content should be centered in the list.
Possible values: true, false
| @columnGutter | Attribute of TileList |
The distance between columns, in pixels.
| @columnWidth | Attribute of TileList |
The width of each column, in pixels (defaults to 50).
| @contentInsetH | Attribute of TileList |
The amount in pixels that items within the list are inset horizontally from the borders of the list.
| @contentInsetV | Attribute of TileList |
The amount in pixels that items within the list are inset vertically from the borders of the list.
| @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.
| @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
| @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.
| @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.
| @rowHeight | Attribute of TileList |
The height of each row in pixels (defaults to 50).
| @rowGutter | Attribute of TileList |
The distance between rows, in pixels.
| @scrollDirection | Attribute of TileList |
Whether the list should scroll vertically or horizontally.
Possible values: horizontal, vertical
| @selectOnClick | Attribute of TileList |
Whether clicking subelements in the list items automatically selects the associated list item.
Possible values: true, false
| @useBlur | Attribute of TileList |
Whether the list should blur its items as it is animated, if the animationType is move.
Possible values: true, false
| <TitleLabel/> | Child of HBox, Row, Canvas, TextRegion, ListItem, VBox, Layout, MediaControls |
The TitleLabel is 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 Name Values Default alpha blendMode color depth font hAlign left, center, right height htmlEnabled true, false id Match the ID rules. multiline true, false resize true, false rotation selected true, false size style styleFile text theme truncate true, false type body, title, link vAlign top, middle, bottom visible 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.
| @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.
| @blendMode | Attribute of TitleLabel |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of TitleLabel |
The depth of the component in levels.
| @rotation | Attribute of TitleLabel |
The rotation of the component in degrees.
| @visible | Attribute of TitleLabel |
Whether the component should be visible.
| @color | Attribute of TitleLabel |
The color of the text to display.
| @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
| @htmlEnabled | Attribute of TitleLabel |
Whether the label should render HTML text.
Possible values: true, false
| @multiline | Attribute of TitleLabel |
Whether the label should display multiple lines of text.
Possible values: true, false
| @resize | Attribute of TitleLabel |
Whether the label should automatically resize with the amount of text.
Possible values: true, false
| @selected | Attribute of TitleLabel |
Whether the item is in selected state.
Possible values: true, 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
| @type | Attribute of TitleLabel |
A type which corresponds to the desired style to apply.
Possible values: body, title, link
| @vAlign | Attribute of TitleLabel |
Vertical alignment.
Possible values: top, middle, bottom
| <ToggleButton/> | Child of HBox, Row, Canvas, VBox, Layout, MediaControls |
Defines a clickable graphic with a label that can broadcast events and toggle between two states.
<ToggleButton>'s attributes Name Values Default alpha autoSize true, false blendMode click data depth font height iconAlignmentH right, center, left iconAlignmentV top, middle, bottom iconName iconOffsetX iconOffsetY iconScale id Match the ID rules. label labelAlignmentH left, center, right labelAlignmentV top, middle, bottom labelBuffer labelOffsetX labelOffsetY lockHeight true, false maxWidth multiline true, false rotation showBack true, false size style styleFile theme toggled toggledClick toggledIconName toggledLabel toggledTooltip tooltip truncateLabel true, false visible 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.
| @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.
| @blendMode | Attribute of ToggleButton |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of ToggleButton |
The depth of the component in levels.
| @rotation | Attribute of ToggleButton |
The rotation of the component in degrees.
| @visible | Attribute of ToggleButton |
Whether the component should be visible.
| @autoSize | Attribute of ToggleButton |
Whether the button should automatically resize based on the amount of text.
Possible values: true, 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
| @iconAlignmentV | Attribute of ToggleButton |
The vertical alignment of the icon within the button's dimensions.
Possible values: top, middle, bottom
| @iconOffsetX | Attribute of ToggleButton |
The pixel offset on the x axis to apply to the icon.
| @iconOffsetY | Attribute of ToggleButton |
The pixel offset on the y axis to apply to the icon.
| @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.
| @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
| @labelAlignmentV | Attribute of ToggleButton |
The vertical alignment of the label within the button's dimensions.
Possible values: top, middle, bottom
| @labelBuffer | Attribute of ToggleButton |
The distance in pixels between the edge of the button and its label.
| @labelOffsetX | Attribute of ToggleButton |
The pixel offset on the x axis to apply to the label.
| @labelOffsetY | Attribute of ToggleButton |
The pixel offset on the y axis to apply to the label.
| @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
| @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
| @showBack | Attribute of ToggleButton |
Whether the background of the graphic should be shown.
Possible values: true, false
| @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.
| @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
| <VideoDisplay/> | Child of HBox, Row, Canvas, VBox, Layout |
A video window without the standard media control bar. Controls appear when the viewer clicks in the video window.
<VideoDisplay>'s attributes Name Values Default alpha autoStart true, false blendMode depth height id Match the ID rules. includeFullscreenControls true, false rotation showBack true, false style styleFile theme video visible 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.
| @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.
| @blendMode | Attribute of VideoDisplay |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of VideoDisplay |
The depth of the component in levels.
| @rotation | Attribute of VideoDisplay |
The rotation of the component in degrees.
| @visible | Attribute of VideoDisplay |
Whether the component should be visible.
| @autoStart | Attribute of VideoDisplay |
Whether the video should begin to play back immediately when the player loads.
Possible values: true, false
| @includeFullscreenControls | Attribute of VideoDisplay |
Whether the default Brightcove fullscreen controls are used.
Possible values: true, false
| @showBack | Attribute of VideoDisplay |
Whether a background graphic shoudl render behind the video.
Possible values: true, false
| @video | Attribute of VideoDisplay |
The videoDTO currently loaded into the video player
| <VideoPlayer/> | Child of HBox, Row, Canvas, VBox, Layout |
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 Name Values Default alpha autoStart true, false blendMode depth height id Match the ID rules. preventFullScreen true, false rotation style styleFile theme video visible width x y
This element is always empty.
| @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.
| @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.
| @blendMode | Attribute of VideoPlayer |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of VideoPlayer |
The depth of the component in levels.
| @rotation | Attribute of VideoPlayer |
The rotation of the component in degrees.
| @visible | Attribute of VideoPlayer |
Whether the component should be visible.
| @autoStart | Attribute of VideoPlayer |
Whether the video should begin to play back immediately when the player loads.
Possible values: true, false
| @preventFullScreen | Attribute of VideoPlayer |
Whether the maximize button should be suppressed in the player's controls.
Possible values: true, false
| @video | Attribute of VideoPlayer |
The videoDTO currently loaded into the video player.
| <VolumeControl/> | Child of HBox, Row, Canvas, VBox, MediaControls |
Defines a button with a popup overlay to control muting and volume settings of media.
<VolumeControl>'s attributes Name Values Default alpha animated true, false blendMode depth direction up, down, auto height horizontalPadding iconAlignmentH right, center, left iconAlignmentV top, middle, bottom iconName iconOffsetX iconOffsetY iconScale id Match the ID rules. mediaController mutedIconName mutedTooltip popupHeight rotation showBack true, false size sliderHeight style styleFile theme tooltip verticalPadding visible 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.
| @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.
| @blendMode | Attribute of VolumeControl |
The ActionScript DisplayObject blend mode of the component.
| @depth | Attribute of VolumeControl |
The depth of the component in levels.
| @rotation | Attribute of VolumeControl |
The rotation of the component in degrees.
| @visible | Attribute of VolumeControl |
Whether the component should be visible.
| @animated | Attribute of VolumeControl |
Whether the list should animate when opening.
Possible values: true, false
| @iconAlignmentH | Attribute of VolumeControl |
The horizontal alignment of the icon within the button's dimensions.
Possible values: right, center, left
| @iconAlignmentV | Attribute of VolumeControl |
The vertical alignment of the icon within the button's dimensions.
Possible values: top, middle, bottom
| @iconOffsetX | Attribute of VolumeControl |
The pixel offset on the x axis to apply to the icon.
| @iconOffsetY | Attribute of VolumeControl |
The pixel offset on the y axis to apply to the icon.
| @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) 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.
| @popupHeight | Attribute of VolumeControl |
The height of the popup control with volume slider.
| @sliderHeight | Attribute of VolumeControl |
The height of the volume slider in the popup.
| @horizontalPadding | Attribute of VolumeControl |
The horizontal padding around the controls in the popup.
| @verticalPadding | Attribute of VolumeControl |
The vertical padding around the controls in the popup.
| @showBack | Attribute of VolumeControl |
Whether the background of the graphic should be shown.
Possible values: true, false
| @size | Attribute of VolumeControl |
The size of the text to display, in points.
| @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