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 

NetStreamMetricsBase  - AS3 OSMF
Packageorg.osmf.net
Classpublic class NetStreamMetricsBase
InheritanceNetStreamMetricsBase Inheritance EventDispatcher Inheritance Object
Subclasses RTMPNetStreamMetrics

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

The NetStreamMetricsBase class serves as a base class for a provider of run-time metrics to the NetStreamSwitchManager and its set of switching rules. It calculates running averages for metrics that apply to all delivery methods.


Public Properties
 PropertyDefined By
  averageDroppedFPS : Number
[read-only] The average frame-drop rate calculated over the life of the NetStream.
NetStreamMetricsBase
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentIndex : int
The current stream index.
NetStreamMetricsBase
  droppedFPS : Number
[read-only] The frame drop rate calculated over the last interval.
NetStreamMetricsBase
  maxAllowedIndex : int
The maximum allowed index value.
NetStreamMetricsBase
  maxFPS : Number
[read-only] The maximum achieved frame rate for this NetStream.
NetStreamMetricsBase
  netStream : NetStream
[read-only] The NetStream object supplied to the constructor.
NetStreamMetricsBase
  resource : DynamicStreamingResource
Returns the DynamicStreamingResource which the class is referencing.
NetStreamMetricsBase
  updateInterval : Number
The update interval (in milliseconds) at which metrics are recalculated.
NetStreamMetricsBase
Public Methods
 MethodDefined By
  
NetStreamMetricsBase(netStream:NetStream)
Constructor.
NetStreamMetricsBase
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 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
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 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
 Inherited
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
Protected Methods
 MethodDefined By
  
calculateMetrics():void
Method invoked when the metrics should be recalculated.
NetStreamMetricsBase
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

averageDroppedFPS

property
averageDroppedFPS:Number  [read-only]

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

The average frame-drop rate calculated over the life of the NetStream.



Implementation
    public function get averageDroppedFPS():Number

currentIndex

property 
currentIndex:int

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

The current stream index.



Implementation
    public function get currentIndex():int
    public function set currentIndex(value:int):void

droppedFPS

property 
droppedFPS:Number  [read-only]

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

The frame drop rate calculated over the last interval.



Implementation
    public function get droppedFPS():Number

maxAllowedIndex

property 
maxAllowedIndex:int

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

The maximum allowed index value.



Implementation
    public function get maxAllowedIndex():int
    public function set maxAllowedIndex(value:int):void

maxFPS

property 
maxFPS:Number  [read-only]

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

The maximum achieved frame rate for this NetStream.



Implementation
    public function get maxFPS():Number

netStream

property 
netStream:NetStream  [read-only]

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

The NetStream object supplied to the constructor.



Implementation
    public function get netStream():NetStream

resource

property 
resource:DynamicStreamingResource

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

Returns the DynamicStreamingResource which the class is referencing.



Implementation
    public function get resource():DynamicStreamingResource
    public function set resource(value:DynamicStreamingResource):void

updateInterval

property 
updateInterval:Number

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

The update interval (in milliseconds) at which metrics are recalculated. If set to zero, then metrics will not be recalculated.



Implementation
    public function get updateInterval():Number
    public function set updateInterval(value:Number):void
Constructor Detail

NetStreamMetricsBase

()Constructor
public function NetStreamMetricsBase(netStream:NetStream)

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

Constructor. Note that for correct operation of this class, the caller must set the resource which the monitored stream is playing.

Parameters
netStream:NetStream — The NetStream instance the class will monitor.
Method Detail

calculateMetrics

()method
protected function calculateMetrics():void

Method invoked when the metrics should be recalculated. If updateInterval is set, this method will be invoked whenever the updateInterval is reached.




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

 

Legal Notices | Online Privacy Policy