Package | org.osmf.elements |
Class | public class DurationElement |
Inheritance | DurationElement ProxyElement MediaElement EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
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")));
clipStartTime
and clipEndTime
properties.
Related API Elements
Public Properties
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
container : IMediaContainer [read-only]
The media container that this element uses. | MediaElement | ||
metadataNamespaceURLs : Vector.<String> [read-only]
A Vector containing the namespace URLs for all Metadata
objects stored within this MediaElement. | MediaElement | ||
proxiedElement : MediaElement
The MediaElement for which this ProxyElement serves as a proxy,
or wrapper. | ProxyElement | ||
resource : MediaResourceBase
The media resource that this media element operates on. | MediaElement | ||
traitTypes : Vector.<String> [read-only]
A Vector of MediaTraitType values representing the trait types on this
media element. | MediaElement |
Protected Properties
Property | Defined By | ||
---|---|---|---|
blockedTraits : Vector.<String>
The set of MediaTraitTypes that this ProxyElement will block. | ProxyElement |
Public Methods
Method | Defined By | ||
---|---|---|---|
Constructor. | DurationElement | ||
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 | ||
Adds a Metadata object to this MediaElement under the specified namespace URL. | MediaElement | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Returns the Metadata object that is stored under this MediaElement with
the specified namespace URL. | MediaElement | ||
Returns the media trait of the specified type. | MediaElement | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Determines whether this media element has a media trait of the
specified type. | MediaElement | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Removes the Metadata object that was stored under this MediaElement with
the specified namespace URL. | MediaElement | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Protected Methods
Method | Defined By | ||
---|---|---|---|
Adds a new media trait to this media element. | MediaElement | ||
Removes a media trait from this media element. | MediaElement | ||
Sets up the traits for this media element. | MediaElement |
Events
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
Dispatched when the element's container property changed. | MediaElement | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched when an error which impacts the operation of the media element occurs. | MediaElement | |||
Dispatched when a info which impacts the operation of the media element is available. | MediaElement | |||
Dispatched when a Metadata object has been added to this media element. | MediaElement | |||
Dispatched when a Metadata object has been removed from this media element. | MediaElement | |||
Dispatched when a trait is added to the media element. | MediaElement | |||
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.
Parametersduration: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; } } }
Thu Dec 4 2014, 05:50 PM -08:00