ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.elements 

DurationElement  - AS3 OSMF
Packageorg.osmf.elements
Classpublic class DurationElement
InheritanceDurationElement Inheritance ProxyElement Inheritance MediaElement Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

DurationElement is a media element that wraps a MediaElement to give it temporal capabilities. It allows a non-temporal MediaElement to be treated as a temporal MediaElement.

The DurationElement class is especially useful for creating delays in the presentation of a media composition. For example, the following code presents a sequence of videos, separated from each other by five-second delays.

     var sequence:SerialElement = new SerialElement();
     
     sequence.addChild(new VideoElement(new URLResource("http://www.example.com/video1.flv")));
     sequence.addChild(new DurationElement(5));
     sequence.addChild(new VideoElement(new URLResource("http://www.example.com/ad.flv")));
     sequence.addChild(new DurationElement(5));
     sequence.addChild(new VideoElement(new URLResource("http://www.example.com/video2.flv")));
     
     // Assign the SerialElement to the MediaPlayer.
     player.media = sequence;

The following example presents a sequence of rotating banners. The delays separating the appearances of the banners are created with DurationElements. In addition, the images themselves are wrapped in DurationElements to enable them to support a duration.

     // The first banner does not appear for five seconds.
     // Each banner is shown for 20 seconds.
     // There is a 15-second delay between images.
     
     var bannerSequence:SerialElement = new SerialElement();
     
     bannerSequence.addChild(new DurationElement(5));
     bannerSequence.addChild(new DurationElement(20,new ImageElement(new URLResource("http://www.example.com/banner1.jpg")));
     bannerSequence.addChild(new DurationElement(15));
     bannerSequence.addChild(new DurationElement(20,new ImageElement(new URLResource("http://www.example.com/banner2.jpg")));
     bannerSequence.addChild(new DurationElement(15));
     bannerSequence.addChild(new DurationElement(20,new ImageElement(new URLResource("http://www.example.com/banner3.jpg")));
The DurationElement will not work with elements that already have a TimeTrait, such as VideoElement. To specify a start and end time for a VideoElement. use StreamingURLResource's clipStartTime and clipEndTime properties.

View the examples

Related API Elements

org.osmf.elements.ProxyElement
org.osmf.elements.SerialElement
org.osmf.net.StreamingURLResource

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedcontainer : IMediaContainer
[read-only] The media container that this element uses.
MediaElement
 InheritedmetadataNamespaceURLs : Vector.<String>
[read-only] A Vector containing the namespace URLs for all Metadata objects stored within this MediaElement.
MediaElement
 InheritedproxiedElement : MediaElement
The MediaElement for which this ProxyElement serves as a proxy, or wrapper.
ProxyElement
 Inheritedresource : MediaResourceBase
The media resource that this media element operates on.
MediaElement
 InheritedtraitTypes : Vector.<String>
[read-only] A Vector of MediaTraitType values representing the trait types on this media element.
MediaElement
Protected Properties
 PropertyDefined By
 InheritedblockedTraits : Vector.<String>
The set of MediaTraitTypes that this ProxyElement will block.
ProxyElement
Public Methods
 MethodDefined By
  
DurationElement(duration:Number, mediaElement:MediaElement = null)
Constructor.
DurationElement
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
addMetadata(namespaceURL:String, metadata:Metadata):void
Adds a Metadata object to this MediaElement under the specified namespace URL.
MediaElement
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
getMetadata(namespaceURL:String):Metadata
Returns the Metadata object that is stored under this MediaElement with the specified namespace URL.
MediaElement
 Inherited
getTrait(type:String):org.osmf.traits:MediaTraitBase
Returns the media trait of the specified type.
MediaElement
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
hasTrait(type:String):Boolean
Determines whether this media element has a media trait of the specified type.
MediaElement
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
removeMetadata(namespaceURL:String):Metadata
Removes the Metadata object that was stored under this MediaElement with the specified namespace URL.
MediaElement
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
addTrait(type:String, instance:org.osmf.traits:MediaTraitBase):void
Adds a new media trait to this media element.
MediaElement
 Inherited
removeTrait(type:String):org.osmf.traits:MediaTraitBase
Removes a media trait from this media element.
MediaElement
 Inherited
setupTraits():void
Sets up the traits for this media element.
MediaElement
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
containerChange
Dispatched when the element's container property changed.MediaElement
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
mediaError
Dispatched when an error which impacts the operation of the media element occurs.MediaElement
 Inherited
mediaInfo
Dispatched when a info which impacts the operation of the media element is available.MediaElement
 Inherited
metadataAdd
Dispatched when a Metadata object has been added to this media element.MediaElement
 Inherited
metadataRemove
Dispatched when a Metadata object has been removed from this media element.MediaElement
 Inherited
traitAdd
Dispatched when a trait is added to the media element.MediaElement
 Inherited
traitRemove
Dispatched when a trait is removed from the media element.MediaElement
Constructor Detail

DurationElement

()Constructor
public function DurationElement(duration:Number, mediaElement:MediaElement = null)

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
duration:Number — Duration of the DurationElement's TimeTrait, in seconds.
 
mediaElement:MediaElement (default = null) — Optional element to be wrapped by this DurationElement.
Examples How to use this example
DurationElementExample.as

package
{
    import flash.display.Sprite;
    import flash.display.StageAlign;
    import flash.display.StageScaleMode;
    
    import org.osmf.elements.BeaconElement;
    import org.osmf.elements.DurationElement;
    import org.osmf.elements.ImageElement;
    import org.osmf.elements.VideoElement;
    import org.osmf.media.MediaPlayer;
    import org.osmf.media.MediaPlayerSprite;
    import org.osmf.media.URLResource;
    
    public class DurationElementExample extends Sprite
    {
        public function DurationElementExample()
        {                
            super();
            
            stage.scaleMode = StageScaleMode.NO_SCALE;
            stage.align = StageAlign.TOP_LEFT;
            
            var mediaPlayerSprite:MediaPlayerSprite = new MediaPlayerSprite();
            var imageElement:ImageElement = new ImageElement();
            imageElement.resource = new URLResource("http://mediapm.edgesuite.net/strobe/content/test/train.jpg");
            
            // Shows the image for 10 seconds.
            var durationElement:DurationElement = new DurationElement(10, imageElement);
            
            addChild(mediaPlayerSprite);
            mediaPlayerSprite.media = durationElement;    
        }
    }
}



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy