The object to render content on.

If the existing rendering surface has existing content, it is not removed prior to setting the new surface. Note that any loading in progress will be cancelled, and all communication with and references to the player are removed.

You must manually invoke the redraw() method if you want to render the current storyboard onto the new surface.

The AssetResolver to use to request external assets. When this value is set to a non-null value, the player registers itself with the resolver as an owner, and all content requested is requested using itself as the owner.

If the player is currently loading content, all load actions in progress will be cancelled when this property is set. When removing the references to an existing resolver, the player will unregister itself as an owner. If the new property value is not null, the player will register itself as an owner.

The storyboard associated with the player.

If null is passed, the current storyboard is unloaded, the unload event is dispatched, and no further action occurs.

If a non-null storyboard object is passed, the following actions occur, in order:

1. If the previously loaded storyboard is not null, the unload event is dispatched. If the event is not cancelled, the current storyboard is unloaded. If the event is cancelled, further processing stops.
2. If the new storyboard is not null, the loadStart event is dispatched. If the event is not cancelled, the new storyboard is associated with the player. If the event is cancelled, further processing stops and the value of this property is set to null.
3. If the value of the new storyboard's Initialized persisted property is false, the storyboard is initialized and the initialize event is dispatched.
4. External content load begins. If any external content is specified, the contentLoadBegin event is dispatched.
5. If external content finishes loading, the contentLoadEnd event is dispatched, followed by the loadComplete event.
6. If the loadComplete event was dispatched, the checkForComplete() method is invoked. If all completion criteria have been met, the complete event is dispatched.

If either the renderingSurface or resolver properties are null, the content will not be rendered, and no error will occur. Processing will continue as if all external assets have been loaded.

See also

Creates a new instance of the RenderingPlayer.

Deletes a style property, reverting it back to its default value.

Parameters

See also

Removes any connections between the rendering surface and the player.

This method is invoked by the player when a storyboard is unloaded, the redraw() method is invoked, or the renderingSurface property is changed. In the RenderingPlayer, this method invokes the cancelOwnerTransaction() method of the resolver.

Descendant classes override this method to perform additional actions.

Removes all content from the surface.

This method is invoked by the player when a storyboard is unloaded or when the redraw() method is invoked. In the RenderingPlayer, this method performs the following actions:

• The resolver's cancelOwnerTransaction() method is invoked.
• Any content currently loading is closed by invoking the resolver's closeAllOf() method.
• All elements on the rendering surface are removed by invoking the surface's removeChildAt() method until no children remain on the surface.
• The surface's graphics property's clear() method is invoked.

Note that this method is not invoked by the player if the surface is being detached by setting the renderingSurface property.

Descendant classes override this method to perform additional actions.

Creates a string describing the state of the storyboard.

This method returns a single character to describe the state of the storyboard. If the storyboard is marked complete, "c" is returned. If the storyboard has been initialized, but is not marked complete, "i" is returned. Otherwise "." is returned.

Note that this string only describes the state that the player is aware of. If the shell stores additional data in the storyboard, it is the shell's responsibility to store the additional data if it is needed.

Parameters

Retrieves a style property.

The type that this method returns varies depending on the style property that the method retrieves. The range of possible types includes Boolean; String; Number; int; a uint for an RGB color; a Class for a skin; or any kind of object.

If you call this method to retrieve a particular style property, it will be of a known type that you can store in a variable of the same type. Type casting is not necessary. Instead, a simple assignment statement like the following will work:

var backgroundColor:uint = getStyle("backgroundColor");

If the style property is not set in the style lookup chain, this method returns a value of undefined. Note that undefined is a special value that is not the same as false, "", NaN, 0, or null. No valid style value is ever undefined.

Unlike classes based on UIComponent, there is no inheritance chain for RenderingPlayer or its derived classes. All styles are set on a per-instance basis.

Parameters

See also

Retrieves the default style map for the current object.

The style map contains the type that is appropriate for the object, and is dependant on the styles that the object uses.

See also

Loads the storyboard.

This method is invoked by the storyboard property set method when a non-null storyboard object is loaded after initialization (if needed) occurs.

When loading a storyboard, the RenderingPlayer performs the following actions:

• The superclass method is invoked.
• Any existing mask on the rendering surface is removed, and, if the maskRenderingSurface style property value is true a new mask is added to the surface.
• The rendering surface is erased, and the background is redrawn based on the object's style property values.
• Content rendering begins.

See also

Adds a mask to the rendering surface if the maskRenderingSurface style property value is true.

The mask added to the surface is a Sprite. It is sized by drawing a rectangle on the Sprite's graphics object using a transparent line style with 0 width and a transparent fill. Note that any existing mask will be removed by this method, regardless of the maskRenderingSurface style property value.

Descendant classes override this method to perform additional actions.

Forces a complete redraw of the content.

Draws the background rectangle onto the rendering surface.

The background rectangle is drawn using the backgroundColor, backgroundAlpha, width, and height style property values using a transparent line style with 0 width.

Note that the surface's graphics object's clear() method is invoked prior to drawing the background.

Descendant classes override this method to perform additional actions.

Renders the content onto the rendering surface.

As implemented by the RenderingPlayer class, this method performs no actions. Descendant classes override this method to render the content.

Removes all properties set by the player.

Note that this method also removes interim completion properties used by the player, but not necessarily set by the player.

Parameters

See also

Parameters

Sets a style property.

You must invoke the redraw() to see style changes.

Parameters

See also

Performs cleanup actions when a storyboard is unloaded.

This method is invoked by the storyboard property set method when the current value of the property is not null and the unload event has not been cancelled.

When unloading a storyboard, the RenderingPlayer performs the following actions:

• The resolver's cancelOwnerTransaction() method is invoked.
• Any content currently loading is closed by invoking the resolver's closeAllOf() method.
• Any event listeners attached to the rendering surface are removed.
• All elements on the rendering surface are removed, and the surface's graphics property's clear() method is invoked.
• The superclass method is invoked.

See also

Dispatched when the player begins to load external assets.

This event is dispatched when the redraw() method is invoked, either explicitly or implicitly as the result of setting the storyboard property to a non-null value.

This event will occur if any external assets are defined, even if they cannot be loaded. This event is dispatched when the resolverInfo object whose owner property value is the player dispatches its beginTransaction event.

Dispatched when all external assets have finished loading.

This event will occur if any external assets are defined, even if they cannot be loaded. This event is dispatched when the resolverInfo object whose owner property value is the player dispatches its endTransaction event.

Dispatched when some type of input or output failure occurs.

Dispatched when some type of input or output failure occurs.

Dispatched when some type of input or output failure occurs.

Dispatched when some type of input or output failure occurs.