Packagecom.bourre.media.video
Classpublic class VideoDisplayLocator
InheritanceVideoDisplayLocator Inheritance AbstractLocator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The VideoDisplayLocator store and register VideoDisplay objects.


Example 
  
  public function loadFile( ) : void
  {
   var loader : VideoDisplay = new VideoDisplay(, "intro", containerVideo, false, false );
   loader.load( new URLRequest( "intro.flv" );
  }
  
  public function anotherFunction( ) :void
  {
   var intro : VideoDisplay = VideoDisplayLocator.getInstance().getVideoDisplay( "intro" );
  }

See also

VideoDisplay

Protected Properties
 PropertyDefined by
 Inherited_m : HashMap
Map storing String keys associated with Object values.
AbstractLocator
Public Methods
 MethodDefined by
  
VideoDisplayLocator(access:ConstructorAccess)
VideoDisplayLocator
 Inherited
add(d:Dictionary):void
Adds all ressources contained in the passed-in dictionnary into this locator instance.
AbstractLocator
 Inherited
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
AbstractLocator
  
addListener(listener:Object):Boolean
Adds the passed-in listener as listener for all events dispatched by this event broadcaster.
VideoDisplayLocator
 Inherited
callMethodOnAllValues(methodName:String, ... args):void
Takes all values of a Locator and call on each value the method name passed as 1st argument.
AbstractLocator
  
getInstance():VideoDisplayLocator
[static] Returns unique GraphicLoaderLocator.
VideoDisplayLocator
 Inherited
getKeys():Array
Returns an Array view of the keys contained in this locator.
AbstractLocator
 Inherited
getLogger():Log
Returns the exclusive logger object owned by this locator.
AbstractLocator
 Inherited
getType():Class
Return the class type of elements in this container.
AbstractLocator
 Inherited
getValues():Array
Returns an Array view of the values contained in this locator.
AbstractLocator
  
getVideoDisplay(name:String):VideoDisplay
Returns VideoDisplay object registered with passed-in name identifier.
VideoDisplayLocator
 Inherited
isRegistered(name:String):Boolean
Returns true is there is a ressource associated with the passed-in key.
AbstractLocator
 Inherited
isTyped():Boolean
Returns true if this container perform a verification of the type of elements.
AbstractLocator
 Inherited
locate(name:String):Object
Returns the ressource associated with the passed-in key.
AbstractLocator
 Inherited
matchType(o:*):Boolean
Verify that the passed-in object type match the current container element's type.
AbstractLocator
 Inherited
processOnAllValues(f:Function, ... args):void
Takes all values of a Locator and pass them one by one as arguments to a method of an object.
AbstractLocator
 Inherited
register(name:String, o:Object):Boolean
Registers passed-in object with identifier name to this locator.
AbstractLocator
  
release():void
[static] Releases instance.
VideoDisplayLocator
 Inherited
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
AbstractLocator
  
removeListener(listener:Object):Boolean
Removes the passed-in listener object from this event broadcaster.
VideoDisplayLocator
  
setSoundTransformAll(soundTransformInfo:SoundTransformInfo):void
Applies passed-in SoundTransformInfo properties to all registered VideoDisplay objects.
VideoDisplayLocator
 Inherited
toString():String
Returns the string representation of this instance.
AbstractLocator
 Inherited
unregister(name:String):Boolean
Unregisters object registered with identifier name.
AbstractLocator
Protected Methods
 MethodDefined by
 Inherited
broadcastEvent(e:Event):void
Broadcast the passed-in event object to listeners according to the event's type.
AbstractLocator
 Inherited
getBroadcaster():Broadcaster
Returns event Broadcaster owned by this locator.
AbstractLocator
  
onRegister(name:String = null, o:Object = null):void
Dispatches VideoDisplayLocatorEvent event using passed-in arguments as event properties when a VideoDisplay is registered in locator.
VideoDisplayLocator
  
onUnregister(name:String = null):void
Dispatches VideoDisplayLocatorEvent event using passed-in arguments as event properties when a VideoDisplay is unregistered from locator.
VideoDisplayLocator
Events
 EventSummaryDefined by
  
onRegisterVideoDisplay
Dispatched when VideoDisplay object is registered in VideoDisplayLocator locator.VideoDisplayLocator
  
onUnregisterVideoDisplay
Dispatched when VideoDisplay is unregistered from VideoDisplayLocator locator.VideoDisplayLocator
Constructor detail
VideoDisplayLocator()constructor
public function VideoDisplayLocator(access:ConstructorAccess)

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Parameters
access:ConstructorAccess
Method detail
addListener()method
public function addListener(listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds the passed-in listener as listener for all events dispatched by this event broadcaster. The function returns true if the listener have been added at the end of the call. If the listener is already registered in this event broadcaster the function returns false.

Note : The addListener function doesn't accept functions as listener, functions could only register for a single event.

Parameters
listener:Object — the listener object to add as global listener

Returns
Boolean — true if the listener have been added during this call
getInstance()method 
public static function getInstance():VideoDisplayLocator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns unique GraphicLoaderLocator.

Returns
VideoDisplayLocator — the unique GraphicLoaderLocator.
getVideoDisplay()method 
public function getVideoDisplay(name:String):VideoDisplay

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns VideoDisplay object registered with passed-in name identifier.

Parameters
name:String

Returns
VideoDisplay — VideoDisplay object registered with passed-in name identifier.

Throws
— Error — name is not registered in current locator
onRegister()method 
protected override function onRegister(name:String = null, o:Object = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatches VideoDisplayLocatorEvent event using passed-in arguments as event properties when a VideoDisplay is registered in locator.

Event type is VideoDisplayLocatorEvent.onRegisterVideoDisplayEVENT

Parameters
name:String (default = null) — Name of the registered VideoDisplay
 
o:Object (default = null) — The registered VideoDisplay

See also

VideoDisplay
VideoDisplayLocatorEvent
VideoDisplayLocatorEvent.onRegisterVideoDisplayEVENT
onUnregister()method 
protected override function onUnregister(name:String = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatches VideoDisplayLocatorEvent event using passed-in arguments as event properties when a VideoDisplay is unregistered from locator.

Event type is VideoDisplayLocatorEvent.onUnregisterVideoDisplayEVENT

Parameters
name:String (default = null) — Name of the registredred VideoDisplay

See also

VideoDisplay
VideoDisplayLocatorEvent
VideoDisplayLocatorEvent.onUnregisterGraphicLoaderEVENT
release()method 
public static function release():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Releases instance.

removeListener()method 
public function removeListener(listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener object from this event broadcaster. The object is removed as listener for all events the broadcaster may dispatch.

Parameters
listener:Object — the listener object to remove from this event broadcaster object

Returns
Boolean — true if the object have been successfully removed from this event broadcaster
setSoundTransformAll()method 
public function setSoundTransformAll(soundTransformInfo:SoundTransformInfo):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Applies passed-in SoundTransformInfo properties to all registered VideoDisplay objects.

Parameters
soundTransformInfo:SoundTransformInfo — SoundTransformInfo properties
Event detail
onRegisterVideoDisplayevent 
Event object type: com.bourre.media.video.VideoDisplayLocatorEvent
VideoDisplayLocatorEvent.type property = com.bourre.media.video.VideoDisplayLocatorEvent.onRegisterVideoDisplayEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when VideoDisplay object is registered in VideoDisplayLocator locator.

Defines the value of the type property of the event object for a onRegisterVideoDisplay event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getName() The registration key
getVideoDisplay() The VideoDisplay object
onUnregisterVideoDisplayevent  
Event object type: com.bourre.media.video.VideoDisplayLocatorEvent
VideoDisplayLocatorEvent.type property = com.bourre.media.video.VideoDisplayLocatorEvent.onUnregisterVideoDisplayEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when VideoDisplay is unregistered from VideoDisplayLocator locator.

Defines the value of the type property of the event object for a onUnregisterVideoDisplay event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getName() The registration key



Submit Feedback
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00