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

QoSInfo  - AS3 OSMF

Packageorg.osmf.net.qos
Classpublic class QoSInfo
InheritanceQoSInfo Inheritance Object

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

QoSInfo holds Quality of Service information of the media.



Public Properties
 PropertyDefined By
  actualIndex : int
[read-only] The index of the currently downloading quality level
QoSInfo
  availableQualityLevels : Vector.<QualityLevel>
[read-only] The available quality levels
QoSInfo
  bufferLength : Number
[read-only] The length of the buffer (in seconds)
QoSInfo
  bufferTime : Number
[read-only] The minimum buffer time (in seconds)
QoSInfo
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentIndex : int
[read-only] The index of the currently playing quality level
QoSInfo
  emptyBufferOccurred : Boolean
[read-only] Signals whether there was any playback interruption caused by an empty buffer since the last QoSInfo was provided
QoSInfo
  lastDownloadedFragmentDetails : FragmentDetails
[read-only] The fragment details of the last downloaded fragment (HDS only)
QoSInfo
  maxFPS : Number
[read-only] The maximum value of the frames per second recorded until now
QoSInfo
  nsInfo : NetStreamInfo
[read-only] The NetStreamInfo of the NetStream
QoSInfo
  playbackDetailsRecord : Vector.<PlaybackDetails>
[read-only] The record containing playback details on the quality levels played since last ABREvent.QOS_UPDATE event
QoSInfo
  playheadTime : Number
[read-only] The playhead time when this QoSInfo was created (time in the stream)
QoSInfo
  timestamp : Number
[read-only] The machine time when this QoSInfo was created
QoSInfo
Public Methods
 MethodDefined By
  
QoSInfo(timestamp:Number = NaN, playheadTime:Number = NaN, availableQualityLevels:Vector.<QualityLevel> = null, currentIndex:int = -1, actualIndex:int = -1, lastDownloadedFragmentDetails:FragmentDetails = null, maxFPS:Number = NaN, playbackDetailsRecord:Vector.<PlaybackDetails> = null, nsInfo:NetStreamInfo = null, bufferLength:Number = NaN, bufferTime:Number = NaN, emptyBufferOccurred:Boolean = false)
Constructor.
QoSInfo
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

actualIndex

property
actualIndex:int  [read-only]

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

The index of the currently downloading quality level



Implementation
    public function get actualIndex():int

availableQualityLevels

property 
availableQualityLevels:Vector.<QualityLevel>  [read-only]

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

The available quality levels



Implementation
    public function get availableQualityLevels():Vector.<QualityLevel>

bufferLength

property 
bufferLength:Number  [read-only]

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

The length of the buffer (in seconds)



Implementation
    public function get bufferLength():Number

bufferTime

property 
bufferTime:Number  [read-only]

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

The minimum buffer time (in seconds)



Implementation
    public function get bufferTime():Number

currentIndex

property 
currentIndex:int  [read-only]

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

The index of the currently playing quality level



Implementation
    public function get currentIndex():int

emptyBufferOccurred

property 
emptyBufferOccurred:Boolean  [read-only]

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

Signals whether there was any playback interruption caused by an empty buffer since the last QoSInfo was provided



Implementation
    public function get emptyBufferOccurred():Boolean

lastDownloadedFragmentDetails

property 
lastDownloadedFragmentDetails:FragmentDetails  [read-only]

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

The fragment details of the last downloaded fragment (HDS only)



Implementation
    public function get lastDownloadedFragmentDetails():FragmentDetails

maxFPS

property 
maxFPS:Number  [read-only]

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

The maximum value of the frames per second recorded until now



Implementation
    public function get maxFPS():Number

nsInfo

property 
nsInfo:NetStreamInfo  [read-only]

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

The NetStreamInfo of the NetStream



Implementation
    public function get nsInfo():NetStreamInfo

playbackDetailsRecord

property 
playbackDetailsRecord:Vector.<PlaybackDetails>  [read-only]

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

The record containing playback details on the quality levels played since last ABREvent.QOS_UPDATE event



Implementation
    public function get playbackDetailsRecord():Vector.<PlaybackDetails>

playheadTime

property 
playheadTime:Number  [read-only]

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

The playhead time when this QoSInfo was created (time in the stream)



Implementation
    public function get playheadTime():Number

timestamp

property 
timestamp:Number  [read-only]

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

The machine time when this QoSInfo was created



Implementation
    public function get timestamp():Number
Constructor Detail

QoSInfo

()Constructor
public function QoSInfo(timestamp:Number = NaN, playheadTime:Number = NaN, availableQualityLevels:Vector.<QualityLevel> = null, currentIndex:int = -1, actualIndex:int = -1, lastDownloadedFragmentDetails:FragmentDetails = null, maxFPS:Number = NaN, playbackDetailsRecord:Vector.<PlaybackDetails> = null, nsInfo:NetStreamInfo = null, bufferLength:Number = NaN, bufferTime:Number = NaN, emptyBufferOccurred:Boolean = false)

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

Constructor.

Parameters
timestamp:Number (default = NaN) — The machine time when this QoSInfo was created (number of milliseconds since midnight January 1, 1970, universal time)
 
playheadTime:Number (default = NaN) — The playhead time when this QoSInfo was created (time in the stream, in seconds)
 
availableQualityLevels:Vector.<QualityLevel> (default = null) — The available quality levels
 
currentIndex:int (default = -1) — The index of the currently playing quality level
 
actualIndex:int (default = -1) — The index of the currently downloading quality level
 
lastDownloadedFragmentDetails:FragmentDetails (default = null) — The fragment details of the last downloaded fragment (HDS only)
 
maxFPS:Number (default = NaN) — The maximum value of the frames per second recorded until now (usually used as an approximation to the asset's characteristic FPS)
 
playbackDetailsRecord:Vector.<PlaybackDetails> (default = null) — A record of the content played back since the last QOS_UPDATE event. It is a list of PlaybackDetails objects.
 
nsInfo:NetStreamInfo (default = null) — The NetStreamInfo of the NetStream
 
bufferLength:Number (default = NaN) — The lengths of the buffer (in seconds)
 
bufferTime:Number (default = NaN) — The minimum buffer time (in seconds)
 
emptyBufferOccurred:Boolean (default = false) — Signals whether there was any playback interruption caused by an empty buffer since the last QoSInfo was provided