Packageat.containers
Interfacepublic interface IVideoPopUpContainer

Interface for custom video player components that want to be popped-up using the OverlayModule. Similar to the VideoPopUpContainer.

See also

at.modules.OverlayModule
at.containers.VideoPopUpContainer


Public Properties
 PropertyDefined by
  source : String
Sets the source for the player contained in the component.
IVideoPopUpContainer
  videoClassSettings : Object
This is an object of settings to pass to the component when the window is popped up.
IVideoPopUpContainer
Public Methods
 MethodDefined by
  
destroy():void
Specifies the settings, unloading, stopping, pausing, of the loaded video content.
IVideoPopUpContainer
Events
 EventSummaryDefined by
   Dispatched when the video is ready to be played and its metadata has been loaded to be able to identify width/height and other attributes.IVideoPopUpContainer
Property detail
sourceproperty
source:String  [read-write]

Sets the source for the player contained in the component.

Implementation
    public function get source():String
    public function set source(value:String):void
videoClassSettingsproperty 
videoClassSettings:Object  [read-write]

This is an object of settings to pass to the component when the window is popped up.

The component can pass anything though to the component via the videoClassSettings to be set inside the component. Implementation
    public function get videoClassSettings():Object
    public function set videoClassSettings(value:Object):void

Method detail
destroy()method
public function destroy():void

Specifies the settings, unloading, stopping, pausing, of the loaded video content.

The destoy() method is called just before the video popup container is removed. This is where any event listeners should be removed and the video should be stopped. Otherwise the video has a chance of continuin to play even after the window is removed.

Event detail
readyevent 
Event object type: mx.events.VideoEvent

Dispatched when the video is ready to be played and its metadata has been loaded to be able to identify width/height and other attributes.