This document provides a reference to the Brightcove Player API, as it existed in the Brightcove 3.1 release. It includes methods and events that have been deprecated. For a summary of API changes and deprecations in the Brightcove 3.2 release, see Brightcove Player API Changes. For reference information about the current Brightcove Player API, see the current Player API Reference.
The Player API includes these modules:
The Brightcove Experience is the top level object through which all interaction is enabled and is instantiated by the publishing code. See Publishing Players to learn how to instantiate players in your applications.
getModule(module:String):Object
Retrieves the specified module within the player. Further, more specific actions, are handled through the relevant modules.
| name | type | description |
| module | String | The name of the module to retrieve the reference to. After retrieving the module, you can access that module's API accordingly. Constants for the module names are not yet available for ActionScript so you must use strings. Valid values for ActionScript are: "videoPlayer", "content", "experience", "menu", "social", "advertising", "cuePoints", and "search". Valid values for JavaScript are: APIModules.VIDEO_PLAYER, APIModules.CONTENT, APIModules.EXPERIENCE, APIModules.MENU, APIModules.SOCIAL, APIModules.ADVERTISING, APIModules.CUE_POINTS, and APIModules.SEARCH. |
| type | description |
| Object | The API module within the player. |
<pre>
/* The publishing code is placed in a class file that Brightcove Player. See the Publishing Players guide in the beta portal
*/
import BrightcovePlayer;
var bcp:BrightcovePlayer = new BrightcovePlayer();
bcp.addEventListener("templateLoaded", templateLoaded);
addChild(bcp);
var mPlayer;
// retrieves and stores a reference to the video player module
function templateLoaded(evt) {
mPlayer = bcp.getModule("videoPlayer");
}
</pre>
<pre>
/* The publishing code is placed in your HTML file. The player will automatically call onTemplateLoaded if the API is enabled
in the Brightcove Studio Publishing module */
var player;
var video;
function onTemplateLoaded(player) {
player = bcPlayer.getPlayer(player);
video = player.getModule(APIModules.VIDEO_PLAYER);
}
</pre>
The Advertising Module surfaces functionality for interaction and overriding of ads within a player.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
allowThirdPartyControl(control:Boolean):void
If true, disassociates the video player controls with video content player and video ad player and allows user to listen to video controls events to manipulate their own third party video or ad as they choose. This method was added specifically to provide more flexibility when developing custom ad swfs. If true, it sets the player controls in advertising mode (showing only "Sponsor Message," play/play, volume and timestamp), prevents player controls from controlling video playback in the player, and allows user to listen to button events and volume control events to control their own video playback as they see fit.
| name | type | description |
| control | Boolean | Boolean specifying whether or not the player or a third party is controlling the native video/ad player. |
None.
disableForExternalAd():void
Disables user interaction within the player and removes the video controls from the video player. Useful for when a video ad is rendered over the player, outside of the player's controls.
None.
None.
enableAdFormats():void
Enables the player to send additional possible format IDs in ad requests. By default, all video players support video ads and overlays. Other players, depending on their components, support additional formats such as synched banners and takeovers. The method takes a variable number of arguments, each of which should be an integer indicating the additional format to support. See Supported Ad Formats for a list of current supported formats.
None.
None.
enableExternalAds(enable:Boolean):void
Enables the player to broadcast an event if an ad format is returned from the server that is not natively supported by the player. This allows for an external object to capture the event and render the ad, if necessary.
| name | type | description |
| enable (optional) | Boolean | True to enable the "externalAd" event to fire when the player receives an unsupported ad format. |
None.
enableOverrideAds(enable:Boolean):void
Prevents the player from making any ad calls to an external ad server. Instead, when an ad is needed based on ad logic in the player, the "externalAd" event will fire and wait for an external object to determine the necessary ad to serve.
| name | type | description |
| enable (optional) | Boolean | True to enable the "externalAd" event to fire when the player requires an ad to be served. |
None.
getAdPolicy():Object
Returns the ad policy properties.
None.
| type | description |
| Object | Returns an Object with the following properties: adServerURL, playAdOnLoad, prerollAds, midrollAds, postrollAds, playerAdKeys, onLoadAdKeys, prerollAdKeys, midrollAdKeys, postrollAdKeys, adPlayCap, titleBasedAdInterval, titleAdPlayInterval, timeBasedAdInterval, timeAdPlayInterval, firstAdPlay |
getCurrentAdProperties():Object
Returns the properties for the current ad. If there isn't a current ad, then this function returns null.
None.
| type | description |
| Object | Returns an Object with the following properties: adType, duration, formatName, additionalKeys, cuePointName, and cuePointMetadata. It also can contain format-specific properties such as overlayURL and videoAdURL. |
getEnabledAdFormats():Array
Returns an array of format IDs supported by the player. See Supported Ad Formats for a list of current supported formats.
None.
| type | description |
| Array | An array of format IDs supported by the player. |
getExternalAdsEnabled():Boolean
Returns whether the external ads flag is enabled in the player. This flag enables the player to broadcast an "externalAd" event if an ad format is returned from the server that is not natively supported by the player.
None.
| type | description |
| Boolean | True if external ads are enabled. |
getOverrideAdsEnabled():Boolean
Returns whether the override ads flag is enabled in the player. The override ads flag prevents the player from making any ad calls to an external ad server and instead fires an "externalAd" event when an ad needs to be rendered.
None.
| type | description |
| Boolean | True if the override ads flag is enabled. |
getShowSponsorMessage():Boolean
Returns whether or not the controls are showing "Sponsor Message", indicating advertising mode.
None.
| type | description |
| Boolean | True if "Sponsor Message" is currently showing in the player controls. |
getThirdPartyTime():Number
Allows user to get the current 3rd party ad time in seconds. This should only be used when implementing custom ad solutions outside of the Brightcove player. 'allowThirdPartyAdControl' must be called first in order to use this method, otherwise, '0' will be returned.
None.
| type | description |
| Number | The current ad time in seconds. |
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
resumeAfterExternalAd():void
Informs the player that an external ad has completed playing. The player then resumes content playback.
None.
None.
setThirdPartyTime(time:Number):void
Allows user to set visual time progress in the player controls directly. This should only be used when implementing custom ad solutions outside of the Brightcove player. 'allowThirdPartyAdControl' must be called first in order to use this method. This method should be called continuously as the ad progresses in order to update the visual timestamp.
| name | type | description |
| time | Number | The current third party ad time in seconds. |
None.
showAd(adObject:Object):void
Renders an ad in the player in the format defined by the object passed to the method. The ad format must be one recognized by the player for it to render, otherwise it will be ignored.
| name | type | description |
| adObject | Object | An object containing properties that match the rich media ad templates accepted by the player. More descriptive explanation of these ad objects can be found in the Brightcove advertising operations documentation. |
None.
showSponsorMessage(show:Boolean):void
Hides all controls except time controls and sets time controls to advertising mode, showing only "Sponsor Message" in the player controls.
| name | type | description |
| show | Boolean | Whether or not to set controls to only show "Sponsor Message." |
None.
adComplete
Event fired when an ad finishes playing in the player.
| name | type | description |
| event.type: | String | adComplete |
| event.position: | Number | The ad position, in seconds from the start of the ad. |
adResume
Event fired when an ad resumes playback in the video window after being previously paused.
| name | type | description |
| event.type: | String | adResume |
| event.position: | Number | The ad position, in seconds from the start of the ad. |
adPause
Event fired when an ad pauses playing back in the video window.
| name | type | description |
| event.type: | String | adPause |
| event.position: | Number | The ad position, in seconds from the start of the ad. |
adProgress
Event fired as an ad plays back in the video window. This event can be used to display progress or a countdown to the viewer.
| name | type | description |
| event.type: | String | adProgress |
| event.position: | Number | The ad position, in seconds from the start of the ad. |
adStart
Event fired when an ad starts initial playback in the video window.
| name | type | description |
| event.type: | String | adStart |
| event.position: | Number | The ad position, in seconds from the start of the ad. Always 0 for this event. |
externalAd
Event fired when an ad insertion point is reached and either a) the developer has chosen to override all ad calls in the player by setting the override ads flag to true, or b) an unknown ad format has been returned from the ad server and the developer has set the external ads flag to true.
| name | type | description |
| event.type: | String | externalAd |
| event.ad: | Object | The XML (as a String) describing the ad as returned by the ad server or, if the override ads flag was set to true, the XML (as a String) containing information on the current title and lineup as would be sent to an ad server for an ad request. |
The Content Module surfaces functionality for retrieving additional media content from the backend. These methods enable assigning additional videos and playlists to a player.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
getAllPlaylistIDs():Array
(deprecated)
Returns an array of playlist IDs for all playlists currently loaded into the player, including both the playlists assigned in the Media module and any playlists loaded at runtime.
None.
| type | description |
| Array | An array of playlist IDs for all playlists currently loaded into the player. |
getAllPlaylists():Array
(deprecated)
Returns an array of full playlist DTOs currently loaded into the player.
None.
| type | description |
| Array | An array of full playlist DTOs currently loaded into the player. |
getPlaylist(playlistID:Object, property:String, pageIndex:Number, recordsPerPage:Number):Object
(deprecated)
Returns the playlist DTO for the ID or referenceID passed in if it is currently loaded in the player. Only the IDs for the currently loaded videos in the specified page in the videoDTOs result set are included. See getPlaylistAsynch() for more details on paging.
| name | type | description |
| playlistID | Object | The ID or referenceID for the playlist to retrieve. |
| property (optional) | String | The property of the playlist DTO in which to check for the specified ID ("id"|"referenceId"). |
| pageIndex (optional) | Number | The page to fetch in the result set of videoDTOs. |
| recordsPerPage (optional) | Number | The number of videoDTOs to return per page in the result set. |
| type | description |
| Object | A playlist DTO, or null if the playlist has not been loaded in the player. |
getPlaylistAsynch(playlistID:Object, property:String, pageIndex:Number, recordsPerPage:Number):void
(deprecated)
Retrieves the playlist DTO from the backend for the ID or referenceID passed in, then fires the "playlistLoad" event. If the playlist has already been retrieved, the "playlistLoad" event is fired immediately. Playlists are not sent back with the full list of their videoDTOs, but instead include a page from a full result set. To return the first 20 videos of a playlist, a pageIndex of 0 and a resultsPerPage of 20 should be passed in. To fetch the second page of this set, a pageIndex of 1 and the same resultsPerPage of 20 should be passed in.
| name | type | description |
| playlistID | Object | The ID or referenceID for the playlist to retrieve. |
| property (optional) | String | The property of the playlist DTO in which to check for the specified ID ("id"|"referenceId"). |
| pageIndex (optional) | Number | The page to fetch in the result set of videoDTOs. |
| recordsPerPage (optional) | Number | The number of videoDTOs to return per page in the result set. |
None.
getVideo(videoID:Object, property:String):Object
(deprecated)
Returns the video DTO for the ID or referenceID passed in if it is currently loaded in the player.
| name | type | description |
| videoID | Object | The ID or referenceID for the video to retrieve. |
| property (optional) | String | The property of the video DTO in which to check for the specified ID ("id"|"referenceId"). |
| type | description |
| Object | A video DTO, or null if the video has not been loaded in the player. |
getVideoAsynch(videoID:Object, property:String):void
(deprecated)
Retrieves the video DTO from the backend for the ID or referenceID passed in, then fires the "videoLoad" event. If the video has already been retrieved, the "videoLoad" event is fired immediately.
| name | type | description |
| videoID | Object | The ID or referenceID for the video to retrieve. |
| property (optional) | String | The property of the video DTO in which to check for the specified ID ("id"|"referenceId"). |
None.
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
playlistLoad
Event fired when a playlist that was requested from the player using an asynch method returns.
| name | type | description |
| event.type: | String | playlistLoad |
| event.playlist: | Object | The playlist DTO returned from an asynch request. |
videoLoad
Event fired when a video that was requested from the player using an asynch method returns.
| name | type | description |
| event.type: | String | videoLoad |
| event.video: | Object | The video DTO returned from an asynch request. |
The CuePoints Module surfaces functionality for setting and clearing cue points for individual videos at runtime. In addition, the module allows developers to listen for the cuepoint event being fired while videos play back.
addCuePoints(ID:String, cuePoints:Array):Boolean
Adds a set of cue points to a specified video. These cue points will cause cuePoint events to fire at the times specified, which the developer can subscribe to.
| name | type | description |
| ID | String | The ID of the video with cue points to return. |
| cuePoints | Array | An array of objects defining points in time. Each index of the array can either be a number, specifying the time in seconds for the cue, or each index can contain a complex object with time (in seconds), type, name and metadata properties. |
| type | description |
| Boolean | Whether the specified video can be found in the current content of the player. |
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
clearCodeCuePoints(ID:String):Boolean
Clears all code cue points for a specified video.
| name | type | description |
| ID | String | The ID of the video with cue points to clear. |
| type | description |
| Boolean | Whether the specified video can be found in the current content of the player. |
getCuePoints(ID:String):Array
Returns an array of cue point objects for the specified video.
| name | type | description |
| ID | String | The ID of the video with cue points to return. |
| type | description |
| Array | An array of cue point objects for the specified video. |
removeCodeCuePointsAtTime(ID:String, time:String):Boolean
Removes code cue points at the specified time for the specified video.
| name | type | description |
| ID | String | The ID of the video with cue points to remove. |
| time | String | The time (in seconds) of the cue point to remove. |
| type | description |
| Boolean | Whether the specified video can be found in the current content of the player and whether cue points existed and were removed at the specified time. |
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
cuePoint
Event fired when a cue point is reached within a video currently playing back.
| name | type | description |
| event.type: | String | cuePoint |
| event.cuePoint: | Object | The cue point object that was caused the event to fire. |
The Experience Module surfaces functionality for interaction with global events and top-level behavior.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
getAffiliateID():Number
When applicable, returns the ID of the affiliate to which the player belongs.
None.
| type | description |
| Number | The ID of the affiliate to which the player belongs. |
getConfiguredPropertiesForID(ID:String):Object
Returns all configured properties for the specified component as set through the Publishing Module.
| name | type | description |
| ID | String | The ID of the UI component to get configured properties for. |
| type | description |
| Object | A map of configured properties for the specified component. |
getElementByID(ID:String):Object
Returns a particular UI component with its own API that can be interacted with.
| name | type | description |
| ID | String | The ID of the UI component, as specified in the template markup. |
| type | description |
| Object | The API handle for the specified object. |
getEnabled():Boolean
Returns whether the player is enabled for user interaction.
None.
| type | description |
| Boolean | Whether the player is enabled for user interaction. |
getExperienceID():String
Returns the ID of the loaded player.
None.
| type | description |
| String | The ID of the loaded player. |
getExperienceURL():String
Returns the URL of the page where the loaded player is delivered.
None.
| type | description |
| String | The URL of the page where the loaded player is delivered. |
getHeight():Number
Returns the pixel height of the player.
None.
| type | description |
| Number | The numeric pixel height of the player. |
getLayoutRoot():Object
Returns a reference to the root UI component of the player through which further API actions may be taken.
None.
| type | description |
| Object | A reference to the root UI component of the player. |
getPublisherID():Number
Returns the ID of the publisher to which the player belongs.
None.
| type | description |
| Number | The ID of the publisher to which the player belongs. |
getReady():Boolean
Returns whether the player's templateReady event has fired.
None.
| type | description |
| Boolean | Whether the player's templateReady event has fired. |
getReferrerURL():String
Returns the URL of the referrer page for the page where the loaded player is delivered.
None.
| type | description |
| String | The URL of the page that linked to the current player page. |
getWidth():Number
Returns the pixel width of the player.
None.
| type | description |
| Number | The numeric pixel width of the player. |
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
setEnabled(enable:Boolean):void
Enables or disables the player for user interaction.
| name | type | description |
| enable | Boolean | Whether the player should enable (true) or disable (false) itself. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the Brightcove player.
| name | type | description |
| width | Number | The total width of the player in pixels. |
| height | Number | The total height of the player in pixels. |
None.
contentLoad
Event fired when the programmed content for a player completed loading upon initialization of the player.
| name | type | description |
| event.type: | String | contentLoad |
enterFullScreen
Event fired when the player enters full screen mode.
| name | type | description |
| event.type: | String | enterFullScreen |
exitFullScreen
Event fired when the player exits full screen mode.
| name | type | description |
| event.type: | String | exitFullScreen |
templateReady
Event fired when the player completes its initialization and is ready for full interaction.
| name | type | description |
| event.type: | String | templateReady |
userMessage
Event fired when a Flash popup within the player has been displayed to the viewer. Messaging could include whether a slow connection has been detected on load of the player, whether there is no content available in the player or whether an error has occurred on the loading of a video.
| name | type | description |
| event.type: | String | videoLoad |
| event.message: | String | The message displayed to the viewer. |
A UI component that allows for performing actions on user clicks.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAutoSize():Boolean
Returns whether the button should resize based on its label.
None.
| type | description |
| Boolean | True if the button should resize based on its label. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getFont():String
Returns the name of the font used by the label.
None.
| type | description |
| String | The name of the font used by the label. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getIconAlignmentH():String
Returns the horizontal alignment for the icon.
None.
| type | description |
| String | The horizontal alignment setting for the button icon. |
getIconAlignmentV():String
Returns the vertical alignment for the icon.
None.
| type | description |
| String | The vertical alignment setting for the button icon. |
getIconName():String
Returns the name of the current icon displayed.
None.
| type | description |
| String | The name of the current icon displayed. |
getIconOffsetX():Number
Returns the pixel amount on the x axis the icon is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the x axis the icon is offset from its aligned position. |
getIconOffsetY():Number
Returns the pixel amount on the y axis the icon is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the y axis the icon is offset from its aligned position. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getIsTruncated():Boolean
Returns whether the label has been truncated due to the width of the button.
None.
| type | description |
| Boolean | True if the label has been truncated due to the width of the button. |
getLabel():String
Returns the current text in the label.
None.
| type | description |
| String | The current text in the label. |
getLabelAlignmentH():String
Returns the horizontal alignment for the label.
None.
| type | description |
| String | The horizontal alignment setting for the button label. |
getLabelAlignmentV():String
Returns the vertical alignment for the label.
None.
| type | description |
| String | The vertical alignment setting for the button label. |
getLabelBuffer():Number
Returns the minimum pixel amount to the left and right of the label.
None.
| type | description |
| Number | The pixel amount used as a visual buffer to the left and right of the label. |
getLabelSize():Number
Returns the point size of the text in the label, if overridden from the style, or -1 otherwise.
None.
| type | description |
| Number | The point size of the text in the label, if overridden from the style, or -1. |
getLabelOffsetX():Number
Returns the pixel amount on the x axis the label is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the x axis the label is offset from its aligned position. |
getLabelOffsetY():Number
Returns the pixel amount on the y axis the label is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the y axis the label is offset from its aligned position. |
getLabelWidth():Number
Returns the pixel width of the text in the label.
None.
| type | description |
| Number | The pixel width of the text in the label. |
getMultiline():Boolean
Returns whether the label can render its text across multiple lines.
None.
| type | description |
| Boolean | True if the label can render its text across multiple lines. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getShowBack():Boolean
Returns whether the background graphic of the button is visible.
None.
| type | description |
| Boolean | True if the background graphic of the button is visible. |
getTooltip():String
Returns the tooltip text that will appear on rollover of the button.
None.
| type | description |
| String | The tooltip text that will appear on rollover of the button. |
getTruncateLabel():Boolean
Returns whether the label should truncate if its text is greater than the button width.
None.
| type | description |
| Boolean | True if the label should truncate if its text is greater than the button width. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAutoSize(autoSize:Boolean):void
Sets whether the button should resize based on its label.
| name | type | description |
| autoSize | Boolean | True if the button should resize based on its label. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setFont(font:String):void
Sets the name of the font used by the label. This font must have been embedded through the markup
| name | type | description |
| font | String | The name of the font to be used by the label. This font must have been embedded through the markup |
None.
setIconAlignmentH(alignment:String):void
Sets the horizontal alignment for the icon.
| name | type | description |
| alignment | String | The horizontal alignment setting for the button icon (right, center or left). |
None.
setIconAlignmentV(alignment:String):void
Sets the vertical alignment for the icon.
| name | type | description |
| alignment | String | The vertical alignment setting for the button icon (top, middle or bottom). |
None.
setIconName(name:String):void
Sets the current icon displayed.
| name | type | description |
| name | String | The name of the current icon to display (menu, play, pause, volume, maximize, minimize, share, link, code). |
None.
setIconOffsetX(offset:Number):void
Sets the pixel amount on the x axis the icon should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the x axis the icon should offset from its aligned position. |
None.
setIconOffsetY(offset:Number):void
Sets the pixel amount on the y axis the label should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the y axis the label should offset from its aligned position. |
None.
setLabel(label:String):void
Sets the current text for the label.
| name | type | description |
| label | String | The text to apply to the label. |
None.
setLabelAlignmentH(alignment:String):void
Sets the horizontal alignment for the label.
| name | type | description |
| alignment | String | The horizontal alignment setting for the button label (right, center or left). |
None.
setLabelAlignmentV(alignment:String):void
Sets the vertical alignment for the label.
| name | type | description |
| alignment | String | The vertical alignment setting for the button label (top, middle or bottom). |
None.
setLabelBuffer(buffer:Number):void
Sets the minimum pixel amount to the left and right of the label.
| name | type | description |
| buffer | Number | The pixel amount to be used as a visual buffer to the left and right of the label. |
None.
setLabelOffsetX(offset:Number):void
Sets the pixel amount on the x axis the label should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the x axis the label should offset from its aligned position. |
None.
setLabelOffsetY(offset:Number):void
Sets the pixel amount on the y axis the label should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the y axis the label should offset from its aligned position. |
None.
setLabelSize(size:Number):void
Sets the point size of the text in the label.
| name | type | description |
| size | Number | The point size of the text in the label, or -1 to remove the style override. |
None.
setMultiline(multiline:Boolean):void
Sets whether the label can render its text across multiple lines.
| name | type | description |
| multiline | Boolean | True if the label can render its text across multiple lines. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setTooltip(text:String):void
Sets the tooltip text that will appear on rollover of the button.
| name | type | description |
| text | String | The tooltip text that will appear on rollover of the button. |
None.
setTruncateLabel(truncate:Boolean):void
Sets whether the label should truncate if its text is greater than the button width.
| name | type | description |
| truncate | Boolean | True if the label should truncate if its text is greater than the button width. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
showBack(show:Boolean):void
Sets whether the background graphic of the button is visible.
| name | type | description |
| show | Boolean | Whether the background graphic of the button should be visible. |
None.
A ComboBox UI component within a player.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAnimated():Boolean
Returns whether the combo animates when opening and closing.
None.
| type | description |
| Boolean | True if the combo animates when opening and closing. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getData():Array
Returns all of the data currently stored and rendered in the list.
None.
| type | description |
| Array | The data stored and rendered in the list. |
getDataAtIndex(index:Number):Object
Returns the data stored in the item in the list at the specified index position.
| name | type | description |
| index | Number | The index position of the item from which to retrieve data. |
| type | description |
| Object | The data stored in the item in the list at the specified index position. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getItemInsetH():Number
Returns the pixel amount each list item is inset horizontally from the sides of the list component.
None.
| type | description |
| Number | The pixel amount each list item is inset horizontally from the sides of the list component. |
getItemInsetV():Number
Returns the pixel amount each list item is inset vertically from the top and bottom of the list component.
None.
| type | description |
| Number | The pixel amount each list item is inset vertically from the top and bottom of the list component. |
getLabel():String
Returns the string that will appear in the combo if no item is selected.
None.
| type | description |
| String | The string that will appear in the combo if no item is selected. |
getLabelBufferLeft():Number
Returns the horizontal pixel space to the left of the label.
None.
| type | description |
| Number | The horizontal pixel space to the left of the label. |
getLabelBufferRight():Number
Returns the horizontal pixel space to the right of the label.
None.
| type | description |
| Number | The horizontal pixel space to the right of the label. |
getLabelBufferTop():Number
Returns the vertical pixel space above the label.
None.
| type | description |
| Number | The vertical pixel space above the label. |
getLabelField():String
Returns the property of the items that is used for display of the label.
None.
| type | description |
| String | The property of the items that is used for display of the label. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getNumItems():Number
Returns the number of items currently stored and rendered in the list. This is not just visible items, but all items in the list's data property.
None.
| type | description |
| Number | The number of items stored and rendered in the list. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getRowHeight():Number
Returns the pixel height of items in the list.
None.
| type | description |
| Number | The pixel height of items in the list. |
getScrollerInset():Number
Returns the pixel amount the scroller is inset horizontally from the side of the list.
None.
| type | description |
| Number | The pixel amount the scroller is inset horizontally from the side of the list. |
getScrollerWidth():Number
Returns the pixel width of the scroller.
None.
| type | description |
| Number | The pixel width of the scroller. |
getSelectedData():Object
Returns the data stored in the currently selected item in the list.
None.
| type | description |
| Object | The data stored in the currently selected item in the list. |
getSelectedIndex():Number
Returns the index position of the currently selected item in the list.
None.
| type | description |
| Number | The index position of the currently selected item in the list. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAnimated(animate:Boolean):void
Sets whether the combo should animate when opening and closing.
| name | type | description |
| animate | Boolean | True if the combo should animate when opening and closing. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setData(data:Array):void
Returns all of the data currently stored and rendered in the list.
| name | type | description |
| data | Array | An array of items to render in the list. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setItemInsetH(inset:Number):void
Sets the pixel amount items in the list will be inset horizontally from the sides of the component.
| name | type | description |
| inset | Number | The pixel amount items in the list will be inset horizontally from the sides of the component. |
None.
setItemInsetV(inset:Number):void
Sets the pixel amount items in the list will be inset vertically from the top and bottom of the component.
| name | type | description |
| inset | Number | The pixel amount items in the list will be inset vertically from the top and bottom of the component. |
None.
setLabel(label:String):void
Sets the string that will appear in the combo if no item is selected.
| name | type | description |
| label | String | The string that will appear in the combo if no item is selected. |
None.
setLabelBufferLeft(buffer:Number):void
Sets the horizontal pixel space to the left of the label.
| name | type | description |
| buffer | Number | The horizontal pixel space to the left of the label. |
None.
setLabelBufferRight(buffer:Number):void
Sets the horizontal pixel space to the right of the label.
| name | type | description |
| buffer | Number | The horizontal pixel space to the right of the label. |
None.
setLabelBufferTop(buffer:Number):void
Sets the vertical pixel space above the label.
| name | type | description |
| buffer | Number | The vertical pixel space above the label. |
None.
setLabelField(field:String):void
Sets the property of the items that is used for display of the label.
| name | type | description |
| field | String | The property of the items that should be used for display of the label. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setRowHeight(height:Number):void
Sets the pixel height for items in the list.
| name | type | description |
| height | Number | The pixel height for items in the list. |
None.
setScrollerInset(inset:Number):void
Sets the pixel amount that the scroller is inset horizontally from the sides of the component.
| name | type | description |
| inset | Number | The pixel amount that the scroller is inset horizontally from the sides of the component. |
None.
setScrollerWidth(width:Number):void
Sets the pixel width of the scroller.
| name | type | description |
| width | Number | The pixel width of the scroller. |
None.
setSelectedIndex(index:Number):void
Sets a new selected item in the list by passing in the index position of that item.
| name | type | description |
| index | Number | The index position of the item to select. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
propertyChange
Event fired when bindable properties of the component change.
| name | type | description |
| event.type: | String | propertyChange |
| event.property: | String | The name of the property that changed. |
An Image UI component within a player.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getContentHeight():Number
Returns the pixel height of the loaded image.
None.
| type | description |
| Number | The pixel height of the loaded image. |
getContentWidth():Number
Returns the pixel width of the loaded image.
None.
| type | description |
| Number | The pixel width of the loaded image. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHAlign():String
Returns the horizontal alignment setting, which determines how a loaded image will be positioned within the component.
None.
| type | description |
| String | The horizontal alignment setting of the component. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getInset():Number
Returns the pixel amount on each side that the loaded image should be inset within the component.
None.
| type | description |
| Number | The pixel amount on each side that the loaded image should be inset within the component. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getScaleMode():String
Returns the scale mode of the component, which determines how an image is scaled within the boundaries of the component.
None.
| type | description |
| String | The scale mode of the component. |
getSource():String
Returns the source path of the currently loaded image.
None.
| type | description |
| String | The source path of the currently loaded image. |
getTooltip():String
Returns the tooltip text that will appear on rollover of the image.
None.
| type | description |
| String | The tooltip text that will appear on rollover of the image. |
getURL():String
Returns the URL that will be navigated to (in a new browser window) when the image is clicked.
None.
| type | description |
| String | The URL that will be navigated to when the image is clicked. |
getVAlign():String
Returns the vertical alignment setting, which determines how a loaded image will be positioned within the component.
None.
| type | description |
| String | The vertical alignment setting of the component. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setHAlign(alignment:String):void
Sets the horizontal alignment setting, which determines how a loaded image will be positioned within the component.
| name | type | description |
| alignment | String | The horizontal alignment setting of the component. Valid arguments include "left", "center" and "right" |
None.
setInset(inset:Number):void
Sets the pixel amount on each side that the loaded image should be inset within the component.
| name | type | description |
| inset | Number | The pixel amount on each side that the loaded image should be inset within the component. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setScaleMode(mode:String):void
Sets the scale mode of the component, which determines how an image is scaled within the boundaries of the component.
| name | type | description |
| mode | String | The scale mode of the component. Valid arguments include "noScale", "exactFit", "scaleDown", "noBorders" and "showAll" |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setSource(path:String):void
Loads a new image into the component.
| name | type | description |
| path | String | The source path for the image to load. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setTooltip(text:String):void
Sets the tooltip text that will appear on rollover of the image.
| name | type | description |
| text | String | The tooltip text that will appear on rollover of the image. |
None.
setURL(url:String):void
Sets the URL that will be navigated to (in a new browser window) when the image is clicked.
| name | type | description |
| url | String | The URL that will be navigated to when the image is clicked. |
None.
setVAlign(alignment:String):void
Sets the vertical alignment setting, which determines how a loaded image will be positioned within the component.
| name | type | description |
| alignment | String | The vertical alignment setting of the component. Valid arguments include "top", "middle" and "bottom" |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
A Label UI component within a player.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAutoSize():Boolean
Returns whether the label should resize based on its text.
None.
| type | description |
| Boolean | True if the label should resize based on its text. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getColor():Number
Returns the color of the label, if overridden from the style, or -1 otherwise.
None.
| type | description |
| Number | The color of the label, if overridden from the style, or -1. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getFont():String
Returns the name of the font used by the label.
None.
| type | description |
| String | The name of the font used by the label. |
getHAlign():String
Returns the horizontal alignment setting, which determines how text will be positioned within the component.
None.
| type | description |
| String | The horizontal alignment setting of the component. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getHTMLEnabled():Boolean
Returns whether the label supports HTML rendering of text.
None.
| type | description |
| Boolean | True if the label supports HTML rendering of text. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getIsTruncated():Boolean
Returns whether the label has been truncated due to the width of its text.
None.
| type | description |
| Boolean | True if the label has been truncated due to the width of its text. |
getMultiline():Boolean
Returns whether the label can render its text across multiple lines.
None.
| type | description |
| Boolean | True if the label can render its text across multiple lines. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getText():String
Returns the text currently displayed in the label.
None.
| type | description |
| String | The text currently displayed in the label. |
getTextHeight():Number
Returns the pixel height of the text in the label.
None.
| type | description |
| Number | The pixel height of the text in the label. |
getTextSize():Number
Returns the point size of the text in the label, if overridden from the style, or -1 otherwise.
None.
| type | description |
| Number | The point size of the text in the label, if overridden from the style, or -1. |
getTextWidth():Number
Returns the pixel width of the text in the label.
None.
| type | description |
| Number | The pixel width of the text in the label. |
getTruncate():Boolean
Returns whether the label should truncate if its text is greater than its width.
None.
| type | description |
| Boolean | True if the label should truncate if its text is greater than its width. |
getType():String
Returns the label's type, "body" or "title", which determines its applied styles.
None.
| type | description |
| String | The type of label, either "body" or "title". |
getUnderline():Boolean
Returns whether the label displays an underline below its text.
None.
| type | description |
| Boolean | True if the label displays an underline. |
getVAlign():String
Returns the vertical alignment setting, which determines how text will be positioned within the component.
None.
| type | description |
| String | The vertical alignment setting of the component. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAutoSize(autoSize:Boolean):void
Sets whether the label should resize based on its text.
| name | type | description |
| autoSize | Boolean | True if the label should resize based on its text. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setColor(color:Number):void
Sets the color of the label.
| name | type | description |
| color | Number | The color of the label, or -1 to remove a color override. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setFont(font:String):void
Sets the name of the font used by the label. This font must have been embedded through the markup
| name | type | description |
| font | String | The name of the font to be used by the label. This font must have been embedded through the markup |
None.
setHAlign(align:String):void
Sets the horizontal alignment setting, which determines how text will be positioned within the component.
| name | type | description |
| align | String | The horizontal alignment setting of the component. Valid arguments include "left", "center" and "right". |
None.
setHTMLEnabled(htmlEnabled:Boolean):void
Sets whether the label supports HTML rendering of text.
| name | type | description |
| htmlEnabled | Boolean | True if the label supports HTML rendering of text. |
None.
setMultiline(multiline:Boolean):void
Sets whether the label can render its text across multiple lines.
| name | type | description |
| multiline | Boolean | True if the label can render its text across multiple lines. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setText(text:String):void
Sets the text to display in the label.
| name | type | description |
| text | String | The text to display in the label. |
None.
setTextSize(size:Number):void
Sets the point size of the text in the label.
| name | type | description |
| size | Number | The point size of the text in the label, or -1 to remove the style override. |
None.
setTruncate(truncate:Boolean):void
Sets whether the label should truncate if its text is greater than its width.
| name | type | description |
| truncate | Boolean | True if the label should truncate if its text is greater than its width. |
None.
setType(type:String):void
Sets the label's type, "body" or "title", which determines its applied styles.
| name | type | description |
| type | String | The type of label, either "body" or "title". |
None.
setUnderline(underline:Boolean):void
Sets whether the label displays an underline below its text.
| name | type | description |
| underline | Boolean | True if the label is to display an underline. |
None.
setVAlign(alignment:String):void
Sets the vertical alignment setting, which determines how text will be positioned within the component.
| name | type | description |
| alignment | String | The vertical alignment setting of the component. Valid arguments include "top", "middle" and "bottom". |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
A container for other elements, controlling size and position.
appendChild(definition:String):Boolean
Adds a new child component to the end of the box children array.
| name | type | description |
| definition | String | The XML definition, as a string, to be used by the new component. |
| type | description |
| Boolean | True if the component was successfully added. |
getAlign():String
Returns how child components align within the box, if supported by the particular box component.
None.
| type | description |
| String | The alignment setting of the box. |
getBackgroundColor():Number
Returns the background color of the box, or -1 if no color is assigned.
None.
| type | description |
| Number | The background color of the box, or -1 if none is assigned. |
getBackgroundImage():String
Returns the background image loaded for the box.
None.
| type | description |
| String | The background image loaded for the box. |
getChildAt(index:Number):Object
Returns a reference to the component at the specified index position.
| name | type | description |
| index | Number | The index position from which to retrieve the component reference. |
| type | description |
| Object | A reference to the component at the specified index position. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getGutter():Number
Returns the number of pixels for the buffer between components in the box.
None.
| type | description |
| Number | The number of pixels for the buffer between components in the box. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getNumChildren():Number
Returns the number of children currently in the box.
None.
| type | description |
| Number | The number of children currently in the box. |
getPadding():Number
Returns the number of pixels for the border of the box.
None.
| type | description |
| Number | The number of pixels for the border of the box. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
insertChildAt(definition:String, index:Number):Boolean
Adds a new child component at the specified position in the box children array.
| name | type | description |
| definition | String | The XML definition, as a string, to be used by the new component. |
| index | Number | The index position in which to insert the new component. |
| type | description |
| Boolean | True if the component was successfully added. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
removeChildByID(ID:String):Boolean
Removes a child component with the specified ID from the box children array.
| name | type | description |
| ID | String | The ID of the child component. |
| type | description |
| Boolean | True if the child was successfully removed. |
setAlign(alignment:String):void
Sets how child components align within the box, if supported by the particular box component.
| name | type | description |
| alignment | String | The alignment setting of the box. Depending on the box, this could be "top", "middle", "bottom", "left", "center" or "right". |
None.
setBackgroundColor(color:Number):void
Sets the background color of the box.
| name | type | description |
| color | Number | The background color of the box, or -1 to remove color. |
None.
setBackgroundImage(file:String):void
Sets the background image to load for the box.
| name | type | description |
| file | String | The background image to load for the box. |
None.
setGutter(gutter:Number):void
Sets the number of pixels for the buffer between components in the box.
| name | type | description |
| gutter | Number | The number of pixels for the buffer between components in the box. |
None.
setPadding(padding:Number):void
Sets the number of pixels for the border of the box.
| name | type | description |
| padding | Number | The number of pixels for the border of the box. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
A Link UI component within a player.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAutosize():Boolean
Returns whether the link should resize based on its text.
None.
| type | description |
| Boolean | True if the link should resize based on its text. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getFont():String
Returns the name of the font used by the link.
None.
| type | description |
| String | The name of the font used by the link. |
getHAlign():String
Returns the horizontal alignment setting, which determines how text will be positioned within the component.
None.
| type | description |
| String | The horizontal alignment setting of the component. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getMultiline():Boolean
Returns whether the link can render its text across multiple lines.
None.
| type | description |
| Boolean | True if the link can render its text across multiple lines. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getText():String
Returns the text currently displayed in the link.
None.
| type | description |
| String | The text currently displayed in the link. |
getTextSize():Number
Returns the point size of the text in the link, if overridden from the style, or -1 otherwise.
None.
| type | description |
| Number | The point size of the text in the link, if overridden from the style, or -1. |
getTooltip():String
Returns the tooltip text that will appear on rollover of the link.
None.
| type | description |
| String | The tooltip text that will appear on rollover of the link. |
getURL():String
Returns the URL that will be navigated to (in a new browser window) when the link is clicked.
None.
| type | description |
| String | The URL that will be navigated to when the link is clicked. |
getVAlign():String
Returns the vertical alignment setting, which determines how text will be positioned within the component.
None.
| type | description |
| String | The vertical alignment setting of the component. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAutosize(autosize:Boolean):void
Sets whether the link should resize based on its text.
| name | type | description |
| autosize | Boolean | True if the link should resize based on its text. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setFont(font:String):void
Sets the name of the font used by the link. This font must have been embedded through the markup
| name | type | description |
| font | String | The name of the font to be used by the link. This font must have been embedded through the markup |
None.
setHAlign(align:String):void
Sets the horizontal alignment setting, which determines how text will be positioned within the component.
| name | type | description |
| align | String | The horizontal alignment setting of the component. Valid arguments include "left", "center" and "right". |
None.
setMultiline(multiline:Boolean):void
Sets whether the link can render its text across multiple lines.
| name | type | description |
| multiline | Boolean | True if the link can render its text across multiple lines. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setText(text:String):void
Sets the text to display in the link.
| name | type | description |
| text | String | The text to display in the link. |
None.
setTextSize(size:Number):void
Sets the point size of the text in the link.
| name | type | description |
| size | Number | The point size of the text in the link, or -1 to remove the style override. |
None.
setTooltip(text:String):void
Sets the tooltip text that will appear on rollover of the link.
| name | type | description |
| text | String | The tooltip text that will appear on rollover of the link. |
None.
setURL(url:String):void
Sets the URL that will be navigated to (in a new browser window) when the link is clicked.
| name | type | description |
| url | String | The URL that will be navigated to when the link is clicked. |
None.
setVAlign(alignment:String):void
Sets the vertical alignment setting, which determines how text will be positioned within the component.
| name | type | description |
| alignment | String | The vertical alignment setting of the component. Valid arguments include "top", "middle" and "bottom". |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
A List UI component within a player.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAutomaticAdvance():Boolean
Returns whether the list will automatically advance through the selection of its items.
None.
| type | description |
| Boolean | Whether the list will automatically advance through the selection of its items. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getData():Array
Returns all of the data currently stored and rendered in the list.
None.
| type | description |
| Array | The data stored and rendered in the list. |
getDataAtIndex(index:Number):Object
Returns the data stored in the item in the list at the specified index position.
| name | type | description |
| index | Number | The index position of the item from which to retrieve data. |
| type | description |
| Object | The data stored in the item in the list at the specified index position. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getItemInsetH():Number
Returns the pixel amount each list item is inset horizontally from the sides of the list component.
None.
| type | description |
| Number | The pixel amount each list item is inset horizontally from the sides of the list component. |
getItemInsetV():Number
Returns the pixel amount each list item is inset vertically from the top and bottom of the list component.
None.
| type | description |
| Number | The pixel amount each list item is inset vertically from the top and bottom of the list component. |
getItemLeading():Number
Returns the vertical pixel amount between each item in the list.
None.
| type | description |
| Number | The vertical pixel amount between each item in the list. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getNumItems():Number
Returns the number of items currently stored and rendered in the list. This is not just visible items, but all items in the list's data property.
None.
| type | description |
| Number | The number of items stored and rendered in the list. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getRowHeight():Number
Returns the pixel height of items in the list.
None.
| type | description |
| Number | The pixel height of items in the list. |
getScrollerInset():Number
Returns the pixel amount the scroller is inset horizontally from the side of the list.
None.
| type | description |
| Number | The pixel amount the scroller is inset horizontally from the side of the list. |
getScrollerWidth():Number
Returns the pixel width of the scroller.
None.
| type | description |
| Number | The pixel width of the scroller. |
getSelectedData():Object
Returns the data stored in the currently selected item in the list.
None.
| type | description |
| Object | The data stored in the currently selected item in the list. |
getSelectedIndex():Number
Returns the index position of the currently selected item in the list.
None.
| type | description |
| Number | The index position of the currently selected item in the list. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
scrollTo(index:Number):void
Scrolls the list to the reveal the item at the specified position. The item will appear at the top of the list, unless the item is located at or near the bottom of the items in the list, in which case it will appear as close to the top of the list as the maximum scroll position will allow.
| name | type | description |
| index | Number | The index position of the item to scroll to. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAutomaticAdvance(advance:Boolean):void
Sets whether the list will automatically advance through the selection of its items.
| name | type | description |
| advance | Boolean | Whether the list will automatically advance through the selection of its items. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setData(data:Array):void
Returns all of the data currently stored and rendered in the list.
| name | type | description |
| data | Array | An array of items to render in the list. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setItemInsetH(inset:Number):void
Sets the pixel amount items in the list will be inset horizontally from the sides of the component.
| name | type | description |
| inset | Number | The pixel amount items in the list will be inset horizontally from the sides of the component. |
None.
setItemInsetV(inset:Number):void
Sets the pixel amount items in the list will be inset vertically from the top and bottom of the component.
| name | type | description |
| inset | Number | The pixel amount items in the list will be inset vertically from the top and bottom of the component. |
None.
setItemLeading(leading:Number):void
Sets the vertical pixel amount between items in the list.
| name | type | description |
| leading | Number | The vertical pixel amount between items in the list. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setRowHeight(height:Number):void
Sets the pixel height for items in the list.
| name | type | description |
| height | Number | The pixel height for items in the list. |
None.
setScrollerInset(inset:Number):void
Sets the pixel amount that the scroller is inset horizontally from the sides of the component.
| name | type | description |
| inset | Number | The pixel amount that the scroller is inset horizontally from the sides of the component. |
None.
setScrollerWidth(width:Number):void
Sets the pixel width of the scroller.
| name | type | description |
| width | Number | The pixel width of the scroller. |
None.
setSelectedIndex(index:Number):void
Sets a new selected item in the list by passing in the index position of that item.
| name | type | description |
| index | Number | The index position of the item to select. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
showPlaylist(playlistID:Number):Boolean
A shortcut function to render the specified playlist's videos in the list. The playlist must have been previously loaded into the player to render.
| name | type | description |
| playlistID | Number | The ID of the playlist with videos to render. |
| type | description |
| Boolean | Whether the playlist requested was found and rendered. |
propertyChange
Event fired when bindable properties of the component change.
| name | type | description |
| event.type: | String | propertyChange |
| event.property: | String | The name of the property that changed. |
A container element for UI controls for media playback.
appendChild(definition:String):Boolean
Adds a new child component to the end of the box children array.
| name | type | description |
| definition | String | The XML definition, as a string, to be used by the new component. |
| type | description |
| Boolean | True if the component was successfully added. |
getAlign():String
Returns how child components align within the box, if supported by the particular box component.
None.
| type | description |
| String | The alignment setting of the box. |
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getBackgroundColor():Number
Returns the background color of the box, or -1 if no color is assigned.
None.
| type | description |
| Number | The background color of the box, or -1 if none is assigned. |
getBackgroundImage():String
Returns the background image loaded for the box.
None.
| type | description |
| String | The background image loaded for the box. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getChildAt(index:Number):Object
Returns a reference to the component at the specified index position.
| name | type | description |
| index | Number | The index position from which to retrieve the component reference. |
| type | description |
| Object | A reference to the component at the specified index position. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getGutter():Number
Returns the number of pixels for the buffer between components in the box.
None.
| type | description |
| Number | The number of pixels for the buffer between components in the box. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getNumChildren():Number
Returns the number of children currently in the box.
None.
| type | description |
| Number | The number of children currently in the box. |
getPadding():Number
Returns the number of pixels for the border of the box.
None.
| type | description |
| Number | The number of pixels for the border of the box. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
insertChildAt(definition:String, index:Number):Boolean
Adds a new child component at the specified position in the box children array.
| name | type | description |
| definition | String | The XML definition, as a string, to be used by the new component. |
| index | Number | The index position in which to insert the new component. |
| type | description |
| Boolean | True if the component was successfully added. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
removeChildByID(ID:String):Boolean
Removes a child component with the specified ID from the box children array.
| name | type | description |
| ID | String | The ID of the child component. |
| type | description |
| Boolean | True if the child was successfully removed. |
setAlign(alignment:String):void
Sets how child components align within the box, if supported by the particular box component.
| name | type | description |
| alignment | String | The alignment setting of the box. Depending on the box, this could be "top", "middle", "bottom", "left", "center" or "right". |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setBackgroundColor(color:Number):void
Sets the background color of the box.
| name | type | description |
| color | Number | The background color of the box, or -1 to remove color. |
None.
setBackgroundImage(file:String):void
Sets the background image to load for the box.
| name | type | description |
| file | String | The background image to load for the box. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setGutter(gutter:Number):void
Sets the number of pixels for the buffer between components in the box.
| name | type | description |
| gutter | Number | The number of pixels for the buffer between components in the box. |
None.
setPadding(padding:Number):void
Sets the number of pixels for the border of the box.
| name | type | description |
| padding | Number | The number of pixels for the border of the box. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
A UI component that allows for scrubbing through a media file.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getSliderWidth():Number
Returns the pixel width of the playhead slider.
None.
| type | description |
| Number | The pixel width of the playhead slider. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setSliderWidth(width:Number):void
Sets the pixel width of the playhead slider.
| name | type | description |
| width | Number | The pixel width of the playhead slider. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
Synched Banner component within a player.
expand():void
Expands the banner.
None.
None.
contract():void
Contracts the banner.
None.
None.
getExpanded():Boolean
Returns whether or not the banner is expanded.
None.
| type | description |
| Boolean | Boolean specifying expanded state. |
synchBannerWithExternal(adObj:Object):void
Allows for the player to render the synched banner units without playing a video ad. The banners are rendered above the disabled player and navigation so they may be clicked on for click-thru functionality. This enables a DHTML video ad outside of the player to synch with banner assets within the player.
| name | type | description |
| adObj | Object | An object containing properties that match the rich media ad template for a synched banner accepted by the player. [more descriptive explanation of these ad objects can be found in the ad docs] |
| type | description |
| void |
Provides methods to load and interact with custom SWFs within your player.
callSWFMethod(method:String, ...params:*):Object
Calls a specified method in the loaded SWF.
| name | type | description |
| method | String | The name of the method to call on the loaded SWF. |
| ...params | * | A variable number of arguments to pass to the method. |
| type | description |
| Object | Whatever value is returned by the called method. |
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getSource():String
Returns the URL path to the currently loaded SWF.
None.
| type | description |
| String | The URL path to the currently loaded SWF. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setSource(file:String):void
Loads a new SWF into the component.
| name | type | description |
| file | String | The URL path to the SWF to load. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
A UI component that provides a horizontal series of tabs within a player.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
appendTab(tabData:Object):void
Inserts a new tab at the end of the list of tabs.
| name | type | description |
| tabData | Object | The data to be used by the new tab. |
None.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAutoSizeTabs():Boolean
Returns whether tabs resize based on their labels or whether they are fixed width.
None.
| type | description |
| Boolean | True if tabs resize based on their labels or whether they are fixed width. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getData():Array
Returns all of the data currently stored and rendered in the list.
None.
| type | description |
| Array | The data stored and rendered in the list. |
getDataAtIndex(index:Number):Object
Returns the data stored in the item in the list at the specified index position.
| name | type | description |
| index | Number | The index position of the item from which to retrieve data. |
| type | description |
| Object | The data stored in the item in the list at the specified index position. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getHideSingleTab():Boolean
Returns whether the tab bar is made invisible when only a single item is assigned to it.
None.
| type | description |
| Boolean | Whether the tab bar is made invisible when only a single item is assigned to it. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIncludeMenu():Boolean
Returns whether the tabs should include a drop down menu for quick access of items.
None.
| type | description |
| Boolean | Whether the tabs should include a drop down menu for quick access of items. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getLabelBuffer():Number
Returns the horizontal pixel space to the left and right of the label within a tab.
None.
| type | description |
| Number | The horizontal pixel space to the left and right of the label within a tab. |
getLabelField():String
Returns the field in the data object that will be used for labels in the tabs.
None.
| type | description |
| String | The field in the data object that will be used for labels in the tabs. |
getMaxMenuRows():Number
Returns the maximum number of menu rows that can appear in the drop down menu before paging.
None.
| type | description |
| Number | The maximum number of menu rows that can appear in the drop down menu before paging. |
getMenuItemInset():Number
Returns the pixel amount that labels for menu items are inset from the sides of the drop down menu.
None.
| type | description |
| Number | The pixel amount that labels for menu items are inset from the sides of the drop down menu. |
getMenuRowHeight():Number
Returns the pixel height of an item in the drop down menu.
None.
| type | description |
| Number | The pixel height of an item in the drop down menu. |
getMenuWidth():Number
Returns the pixel width of the drop down menu.
None.
| type | description |
| Number | The pixel width of the drop down menu. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getNumItems():Number
Returns the number of items currently stored and rendered in the list. This is not just visible items, but all items in the list's data property.
None.
| type | description |
| Number | The number of items stored and rendered in the list. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getSelectedData():Object
Returns the data stored in the currently selected item in the list.
None.
| type | description |
| Object | The data stored in the currently selected item in the list. |
getSelectedIndex():Number
Returns the index position of the currently selected item in the list.
None.
| type | description |
| Number | The index position of the currently selected item in the list. |
getTabAlign():String
Returns whether tabs are aligned to the left, right or center as they build.
None.
| type | description |
| String | Whether tabs are aligned to the left, right or center as they build. |
getTabPadding():Number
Returns the horizontal pixel space between tabs.
None.
| type | description |
| Number | The horizontal pixel space between tabs. |
getTabWidth():Number
Returns the fixed pixel width of a tab if autoSizeTabs is set to false.
None.
| type | description |
| Number | The fixed pixel width of a tab if autosizeTabs is set to false. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
insertTabAt(tabData:Object, index:Number):void
Inserts a new tab at the specified index in the list of tabs.
| name | type | description |
| tabData | Object | The data to be used by the new tab. |
| index | Number | The index in the list at which to insert the new tab. |
None.
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
removeTabAt(index:Number):void
Removes the tab at the specified index in the list of tabs.
| name | type | description |
| index | Number | The index in the list from which to remove the tab. |
None.
replaceTabAt(tabData:Object, index:Number):void
Replaces a tab at the specified index in the list of tabs with new data.
| name | type | description |
| tabData | Object | The data to be used by the new tab. |
| index | Number | The index in the list at which to replace the tab. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAutoSizeTabs(autoSize:Boolean):void
Sets whether tabs resize based on their labels or whether they are fixed width.
| name | type | description |
| autoSize | Boolean | True if tabs resize based on their labels; false if they are fixed width. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setData(data:Array):void
Sets the data to be stored and rendered in the list.
| name | type | description |
| data | Array | An array of items to render in the list. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setHideSingleTab(hide:Boolean):void
Sets whether the tab bar should be made invisible when only a single item is assigned to it.
| name | type | description |
| hide | Boolean | Whether the tab bar should be made invisible when only a single item is assigned to it. |
None.
setIncludeMenu(include:Boolean):void
Sets whether the tabs should include a drop down menu for quick access of items.
| name | type | description |
| include | Boolean | Whether the tabs should include a drop down menu for quick access of items. |
None.
setLabelBuffer(buffer:Number):void
Sets the horizontal pixel space to the left and right of the label within a tab.
| name | type | description |
| buffer | Number | The horizontal pixel space to the left and right of the label within a tab. |
None.
setLabelField(buffer:Number):void
Sets the field in the data object that will be used for labels in the tabs.
| name | type | description |
| buffer | Number | The field in the data object that will be used for labels in the tabs. |
None.
setMaxMenuRows(rows:Number):void
Sets the maximum number of menu rows that can appear in the drop down menu before paging.
| name | type | description |
| rows | Number | The maximum number of menu rows that can appear in the drop down menu before paging. |
None.
setMenuItemInset(inset:Number):void
Sets the pixel amount that labels for menu items are inset from the sides of the drop down menu.
| name | type | description |
| inset | Number | The pixel amount that labels for menu items are inset from the sides of the drop down menu. |
None.
setMenuRowHeight(height:Number):void
Sets the pixel height of an item in the drop down menu.
| name | type | description |
| height | Number | The pixel height of an item in the drop down menu. |
None.
setMenuWidth(width:Number):void
Sets the pixel width of the drop down menu.
| name | type | description |
| width | Number | The pixel width of the drop down menu. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSelectedIndex(index:Number):void
Sets a new selected item in the list by passing in the index position of that item.
| name | type | description |
| index | Number | The index position of the item to select. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setTabAlign(alignment:String):void
Sets whether tabs are aligned to the left, right or center as they build.
| name | type | description |
| alignment | String | Whether tabs are aligned to the left, right or center as they build. |
None.
setTabPadding(padding:Number):Number
Sets the horizontal pixel space between tabs.
| name | type | description |
| padding | Number | The horizontal pixel space between tabs. |
None.
setTabWidth(width:Number):void
Sets the fixed pixel width of a tab if autoSizeTabs is set to false.
| name | type | description |
| width | Number | The fixed pixel width of a tab if autosizeTabs is set to false. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
propertyChange
Event fired when bindable properties of the component change.
| name | type | description |
| event.type: | String | propertyChange |
| event.property: | String | The name of the property that changed. |
A TileList UI component within a player.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAnimationType():String
Returns how a page will animate in: (move || wipe || scale || none).
None.
| type | description |
| String | How a page will animate in: (move || wipe || scale || none). |
getAutomaticAdvance():Boolean
Returns whether the list will automatically advance through the selection of its items.
None.
| type | description |
| Boolean | Whether the list will automatically advance through the selection of its items. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getButtonOffsetX():Number
Returns the pixel amount that the nav buttons will be moved horizontally in a vertical list.
None.
| type | description |
| Number | The pixel amount that the nav buttons will be moved horizontally in a vertical list. |
getButtonOffsetY():Number
Returns the pixel amount that the nav buttons will be moved vertically in a horizontal list.
None.
| type | description |
| Number | The pixel amount that the nav buttons will be moved vertically in a horizontal list. |
getButtonSize():Number
Returns the pixel size, width and height, of the navigation buttons.
None.
| type | description |
| Number | The pixel size, width and height, of the navigation buttons. |
getCenterContent():Boolean
Returns whether the list centers its content within its area.
None.
| type | description |
| Boolean | True if content centers within content area. |
getColumnCount():Number
Returns the number of columns that can be rendered based on the size settings.
None.
| type | description |
| Number | The number of columns that can be rendered based on the size settings. |
getColumnGutter():Number
Returns the pixel gutter between each column.
None.
| type | description |
| Number | The pixel gutter between each column. |
getColumnWidth():Number
Returns the pixel width of each visual column in the list.
None.
| type | description |
| Number | The pixel width of each visual column in the list. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getContentInsetH():Number
Returns the pixel space that items are inset horizontally from the top and bottom of the list.
None.
| type | description |
| Number | The pixel space that items are inset horizontally from the top and bottom of the list. |
getContentInsetV():Number
Returns the pixel space that items are inset horizontally from the top and bottom of the list.
None.
| type | description |
| Number | The pixel space that items are inset vertically from the top and bottom of the list. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getData():Array
Returns all of the data currently stored and rendered in the list.
None.
| type | description |
| Array | The data stored and rendered in the list. |
getDataAtIndex(index:Number):Object
Returns the data stored in the item in the list at the specified index position.
| name | type | description |
| index | Number | The index position of the item from which to retrieve data. |
| type | description |
| Object | The data stored in the item in the list at the specified index position. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getNumColumns():Number
Returns the number of columns represented visually for the list.
None.
| type | description |
| Number | The number of columns represented visually for the list. |
getNumItems():Number
Returns the number of items currently stored and rendered in the list. This is not just visible items, but all items in the list's data property.
None.
| type | description |
| Number | The number of items stored and rendered in the list. |
getNumPages():Number
Returns the number of pages of data in the list.
None.
| type | description |
| Number | The number of pages of data in the list. |
getNumRows():Number
Returns the number of rows represented visually for the list.
None.
| type | description |
| Number | The number of rows represented visually for the list. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getRowCount():Number
Returns the number of rows that can be rendered based on the size settings.
None.
| type | description |
| Number | The number of rows that can be rendered based on the size settings. |
getRowGutter():Number
Returns the pixel gutter between each row.
None.
| type | description |
| Number | The pixel gutter between each row. |
getRowHeight():Number
Returns the pixel height of each visual row in the list.
None.
| type | description |
| Number | The pixel height of each visual row in the list. |
getScrollDirection():String
Returns the direction that pages will be scrolled, horizontal or vertical.
None.
| type | description |
| String | The direction that pages will be scrolled, horizontal or vertical. |
getSelectedData():Object
Returns the data stored in the currently selected item in the list.
None.
| type | description |
| Object | The data stored in the currently selected item in the list. |
getSelectedIndex():Number
Returns the index position of the currently selected item in the list.
None.
| type | description |
| Number | The index position of the currently selected item in the list. |
getUseBlur():Boolean
Returns whether the list should blur its items when animating to new pages using the 'move' animation type.
None.
| type | description |
| Boolean | True to blur the list's items when animating to new pages. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAnimationType(type:String):void
Sets how a page will animate in: (move || wipe || scale || none).
| name | type | description |
| type | String | How a page will animate in: (move || wipe || scale || none). |
None.
setAutomaticAdvance(advance:Boolean):void
Sets whether the list will automatically advance through the selection of its items.
| name | type | description |
| advance | Boolean | Whether the list will automatically advance through the selection of its items. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setButtonOffsetX(offset:Number):void
Sets the pixel amount that the nav buttons will be moved horizontally in a vertical list.
| name | type | description |
| offset | Number | The pixel amount that the nav buttons will be moved horizontally in a vertical list. |
None.
setButtonOffsetY(offset:Number):void
Sets the pixel amount that the nav buttons will be moved vertically in a horizontal list.
| name | type | description |
| offset | Number | The pixel amount that the nav buttons will be moved vertically in a horizontal list. |
None.
setButtonSize(size:Number):void
Sets the pixel size, width and height, of the navigation buttons.
| name | type | description |
| size | Number | The pixel size, width and height, of the navigation buttons. |
None.
setCenterContent(center:Boolean):void
Sets whether the list should center its content within its area.
| name | type | description |
| center | Boolean | True to have content centered within content area. |
None.
setColumnGutter(gutter:Number):void
Sets the pixel gutter between each column.
| name | type | description |
| gutter | Number | The pixel gutter between each column. |
None.
setColumnWidth(width:Number):void
Sets the pixel width of each visual column in the list.
| name | type | description |
| width | Number | The pixel width of each visual column in the list. |
None.
setContentInsetH(inset:Number):void
Sets the pixel space that items are inset horizontally from the top and bottom of the list.
| name | type | description |
| inset | Number | The pixel space that items are inset horizontally from the top and bottom of the list. |
None.
setContentInsetV(inset:Number):void
Sets the pixel space that items are inset vertically from the top and bottom of the list.
| name | type | description |
| inset | Number | The pixel space that items are inset vertically from the top and bottom of the list. |
None.
setData(data:Array):void
Returns all of the data currently stored and rendered in the list.
| name | type | description |
| data | Array | An array of items to render in the list. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setNumColumns(columns:Number):void
Sets the number of columns represented visually for the list.
| name | type | description |
| columns | Number | The number of columns represented visually for the list. |
None.
setNumRows(rows:Number):void
Sets the number of rows represented visually for the list.
| name | type | description |
| rows | Number | The number of rows represented visually for the list. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setRowGutter(gutter:Number):void
Sets the pixel gutter between each row.
| name | type | description |
| gutter | Number | The pixel gutter between each row. |
None.
setRowHeight(height:Number):void
Sets the pixel height of each visual row in the list.
| name | type | description |
| height | Number | The pixel height of each visual row in the list. |
None.
setScrollDirection(direction:String):void
Sets the direction that pages will be scrolled, horizontal or vertical.
| name | type | description |
| direction | String | The direction that pages will be scrolled, horizontal or vertical. |
None.
setSelectedIndex(index:Number):void
Sets a new selected item in the list by passing in the index position of that item.
| name | type | description |
| index | Number | The index position of the item to select. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setUseBlur(useBlur:Boolean):void
Sets whether the list should blur its items when animating to new pages use the 'move' animation type.
| name | type | description |
| useBlur | Boolean | True to blur the list's items when animating to new pages. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
showNextPage():Boolean
Renders and tweens to the next page of the current data.
None.
| type | description |
| Boolean | True if next page is valid page and can be moved to in the list's current state. |
showPlaylist(playlistID:Number):Boolean
A shortcut function to render the specified playlist's videos in the list. The playlist must have been previously loaded into the player to render.
| name | type | description |
| playlistID | Number | The ID of the playlist with videos to render. |
| type | description |
| Boolean | Whether the playlist requested was found and rendered. |
showPage(pageIndex:Number):Boolean
Renders and tweens on the specified page of the current data.
| name | type | description |
| pageIndex | Number | The index of the page to show. |
| type | description |
| Boolean | True if page is valid page and can be moved to in the list's current state. |
showPreviousPage():Boolean
Renders and tweens to the previous page of the current data.
None.
| type | description |
| Boolean | True if previous page is valid page and can be moved to in the list's current state. |
propertyChange
Event fired when bindable properties of the component change.
| name | type | description |
| event.type: | String | propertyChange |
| event.property: | String | The name of the property that changed. |
A UI component that allows for performing actions on user clicks, toggling between two states.
getAlpha():Number
Returns the current opacity of the component between 0 and 1.
None.
| type | description |
| Number | The current opacity of the component between 0 and 1. |
getAutoSize():Boolean
Returns whether the button should resize based on its label.
None.
| type | description |
| Boolean | True if the button should resize based on its label. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the component.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the component. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getDefinition():String
Returns the XML markup that defines the component.
None.
| type | description |
| String | The XML markup, as a string, that defines the component. |
getEnabled():Boolean
Returns whether the component is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the component is currently enabled for user interaction. |
getFont():String
Returns the name of the font used by the label.
None.
| type | description |
| String | The name of the font used by the label. |
getHeight():Number
Returns the pixel height of the component.
None.
| type | description |
| Number | The current pixel height of the component. |
getIconAlignmentH():String
Returns the horizontal alignment for the icon.
None.
| type | description |
| String | The horizontal alignment setting for the button icon. |
getIconAlignmentV():String
Returns the vertical alignment for the icon.
None.
| type | description |
| String | The vertical alignment setting for the button icon. |
getIconName():String
Returns the name of the current icon displayed.
None.
| type | description |
| String | The name of the current icon displayed. |
getIconOffsetX():Number
Returns the pixel amount on the x axis the icon is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the x axis the icon is offset from its aligned position. |
getIconOffsetY():Number
Returns the pixel amount on the y axis the icon is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the y axis the icon is offset from its aligned position. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getIsToggled():Boolean
Returns whether the button is currently in its toggled state.
None.
| type | description |
| Boolean | True if the button is currently in its toggled state. |
getIsTruncated():Boolean
Returns whether the label has been truncated due to the width of the button.
None.
| type | description |
| Boolean | True if the label has been truncated due to the width of the button. |
getLabel():String
Returns the current text in the label.
None.
| type | description |
| String | The current text in the label. |
getLabelAlignmentH():String
Returns the horizontal alignment for the label.
None.
| type | description |
| String | The horizontal alignment setting for the button label. |
getLabelAlignmentV():String
Returns the vertical alignment for the label.
None.
| type | description |
| String | The vertical alignment setting for the button label. |
getLabelBuffer():Number
Returns the minimum pixel amount to the left and right of the label.
None.
| type | description |
| Number | The pixel amount used as a visual buffer to the left and right of the label. |
getLabelSize():Number
Returns the point size of the text in the label, if overridden from the style, or -1 otherwise.
None.
| type | description |
| Number | The point size of the text in the label, if overridden from the style, or -1. |
getLabelOffsetX():Number
Returns the pixel amount on the x axis the label is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the x axis the label is offset from its aligned position. |
getLabelOffsetY():Number
Returns the pixel amount on the y axis the label is offset from its aligned position.
None.
| type | description |
| Number | The pixel amount on the y axis the label is offset from its aligned position. |
getLabelWidth():Number
Returns the pixel width of the text in the label.
None.
| type | description |
| Number | The pixel width of the text in the label. |
getMultiline():Boolean
Returns whether the label can render its text across multiple lines.
None.
| type | description |
| Boolean | True if the label can render its text across multiple lines. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the component in degrees.
None.
| type | description |
| Number | The current rotation of the component in degrees. |
getShowBack():Boolean
Returns whether the background graphic of the button is visible.
None.
| type | description |
| Boolean | True if the background graphic of the button is visible. |
getToggledIconName():String
Returns the name of the icon displayed when button is toggled.
None.
| type | description |
| String | The name of the icon displayed when button is toggled. |
getToggledLabel():String
Returns the text in the label when button is toggled.
None.
| type | description |
| String | The text in the label when button is toggled. |
getToggledTooltip():String
Returns the tooltip text that will appear on rollover of the button when toggled.
None.
| type | description |
| String | The tooltip text that will appear on rollover of the button when toggled. |
getTooltip():String
Returns the tooltip text that will appear on rollover of the button.
None.
| type | description |
| String | The tooltip text that will appear on rollover of the button. |
getTruncateLabel():Boolean
Returns whether the label should truncate if its text is greater than the button width.
None.
| type | description |
| Boolean | True if the label should truncate if its text is greater than the button width. |
getVisible():Boolean
Returns whether the component is currently visible.
None.
| type | description |
| Boolean | True if the component is currently visible. |
getWidth():Number
Returns the pixel width of the component.
None.
| type | description |
| Number | The current pixel width of the component. |
getX():Number
Returns the x coordinate position of the component.
None.
| type | description |
| Number | The current x coordinate position of the component. |
getY():Number
Returns the y coordinate position of the component.
None.
| type | description |
| Number | The current y coordinate position of the component. |
move(x:Number, y:Number):void
Moves the component to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the component. |
| y | Number | The y position to set the component. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the component between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the component between 0 and 1. |
None.
setAutoSize(autoSize:Boolean):void
Sets whether the button should resize based on its label.
| name | type | description |
| autoSize | Boolean | True if the button should resize based on its label. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the component.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the component. |
None.
setEnabled(enable:Boolean):void
Sets whether the component is currently disabled for user interaction.
| name | type | description |
| enable | Boolean | Whether the component should be enabled for user interaction. |
None.
setFont(font:String):void
Sets the name of the font used by the label. This font must have been embedded through the markup
| name | type | description |
| font | String | The name of the font to be used by the label. This font must have been embedded through the markup |
None.
setIconAlignmentH(alignment:String):void
Sets the horizontal alignment for the icon.
| name | type | description |
| alignment | String | The horizontal alignment setting for the button icon (right, center or left). |
None.
setIconAlignmentV(alignment:String):void
Sets the vertical alignment for the icon.
| name | type | description |
| alignment | String | The vertical alignment setting for the button icon (top, middle or bottom). |
None.
setIconName(name:String):void
Sets the current icon displayed.
| name | type | description |
| name | String | The name of the current icon to display (menu, play, pause, volume, maximize, minimize, share, link, code). |
None.
setIconOffsetX(offset:Number):void
Sets the pixel amount on the x axis the icon should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the x axis the icon should offset from its aligned position. |
None.
setIconOffsetY(offset:Number):void
Sets the pixel amount on the y axis the label should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the y axis the label should offset from its aligned position. |
None.
setIsToggled(toggled:Boolean):void
Sets whether the button is currently in its toggled state.
| name | type | description |
| toggled | Boolean | True to set the button in its toggled state. |
None.
setLabel(label:String):void
Sets the current text for the label.
| name | type | description |
| label | String | The text to apply to the label. |
None.
setLabelAlignmentH(alignment:String):void
Sets the horizontal alignment for the label.
| name | type | description |
| alignment | String | The horizontal alignment setting for the button label (right, center or left). |
None.
setLabelAlignmentV(alignment:String):void
Sets the vertical alignment for the label.
| name | type | description |
| alignment | String | The vertical alignment setting for the button label (top, middle or bottom). |
None.
setLabelBuffer(buffer:Number):void
Sets the minimum pixel amount to the left and right of the label.
| name | type | description |
| buffer | Number | The pixel amount to be used as a visual buffer to the left and right of the label. |
None.
setLabelOffsetX(offset:Number):void
Sets the pixel amount on the x axis the label should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the x axis the label should offset from its aligned position. |
None.
setLabelOffsetY(offset:Number):void
Sets the pixel amount on the y axis the label should be offset from its aligned position.
| name | type | description |
| offset | Number | The pixel amount on the y axis the label should offset from its aligned position. |
None.
setLabelSize(size:Number):void
Sets the point size of the text in the label.
| name | type | description |
| size | Number | The point size of the text in the label, or -1 to remove the style override. |
None.
setMultiline(multiline:Boolean):void
Sets whether the label can render its text across multiple lines.
| name | type | description |
| multiline | Boolean | True if the label can render its text across multiple lines. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the component in degrees.
| name | type | description |
| rotation | Number | The current rotation of the component in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the component.
| name | type | description |
| width | Number | The total width of the component in pixels. |
| height | Number | The total height of the component in pixels. |
None.
setToggledIconName(name:String):void
Sets the icon to display when button is toggled.
| name | type | description |
| name | String | The name of the icon to display when button is toggled (menu, play, pause, volume, maximize, minimize, share, link, code). |
None.
setToggledLabel(label:String):void
Sets the text for the label when button is toggled.
| name | type | description |
| label | String | The text to apply to the label when button is toggled. |
None.
setToggledTooltip(text:String):void
Sets the tooltip text that will appear on rollover of the button when toggled.
| name | type | description |
| text | String | The tooltip text that will appear on rollover of the button when toggled. |
None.
setTooltip(text:String):void
Sets the tooltip text that will appear on rollover of the button.
| name | type | description |
| text | String | The tooltip text that will appear on rollover of the button. |
None.
setTruncateLabel(truncate:Boolean):void
Sets whether the label should truncate if its text is greater than the button width.
| name | type | description |
| truncate | Boolean | True if the label should truncate if its text is greater than the button width. |
None.
setVisible(visible:Boolean):void
Sets whether the component is currently visible.
| name | type | description |
| visible | Boolean | Whether the component should be visible. |
None.
showBack(show:Boolean):void
Sets whether the background graphic of the button is visible.
| name | type | description |
| show | Boolean | Whether the background graphic of the button should be visible. |
None.
A reference to the video player within a player, if any. This allows for interaction with the playback of media.
addEventListener(event:String, handler:Function):void
Adds the specified object as a listener for the specified event broadcast by the player.
| name | type | description |
| event | String | The name of the event to subscribe to. |
| handler | Function | The function to invoke when the event is broadcast by the player. |
None.
cueVideo(videoID:Object, property:String):Boolean
Cues up a video in the video window without playing it. If the video DTO has not yet loaded into the player, it will be fetched from the server.
| name | type | description |
| videoID | Object | The ID or referenceID of the video to be cued. |
| property (optional) | String | The property of the video DTO in which to check for the specified ID ("id"|"referenceId"). |
| type | description |
| Boolean | True if the video DTO has already been loaded in the player, false if it needs to be fetched. |
getDisplayHeight():Number
Returns the pixel height of the video display.
None.
| type | description |
| Number | The pixel height of the video display. |
getDisplayWidth():Number
Returns the pixel width of the video display.
None.
| type | description |
| Number | The pixel width of the video display. |
getAlpha():Number
Returns the current opacity of the video player between 0 and 1.
None.
| type | description |
| Number | The current opacity of the video player between 0 and 1. |
getBlendMode():String
Returns the current ActionScript DisplayObject blend mode of the video player.
None.
| type | description |
| String | The current ActionScript DisplayObject blend mode of the video player. |
getContainer():Object
Returns a reference to the layout box container of the UI component.
None.
| type | description |
| Object | A reference to the layout box container of the UI component. |
getContentTypeDisplayed():String
Returns "ad", "bumper" or "video" based on the current media displayed in the video player.
None.
| type | description |
| String | "ad", "bumper" or "video" |
getCSS():String
Returns the styles (formatted as a CSS string) that are being used by this component.
None.
| type | description |
| String | The styles that are being used by this component formatted as CSS. |
getCurrentRendition():Object
Returns the rendition DTO for the rendition of the video currently displayed in the video window.
None.
| type | description |
| Object | The rendition DTO for the rendition of the video currently displayed in the video window. |
getCurrentVideo():Object
Returns the video DTO for the video currently in the video window.
None.
| type | description |
| Object | The video DTO for the video currently in the video window. |
getDefinition():String
Returns the XML markup that defines the video player component.
None.
| type | description |
| String | The XML markup, as a string, that defines the video player. |
getEnabled():Boolean
Returns whether the video player is currently enabled for user interaction.
None.
| type | description |
| Boolean | True if the video player is currently enabled for user interaction. |
getHeight():Number
Returns the pixel height of the player.
None.
| type | description |
| Number | The current pixel height of the player. |
getID():String
Returns the ID of the component as set from the markup.
None.
| type | description |
| String | The string ID of the component as set from the markup. |
getIndex():Number
Returns the index position of the component within its parent container's array of components.
None.
| type | description |
| Number | The index position of the component within its parent container's array of components, or -1 if the component does not exist within a container. |
getNextSibling():Object
Returns a reference to the component that follows this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that follows this component in the parent container's components array, or null if no following component exists. |
getPreviousSibling():Object
Returns a reference to the component that precedes this component in the parent container's components array.
None.
| type | description |
| Object | A reference to the component that precedes this component in the parent container's components array, or null if no previous component exists. |
getRotation():Number
Returns the current rotation of the video player in degrees.
None.
| type | description |
| Number | The current rotation of the video player in degrees. |
getVideoBytesLoaded():Number
For progressively downloaded video, returns the total number of bytes currently loaded for the video. This can be used to offer the viewer feedback about download progress.
None.
| type | description |
| Number | The total number of bytes currently loaded for the video. This can be used to offer the viewer feedback about download progress. |
getVideoBytesTotal():Number
For progressively downloaded video, returns the total number of bytes for the current video. This can be used to offer the viewer feedback about download progress.
None.
| type | description |
| Number | The total number of bytes for the current video. This can be used to offer the viewer feedback about download progress. |
getVideoDuration(format:Boolean):Object
Returns the time duration of the currently playing video in seconds.
| name | type | description |
| format (optional) | Boolean | If true, returns a formatted time string (12:34), else returns number of seconds. |
| type | description |
| Object | The time duration of the currently playing video in seconds, formatted as a string or number. |
getVideoPosition(format:Boolean):Object
Returns the time position of the currently playing video in seconds.
| name | type | description |
| format (optional) | Boolean | If true, returns a formatted time string (12:34), else returns number of seconds. |
| type | description |
| Object | The time position of the currently playing video in seconds, formatted as a string or number. |
getVisible():Boolean
Returns whether the video player is currently visible.
None.
| type | description |
| Boolean | True if the video player is currently visible. |
getVolume():Number
Returns the current volume in the player from 0 to 1.
None.
| type | description |
| Number | The current volume in the player from 0 to 1. |
getWidth():Number
Returns the pixel width of the player.
None.
| type | description |
| Number | The current pixel width of the player. |
getX():Number
Returns the x coordinate position of the player.
None.
| type | description |
| Number | The current x coordinate position of the player. |
getY():Number
Returns the y coordinate position of the player.
None.
| type | description |
| Number | The current y coordinate position of the player. |
goFullScreen(fullScreen:Boolean):void
Sets the display mode for the player, full screen or default. This method cannot be accessed from JavaScript.
| name | type | description |
| fullScreen | Boolean | True to set the video screen to full screen. |
None.
isMuted():Boolean
Returns whether the audio in the video player is currently muted.
None.
| type | description |
| Boolean | True if the audio in the video player is currently muted. |
isPlaying():Boolean
Returns whether the video currently displayed in the video window is playing.
None.
| type | description |
| Boolean | True if the video currently displayed in the video window is playing. |
loadVideo(videoID:Object, property:String, playMode:String):Boolean
Plays a video in the video window. If the video DTO has not yet loaded into the player, it will be fetched from the server.
| name | type | description |
| videoID | Object | The ID or referenceID of the video to be played. |
| property (optional) | String | The property of the video DTO in which to check for the specified ID ("id"|"referenceId"). |
| playMode (optional) | String | The mode to play the video in ("preview"|"full"|"aftermix"). |
| type | description |
| Boolean | True if the video DTO has already been loaded in the player, false if it needs to be fetched. |
move(x:Number, y:Number):void
Moves the player to the specified coordinate position.
| name | type | description |
| x | Number | The x position to set the player. |
| y | Number | The y position to set the player. |
None.
mute(mute:Boolean):void
Mutes or unmutes the volume of the current media in the video window, whether video or ad content.
| name | type | description |
| mute | Boolean | True to mute the volume, false to unmute. |
None.
pause(pause:Boolean):void
Pauses or resumes playback of the current media in the video window, whether video or ad content. This method acts as a toggle, where calling pause() on a video currently paused will resume playback and calling the same on a video that is currently playing will pause its playback. The toggling can be overridden by passing a Boolean value to the method.
| name | type | description |
| pause (optional) | Boolean | Overrides the toggling nature of the method. Passing a true value will always pause the video playback. Passing false will always resume playback. |
None.
play():void
Starts or resumes playback of the current video or ad in the video window.
None.
None.
removeEventListener(event:String, handler:Function):void
Removes the specified object as a listener for the specified event broadcast by the player to which the listener previously subscribed.
| name | type | description |
| event | String | The name of the event originally subscribed to. |
| handler | Function | The function previously assigned as the handler for the event. |
None.
seek(time:Number):void
Seeks to a specified time position in seconds in the video.
| name | type | description |
| time | Number | The time in seconds to seek to. |
None.
setAlpha(alpha:Number):void
Sets the current opacity of the video player between 0 and 1.
| name | type | description |
| alpha | Number | The current opacity of the video player between 0 and 1. |
None.
setBlendMode(alpha:Number):void
Sets the current ActionScript DisplayObject blend mode of the video player.
| name | type | description |
| alpha | Number | The current ActionScript DisplayObject blend mode of the video player. |
None.
setEnabled(enable:Boolean):void
Sets whether the video player is currently disabled for viewer interaction.
| name | type | description |
| enable | Boolean | Whether the video player should be enabled for viewer interaction. |
None.
setRenditionSelectionCallback
(callback:Function):void
Sets the function that will be called whenever the player needs to select a new rendition of the current video. This occurs on initial playback of the video, and for streaming videos whenever there are multiple buffering events within a few seconds or when the size of the video display changes, as when going to full screen. The signature of the function passed to this method must accept a single object as a parameter and return an int value. The int represents the index of the rendition to use. The object passed to the method contains several parameters, including the video DTO (video), the current rendition (currentRendition), the list of renditions to select from (renditions), the last detected bandwidth value (detectedBandwidth) and the screen dimensions (screenWidth and screenHeight). Logic in the function should take this data and return an int value for the rendition in the list to play back.
| name | type | description |
| callback | Function | The function that should be called whenever a new rendition for playback needs to be determined. |
None.
setRotation(rotation:Number):void
Sets the current rotation of the video player in degrees.
| name | type | description |
| rotation | Number | The current rotation of the video player in degrees. |
None.
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the video player.
| name | type | description |
| width | Number | The total width of the player in pixels. |
| height | Number | The total height of the player in pixels. |
None.
setStyles(styles:String):void
Applies new CSS to a component by accepting a semicolon-delimited list of key/color values.
| name | type | description |
| styles | String | A semicolon-delimited list of key/color values in the form of "key:#nnnnnn;key:#nnnnnn" to apply to the component. |
None.
setVideoFilter(filter:Object):void
Applies a bitmap video filter to the currently displayed video.
| name | type | description |
| filter | Object | The object describing the filter to apply, including a type property and any additional parameters specific to the filter. |
None.
setVisible(visible:Boolean):void
Sets whether the video player is currently visible.
| name | type | description |
| visible | Boolean | Whether the video player should be visible. |
None.
setVolume(volume:Number):void
Sets the volume for video playback in the player.
| name | type | description |
| volume | Number | A number between 0 and 1 to specify volume level. |
None.
showVolumeControls(show:Boolean):void
Opens or closes the volume controls over the video window.
| name | type | description |
| show (optional) | Boolean | True to open the controls, false to close them. |
None.
stop():void
Stops playback of the current video in the video window, sending its position to the start.
None.
None.
toggleMenuPage(page:String, video:String):void
Toggles Brightcove menu, opening to specified page with data displayed for the video passed in, or closing menu if page is displayed.
| name | type | description |
| page (optional) | String | The name of the page to display (Info, Email, Link, Embed). |
| video (optional) | String | The video DTO to use for the data of the menu). |
None.
toggleVolumeControls():void
Toggles the volume controls opened and closed.
None.
None.
endBuffering
(deprecated)
Event fired when buffering of content has completed in the video player and playback has started or resumed.
| name | type | description |
| event.type: | String | endBuffering |
propertyChange
Event fired when bindable properties of the component change.
| name | type | description |
| event.type: | String | propertyChange |
| event.property: | String | The name of the property that changed. |
renditionChange
Event fired when a new rendition of the video has been loaded into the video player.
| name | type | description |
| event.type: | String | renditionChange |
| event.rendition: | Object | RenditionDTO |
videoComplete
(deprecated)
Event fired when video content completes playback by reaching its duration.
| name | type | description |
| event.type: | String | videoComplete |
| event.position: | Number | The current playback position in the media. |
| event.duration: | Number | The total duration of the media. |
videoConnect
(deprecated)
Event fired when video content has been connected to and is ready to be played back. This is useful for streaming FLV content that requires an initial connection to Flash Media Server first be established before playback.
| name | type | description |
| event.type: | String | videoConnect |
| event.position: | Number | The current playback position in the media. |
| event.duration: | Number | The total duration of the media. |
videoLoad
(deprecated)
Event fired for all types of video content (SWF, progressive FLV and streaming FLV) when the initial request for data is made.
| name | type | description |
| event.type: | String | videoLoad |
videoProgress
(deprecated)
Event fired every 40 milliseconds as video content plays back in the video window. This event can be used to display progress to the viewer.
| name | type | description |
| event.type: | String | videoProgress |
| event.position: | Number | The current playback position in the media. |
| event.duration: | Number | The total duration of the media. |
videoStart
(deprecated)
Event fired when video content begins play back in the video window. This can be when it initially begins to play or after the viewer pauses and resumes playback.
| name | type | description |
| event.type: | String | videoStart |
| event.position: | Number | The current playback position in the media. |
| event.duration: | Number | The total duration of the media. |
videoStop
(deprecated)
Event fired when video content stops playing back in the video window. This can be when it completes or when the viewer pauses playback.
| name | type | description |
| event.type: | String | videoStop |
| event.position: | Number | The current playback position in the media. |
| event.duration: | Number | The total duration of the media. |
mute
(deprecated)
Event fired when the video player is either muted or unmuted.
| name | type | description |
| event.type: | String | ui_mute |
seek
(deprecated)
Event fired when a video is sent to a new position, either through code or viewer interaction with the playhead.
| name | type | description |
| event.type: | String | seek |
| event.position: | Number | The position in the media in the media that the seek command is attempting to send the video to. Note that this is not necessarily the current position of the video itself. |
| event.duration: | Number | The total duration of the media. |
startBuffering
(deprecated)
Event fired when video playback stops in order to buffer more data according the required buffer amount as determined by the viewer's detected bandwidth and the player's buffering algorithm.
| name | type | description |
| event.type: | String | startBuffering |
streamStart
(deprecated)
Event fired when a video first begins to play. This event is only fired once for a video, not multiple times as can occur with videoStart.
| name | type | description |
| event.type: | String | streamStart |
| event.position: | Number | The current playback position in the media. |
| event.duration: | Number | The total duration of the media. |
volumeChange
(deprecated)
Event fired when the volume slider is used to change the video's volume.
| name | type | description |
| event.type: | Object | volumeChange |
ui_pause
Event fired when the pause button in the controls is clicked.
| name | type | description |
| event.type: | String | ui_pause |
ui_play
Event fired when the play button in the controls is clicked.
| name | type | description |
| event.type: | String | ui_play |
A reference to social media tools within a player.
shareVideoViaEmail(fromEmail:String, toEmails:String, message:String):Boolean
Sends a link to the current video via email.
| name | type | description |
| fromEmail | String | A string containing the email of the sender. |
| toEmails | String | A comma-delimited string of email addresses to send the link to. |
| message | String | An optional string containing a message from the sender. |
| type | description |
| Boolean | True if fromEmail and toEmails are all valid email address. False if any are not valid, in which case, mail will not be sent. |
getEmbedCode(videoID:String):void
Retrieves the embed code for the specified video or, if no video ID is specified, retrieves the embed code for the currently loaded video. A handler for the "embedCodeRetrieved" event must be added in order to access the embed code snippet.
| name | type | description |
| videoID | String | A string containing the video ID of the video embed snippet you wish to retrieve. If this value is not specified then the currently loaded video will be retrieved. |
None.
getLink():String
Retrieves a link to the current player.
None.
| type | description |
| String | A string containing a link to the current player. |
getRSS():String
Retrieves the RSS link to the current player.
None.
| type | description |
| String | A string containing an RSS link to the current player. |
setLink(url:String):void
Sets the URL base for any links generated by the player.
| name | type | description |
| url | String | The URL that should be used as the base for links generated by the player. |
None.
embedCodeRetrieved
Event fired when the embed code has been retrieved for a player.
| name | type | description |
| event.type: | String | embedCodeRetrieved |
| event.args.snippet | String | The embed code for the specified video. |
A reference to the video player menu within a player, if a video player exists. This allows for interaction with menu functionality and features.
closeMenuPage():void
Closes any menu page, if open.
None.
None.
getCurrentMenuPage():String
Returns the string name of the current menu page.
None.
| type | description |
| String | The string name of the current menu page, or null if the menu is closed. |
getOverlayMenuVisible():Boolean
Returns Whether or not the overlay menu is currently visible.
None.
| type | description |
| Boolean | True if the overlay menu is currently visible, false otherwise. |
isMenuPageShowing():Boolean
Returns whether a menu page is showing or not.
None.
| type | description |
| Boolean | True if a menu page is showing. False otherwise. |
isOverlayMenuShowing():Boolean
Returns whether the overlay menu is showing or not.
None.
| type | description |
| Boolean | True if the overlay menu is showing. False otherwise. |
removeOverlayMenu():void
Removes the overlay menu from the player. The overlay menu appears over the video window when the player loads, when you pause the video, or when the video is done playing. The overlay menu will no longer be accessible or visible once it is removed from a player.
None.
None.
setOverlayMenuVisible(visible:Boolean):void
Whether or not the overlay menu should be visible.
| name | type | description |
| visible | Boolean | True if the overlay menu should be visible, false if it shouldn't be visible. |
None.
showMenuPage(page:String):void
Opens the menu to the specified menu page.
| name | type | description |
| page | String | The page to open the menu to. Accepted values are "Email", "Link", "Embed" and "Info". |
None.
blogPostClick
Event fired when an entry has been posted to a blog through the blog menu page.
| name | type | description |
| event.type: | String | blogPostClick |
copyCode
Event fired when the "Copy Code" button on the "Get Code" menu page has been clicked.
| name | type | description |
| event.type: | String | copyCode |
copyLink
Event fired when the "Copy Link" button on the "Get Link" menu page has been clicked.
| name | type | description |
| event.type: | String | copyLink |
menuPageClose
Event fired when a menu page has been closed.
| name | type | description |
| event.type: | String | menuPageClose |
menuPageOpen
Event fired when a menu page has been opened.
| name | type | description |
| event.type: | String | menuPageOpen |
| event.args.page: | String | The string name of the page opened. |
overlayMenuClose
Event fired when the overlay menu has been closed.
| name | type | description |
| event.type: | String | overlayMenuClose |
overlayMenuOpen
Event fired when the overlay menu has been opened.
| name | type | description |
| event.type: | String | overlayMenuOpen |
sendEmailClick
Event fired when the "Send Email" button on the "Email This" menu page has been clicked.
| name | type | description |
| event.type: | String | sendEmailClick |
videoRequest
Event fired when a video has been selected from the Info menu's list of additional videos.
| name | type | description |
| event.type: | String | videoRequest |
| event.args: | Object | The Video DTO of the video that was clicked. |
A reference to the API that allows for searching the Brightcove service for other videos within an account.
findAllVideos(pageSize:Number, pageNumber:Number, sortBy:SortByType, sortOrder:String, getItemCount:Boolean):void
Find all videos belonging to a particular publisher id.
| name | type | description |
| pageSize (optional) | Number | The number of videos per page. Default is 20. Maximum is 50. |
| pageNumber (optional) | Number | The page number of the results to be returned. This is zero-indexed. |
| sortBy (optional) | SortByType | The field by which to sort the results. Valid values are "PUBLISH_DATE", "CREATION_DATE", "MODIFIED_DATE", "PLAYS_TOTAL" or "PLAYS_TRAILING_WEEK". |
| sortOrder (optional) | String | The order in which to sort the results. Valid values are "ASC" (ascending) or "DESC" (descending). |
| getItemCount (optional) | Boolean | Whether or not to also return how many videos we found in total. If this is returned, a VideoSearch object can be used to more easily navigate to other pages in the result set. |
None.
findRelatedVideos(videoID:Number, pageSize:Number, pageNumber:Number, getItemCount:Boolean):ItemCollection
Finds videos related to the given video. Does a search based on short description, tags, and display name of all videos from this publisher. If the video has nothing related to it, this function will still return videos for being associated with that publisher.
| name | type | description |
| videoID | Number | The ID of the video to return related videos for. |
| pageSize (optional) | Number | The number of videos per page. Default is 20. Maximum is 50. |
| pageNumber (optional) | Number | The page number of the results to be returned. This is zero-indexed. |
| getItemCount (optional) | Boolean | Whether or not to also return how many videos we found in total. If this is returned, a VideoSearch object can be used to more easily navigate to other pages in the result set. |
None.
findVideosByTags(andTags:Array, orTags:Array, pageSize:Number, pageNumber:Number, sortBy:SortByType, sortOrder:String, getItemCount:Boolean):void
Performs a search on all the tags of the given publisher's videos, and returns a collection of videos that contain the specified tags.
| name | type | description |
| andTags | Array | An array of Strings. Limit the results to those that must contain these tags. |
| orTags | Array | An array of Strings. Limit the results to those that must contain at least one of these tags. |
| pageSize (optional) | Number | The number of videos per page. Default is 20. Maximum is 50. |
| pageNumber (optional) | Number | The page number of the results to be returned. This is zero-indexed. |
| sortBy (optional) | SortByType | The field by which to sort the results. Valid values are "MODIFIED_DATE" or "PLAYS_TRAILING_WEEK". |
| sortOrder (optional) | String | The order in which to sort the results. Valid values are "ASC" (ascending) or "DESC" (descending). |
| getItemCount (optional) | Boolean | Whether or not to also return how many videos we found in total. If this is returned, a VideoSearch object can be used to more easily navigate to other pages in the result set. |
None.
findVideosByText(text:String, pageSize:Number, pageNumber:Number, getItemCount:Boolean):void
Performs a search through all the given publisher's videos, and returns a collection of videos that match the specified text in either the display name, short description or long description.
| name | type | description |
| text | String | The text to search for. |
| pageSize (optional) | Number | The number of videos per page. Default is 20. Maximum is 50. |
| pageNumber (optional) | Number | The page number of the results to be returned. This is zero-indexed. |
| getItemCount (optional) | Boolean | Whether or not to also return how many videos we found in total. If this is returned, a VideoSearch object can be used to more easily navigate to other pages in the result set. |
None.
getMaxItemsInMemory():Number
Returns the maximum number of videos that will be stored by the SearchManager before being automatically purged. Once the maxItemsInMemory is reached, VideoSearch objects first created will have their pages purges completely until the number of videos is reduced to be within the maximum setting. The default is 1000.
None.
| type | description |
| Number | The maximum number of search result items stored in the player before automatic purging. |
getVideoSearch(videoSearchID:Number):VideoSearch
Returns a VideoSearch instance specified by the ID passed to the method.
| name | type | description |
| videoSearchID | Number | The ID of the VideoSearch instance to retrieve. This ID will be returned in any searchResult event. |
| type | description |
| VideoSearch | The VideoSearch instance specified by the ID. |
setMaxItemsInMemory(max:Number):void
Sets the maximum number of videos that will be stored by the SearchManager before being automatically purged. Once the maxItemsInMemory is reached, VideoSearch objects first created will have their pages purges completely until the number of videos is reduced to be within the maximum setting.
| name | type | description |
| max | Number | The maximum number of search result items to store in the player before automatic purging. |
None.
searchError
Event fired when there is an error making a search query.
| name | type | description |
| event.type: | String | searchError |
searchResult
Event fired when any search result is returned.
| name | type | description |
| event.type: | String | searchResult |
| event.items | Array | An array of VideoDTOs returned by the search query. |
| event.pageSize | Number | The number of items on each page of the search result. |
| event.pageNumber | Number | The page of the entire result set that was returned. |
| event.videoSearchID | Number | If getItemCount was true for the search request, the ID of the VideoSearch object that allows for easy retrieval of subsequent pages. The actual VideoSearch instance can be returned using the getVideoSearch() method of the Search API. |
Holds multiple pages of a result set, allowing for easy retrieval and navigation to other pages.
getItems():Array
Returns the current page of items in the result set.
None.
| type | description |
| Array | An array of VideoDTOs. |
getMaxPagesInMemory():Number
The maximum number of pages in the VideoSearch instance that will be stored before being automatically purged by the VideoSearch instance. Once the maxPagesInMemeory is reached, pages will be purged in a FIFO method. The default value is 5.
None.
| type | description |
| Number | The maximum number of pages in the VideoSearch instance. |
getNextPage():Array
Returns the next page in the result set based on the current page number, if that page has been previously retrieved from the server. If there is no next page in the VideoSearch instance, an Error will be thrown.
None.
| type | description |
| Array | An array of VideoDTOs. |
getNextPageAsynch():void
Retrieves the next page in the result set from the server based on the current page number. If there is no next page in the result set, an Error will be thrown.
None.
| type | description |
| void |
getPage(pageIndex:Number):Array
Returns the specified page in the result set, if that page has been previously retrieved from the server. If it is an invalid page or it does not exist in the VideoSearch instance, an Error will be thrown.
| name | type | description |
| pageIndex (optional) | Number | The numeric index of the page to return. |
| type | description |
| Array | An array of VideoDTOs. |
getPageAsynch(pageIndex:Number):void
Retrieves the specified page in the result set from the server. If it is an invalid page, an Error will be thrown.
| name | type | description |
| pageIndex (optional) | Number | The numeric index of the page to retrieve |
None.
getPageNumber():Number
The last page of the result set retrieved from the server.
None.
| type | description |
| Number | The last page of the result set retrieved from the server. |
getPageSize():Number
The number of items/rows per page of the result set.
None.
| type | description |
| Number | The number of items/rows per page of the result set. |
getPreviousPage():Array
Returns the previous page in the result set based on the current page number, if that page has been previously retrieved from the server. If there is no previous page in the VideoSearch instance, an Error will be thrown.
None.
| type | description |
| Array | An array of VideoDTOs. |
getPreviousPageAsynch():void
Retrieves the previous page in the result set from the server based on the current page number. If there is no previous page in the result set, an Error will be thrown.
None.
| type | description |
| void |
getRow(rowIndex:Number):Object
Returns the specified row from the entire result set. If the page containing the row has not yet been retrieved from the server, an Error is thrown.
| name | type | description |
| rowIndex | Number | The numeric index of the row in the entire result set to return. |
| type | description |
| Object | The VideoDTO stored at the row specified. |
getRowOnPage(rowIndex:Number, pageIndex:Number):Object
Returns the specified row from the specified page in the result set. If the page containing the row has not yet been retrieved from the server, an Error is thrown.
| name | type | description |
| rowIndex | Number | The numeric index of the row in the entire result set to return. |
| pageIndex | Number | The numeric index of the page from which to return a row. |
| type | description |
| Object | The VideoDTO stored at the page and row specified. |
getTotalPages():Number
The total number of pages in the search result set.
None.
| type | description |
| Number | The total number of pages in the search result set. |
getTotalRows():Number
The total number of rows in the search result set.
None.
| type | description |
| Number | The total number of rows in the search result set. |
purgeAll():void
Removes all stored references to all previously retrieved pages.
None.
None.
purgePage(pageIndex:Number):void
Removes the stored reference to the specified page.
| name | type | description |
| pageIndex | Number | The index of the page to purge from memory. |
None.
setMaxPagesInMemory(max:Number):void
The maximum number of pages in the VideoSearch instance that will be stored before being automatically purged by the VideoSearch instance. Once the maxPagesInMemeory is reached, pages will be purged in a FIFO method.
| name | type | description |
| max | Number | The maximum number of pages in the VideoSearch instance. |
None.
searchError
Event fired when there is an error making a search query.
| name | type | description |
| event.type: | String | searchError |
searchResult
Event fired when any search result is returned.
| name | type | description |
| event.type: | String | searchResult |
| event.items | Array | An array of VideoDTOs returned by the search query. |