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 

QoSInfoHistory  - AS3 OSMF
Packageorg.osmf.net.qos
Classpublic class QoSInfoHistory
InheritanceQoSInfoHistory Inheritance Object

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

QoSInfoHistory holds a number of QoSInfo records


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  length : uint
[read-only] Returns the length of the history
QoSInfoHistory
  maxHistoryLength : uint
The maximum number of records to keep. Setting it to a value smaller than the current number of records results in the overflowing records being removed (the oldest).
QoSInfoHistory
Public Methods
 MethodDefined By
  
QoSInfoHistory(netStream:NetStream, maxHistoryLength:uint)
Constructor.
QoSInfoHistory
  
flush():void
Erases the history
QoSInfoHistory
  
getHistory(count:uint = 0):Vector.<QoSInfo>
Returns an array with the most recent QoSInfo records
QoSInfoHistory
  
getLatestQoSInfo():QoSInfo
Returns the most recent QoSInfo in the history
QoSInfoHistory
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DEFAULT_HISTORY_LENGTH : Number = 10
[static]
QoSInfoHistory
Property Detail

length

property
length:uint  [read-only]

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

Returns the length of the history



Implementation
    public function get length():uint

maxHistoryLength

property 
maxHistoryLength:uint

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

The maximum number of records to keep. Setting it to a value smaller than the current number of records results in the overflowing records being removed (the oldest).



Implementation
    public function get maxHistoryLength():uint
    public function set maxHistoryLength(value:uint):void
Constructor Detail

QoSInfoHistory

()Constructor
public function QoSInfoHistory(netStream:NetStream, maxHistoryLength:uint)

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

Constructor.

Parameters
netStream:NetStream — The NetStream instance that will be providing the QoS information
 
maxHistoryLength:uint (default = NaN) — The maximum number of records to keep
Method Detail

flush

()method
public function flush():void

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

Erases the history

getHistory

()method 
public function getHistory(count:uint = 0):Vector.<QoSInfo>

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

Returns an array with the most recent QoSInfo records

Parameters

count:uint (default = 0) — the maximum length of the history

Returns
Vector.<QoSInfo>

getLatestQoSInfo

()method 
public function getLatestQoSInfo():QoSInfo

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

Returns the most recent QoSInfo in the history

Returns
QoSInfo
Constant Detail

DEFAULT_HISTORY_LENGTH

Constant
public static const DEFAULT_HISTORY_LENGTH:Number = 10




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy