Package | org.osmf.elements |
Class | public class LightweightVideoElement |
Inheritance | LightweightVideoElement LoadableElementBase MediaElement EventDispatcher Object |
Subclasses | VideoElement |
Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
LightweightVideoElement is a lightweight alternative to VideoElement. Whereas LightweightVideoElement supports only a subset of video delivery modes (specifically progressive and simple RTMP streaming), VideoElement supports all video delivery modes.
The LightweightVideoElement uses a NetLoader class to load and unload its media. Developers requiring custom loading logic for video can pass their own loaders to the LightweightVideoElement constructor. These loaders should subclass NetLoader.
The basic steps for creating and using a LightweightVideoElement are:
- Create a new URLResource pointing to the URL of the video stream or file containing the video to be loaded.
- Create a new NetLoader.
- Create the new LightweightVideoElement, passing the NetLoader and URLResource as parameters.
- Create a new MediaPlayer.
- Assign the LightweightVideoElement to the MediaPlayer's
media
property. - Control the media using the MediaPlayer's methods, properties, and events.
- When done with the LightweightVideoElement, set the MediaPlayer's
media
property to null. This will unload the LightweightVideoElement.
The LightweightVideoElement supports Flash Media Token Authentication, for passing authentication tokens through the NetConnection.
The LightweightVideoElement has support for the Flash Player's DRM implementation.
Note that the startDate
, endDate
, and period
properties of the DRMTrait on this element correspond to the voucher validity before
playback starts. Once playback begins, these properties correspond to the playback
time window (as found on flash.net.drm.DRMVoucher).
Related API Elements
org.osmf.media.URLResource
org.osmf.media.MediaElement
org.osmf.media.MediaPlayer
org.osmf.net.NetLoader
Property | Defined By | ||
---|---|---|---|
client : NetClient [read-only]
The NetClient used by this object's NetStream. | LightweightVideoElement | ||
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 | ||
currentFPS : Number [read-only]
The number of frames per second being displayed. | LightweightVideoElement | ||
deblocking : int
Indicates the type of filter applied to decoded video as part of post-processing. | LightweightVideoElement | ||
defaultDuration : Number
Defines the duration that the element's TimeTrait will expose until the
element's content is loaded. | LightweightVideoElement | ||
metadataNamespaceURLs : Vector.<String> [read-only]
A Vector containing the namespace URLs for all Metadata
objects stored within this MediaElement. | MediaElement | ||
resource : MediaResourceBase
The media resource that this media element operates on. | MediaElement | ||
smoothing : Boolean
Specifies whether the video should be smoothed (interpolated) when it is scaled. | LightweightVideoElement | ||
traitTypes : Vector.<String> [read-only]
A Vector of MediaTraitType values representing the trait types on this
media element. | MediaElement |
Method | Defined By | ||
---|---|---|---|
Constructor. | LightweightVideoElement | ||
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 |
client | property |
client:NetClient
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The NetClient used by this object's NetStream. Will be null until this object has been loaded (as indicated by its LoadTrait entering the READY state).
Implementation
public function get client():NetClient
currentFPS | property |
deblocking | property |
deblocking:int
Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the type of filter applied to decoded video as part of post-processing. The default value is 0, which lets the video compressor apply a deblocking filter as needed. See flash.media.Video for more information on deblocking modes.
Implementation
public function get deblocking():int
public function set deblocking(value:int):void
Related API Elements
defaultDuration | property |
defaultDuration:Number
Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the duration that the element's TimeTrait will expose until the element's content is loaded. Setting this property to a positive value results in the element becoming temporal. Any other value will remove the element's TimeTrait, unless the loaded content is exposing a duration.
Implementation
public function get defaultDuration():Number
public function set defaultDuration(value:Number):void
smoothing | property |
smoothing:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the video should be smoothed (interpolated) when it is scaled. For smoothing to work, the runtime must be in high-quality mode (the default). The default value is false (no smoothing). Set this property to true to take advantage of mipmapping image optimization.
Implementation
public function get smoothing():Boolean
public function set smoothing(value:Boolean):void
Related API Elements
LightweightVideoElement | () | Constructor |
public function LightweightVideoElement(resource:MediaResourceBase = null, loader:NetLoader = null)
Language Version: | ActionScript 3.0 |
Product Version: | OSMF 1.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Parametersresource:MediaResourceBase (default = null ) — URLResource that points to the video source that the LightweightVideoElement
will use. For dynamic streaming content, use a DynamicStreamingResource.
| |
loader:NetLoader (default = null ) — NetLoader used to load the video. If null, then a NetLoader will
be used.
|
Throws
ArgumentError — If resource is not an URLResource.
|
package asdoc.org.osmf.elements { import flash.display.Sprite; import flash.display.StageAlign; import flash.display.StageScaleMode; import org.osmf.elements.LightweightVideoElement; import org.osmf.elements.VideoElement; import org.osmf.media.MediaPlayer; import org.osmf.media.MediaPlayerSprite; import org.osmf.media.URLResource; public class LightweightVideoElementExample extends Sprite { public function LightweightVideoElementExample() { super(); stage.scaleMode = StageScaleMode.NO_SCALE; stage.align = StageAlign.TOP_LEFT; var mediaPlayerSprite:MediaPlayerSprite = new MediaPlayerSprite(); var videoElement:LightweightVideoElement = new LightweightVideoElement(); videoElement.resource = new URLResource("http://mediapm.edgesuite.net/strobe/content/test/AFaerysTale_sylviaApostol_640_500_short.flv"); addChild(mediaPlayerSprite); mediaPlayerSprite.media = videoElement; } } }
Wed Nov 21 2018, 06:34 AM -08:00