org.osmf.traits

# DVRTrait - AS3 OSMF

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

DVRTrait defines the trait interface for media that can be played while in the process of being recorded, as if with a digital video recorder (DVR). It can also be used as the base class foor a specific DVRTrait class.

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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DVRTrait(isRecording:Boolean = false, windowDuration:Number = -1) 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | dispose():void Disposes of any resources used by this trait. | MediaTraitBase
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | 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

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | isRecordingChange | Dispatched when the object's isRecording property changes. | DVRTrait

Property Detail

### isRecording

property

`isRecording:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

Defines if the recording is ongoing.

Implementation
`public function get isRecording():Boolean`

### 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():Number`

### windowDuration

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():Number`
Constructor 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.

Parameters

| `isRecording:Boolean` (default = `false`)`` — Defines whether the recording is ongoing.
| `windowDuration:Number` (default = `-1`)`` — If -1, indicates the amount of available recorded content is unlimited. If a non-zero positive number, indicates the number of seconds of recorded content that are available behind the live point.

Event Detail

### isRecordingChange

Event

Event Object Type: `org.osmf.events.DVREvent`

Dispatched when the object's isRecording property changes.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00