MovieManager

Kind of class: public class
Package:
Inherits from:
  • EventDispatcher
Classpath: org.asaplibrary.management.movie.MovieManager
File last modified: Wednesday, 11 May 2011, 19:14:43
MovieManager handles administration, loading and retrieving of separate SWF movies. Start the loading process by calling loadMovie. After this, three events of type MovieManagerEvent can be expected: when the movie has been initialized, has been loaded, and is ready. Ready is defined as both initialized and loaded. Once a movie has been loaded, its LocalController reference is sent with the MovieManagerEvent, or can be retrieved by name. Naming of movies: - use a unique name for each movie - use publicly accessible constants for movie names. This makes it easier to change names throughout the application. - the name has to be given when loading the movie with MovieManager.getInstance().loadMovie(). This means the local controller of a standalone running movie does not have a name. This can be circumvented (if necessary) by giving the local controller its name locally when it is running standalone. ILocalController has a function isStandalone() for checking this.
Events broadcasted to listeners
Usage
  • Subscribe to MovieManager events: MovieManager.getInstance().addEventListener(MovieManagerEvent._EVENT, handleMovieManager); Load SWF movie named "home.swf": MovieManager.getInstance().loadMovie("home.swf", "home"); Handle the movie event and place the movie onto the stage: 
    private function handleMovieManager(e : MovieManagerEvent) : void {
if (e.subtype != MovieManagerEvent.MOVIE_READY) return;
addChild(e.container);
}

Summary

Class methods
Instance methods
  • getLoader () : AssetLoader
    • The AssetLoader loader class used by MovieManager.
  • loadMovie (inURL:String, inName:String) : Boolean
    • Start loading the movie with path inURL, and adds it to the list of movies under the name inName
  • removeMovie (inMovie = *) : Boolean
    • Find the movie with the specified name, container or controller, remove the object from the display list and remove the movie data from the list of movies
  • getLocalControllerByName (inName:String, inSuppressWarning:Boolean = false) : ILocalController
    • Finds a LocalController by name.
  • addLocalController (inController:ILocalController) : void
    • Add a specific LocalController; used by standalone LocalControllers to notify its existence to the MovieManager.
  • toString () : String

Class methods

getInstance

static function getInstance() : MovieManager

Access point for the one instance of the MovieManager.

Instance methods

addLocalController

function addLocalController(inController:ILocalController) : void

Add a specific LocalController; used by standalone LocalControllers to notify its existence to the MovieManager.

Parameters
inController:the LocalController to add

getLoader

function getLoader() : AssetLoader

The AssetLoader loader class used by MovieManager.

getLocalControllerByName

function getLocalControllerByName(inName:String, inSuppressWarning:Boolean = false) : ILocalController

Finds a LocalController by name.

Parameters
inName :name of the LocalController
inSuppressWarning:do not emit a Log warning if the movie is not found; default false (a warning is given)
Returns
  • The controller for that movie, or null if no controller could be found.

loadMovie

function loadMovie(inURL:String, inName:String) : Boolean

Start loading the movie with path inURL, and adds it to the list of movies under the name inName

Parameters
inName:unique identifying name for the movie to be loaded
inURL :url where the swf can be found
Returns
  • False if the loader cannot load the movie, or the movie could not be added to the list (usually because another or the same movie with the same name exists already); otherwise true.

removeMovie

function removeMovie(inMovie = *) : Boolean

Find the movie with the specified name, container or controller, remove the object from the display list and remove the movie data from the list of movies After this action, a movie has to be loaded again using loadMovie() It is not checked whether a movie is being loaded, has been loaded or has been started, so this is tricky when a movie is in the loader

Parameters
inMovie:either :String: the name used as identifier for the movie to be removed, :LocalController: the LocalController or :DisplayObject: the asset that was originally loaded
Returns
  • false if the movie wasn't found, true otherwise

toString

override function toString() : String
Overrides
  • EventDispatcher.toString