(Beta)
| Package | org.osmf.traits |
| Class | public class DVRTrait |
| Inheritance | DVRTrait  MediaTraitBase EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Use the MediaElement.hasTrait(MediaTraitType.DVR) method to query
whether a media element has this trait.
If hasTrait(MediaTraitType.DVR) returns true,
use the MediaElement.getTrait(MediaTraitType.DVR) method
to get an object of this type.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| isRecording : Boolean [read-only]
Defines if the recording is ongoing. | DVRTrait | ||
| timeOffset : Number [read-only]
Indicates the number of seconds to be added to the time-related
properties of the stream in order to obtain the real values.
(OSMF always exposes a zero-based timeline)
The timeOffset might have a non-zero value in case of DVR with
a rolling window.
| DVRTrait | ||
| traitType : String [read-only]
The MediaTraitType for this trait. | MediaTraitBase | |
| windowDuration : Number [read-only]
Indicates the number of seconds of recorded content that are available
behind the live point. | DVRTrait | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DVRTrait | ||
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Disposes of any resources used by this trait. | MediaTraitBase | |
|
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 | |
|
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 | |
|
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 | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when the object's isRecording property changes. | DVRTrait | |||
Property Detail
isRecording | property |
timeOffset | property |
timeOffset:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 2.0.1 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the number of seconds to be added to the time-related properties of the stream in order to obtain the real values. (OSMF always exposes a zero-based timeline)
The timeOffset might have a non-zero value in case of DVR with a rolling window.
Implementation
public function get timeOffset():NumberwindowDuration | property |
windowDuration:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the number of seconds of recorded content that are available behind the live point. If -1, indicates the amount of cached content is unlimited.
Implementation
public function get windowDuration():NumberConstructor Detail
DVRTrait | () | Constructor |
public function DVRTrait(isRecording:Boolean = false, windowDuration:Number = -1)| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
ParametersisRecording:Boolean (default = false) | |
windowDuration:Number (default = -1) |
Event Detail
isRecordingChange | Event |
Event Object Type:
org.osmf.events.DVREventDispatched when the object's isRecording property changes.
Wed Nov 21 2018, 06:34 AM -08:00