(Beta)
| Package | org.osmf.net |
| Class | public class NetStreamMetricsBase |
| Inheritance | NetStreamMetricsBase  EventDispatcher Object |
| Subclasses | RTMPNetStreamMetrics |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| averageDroppedFPS : Number [read-only]
The average frame-drop rate calculated over the life of the NetStream. | NetStreamMetricsBase | ||
 | constructor : 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
| Method | Defined By | ||
|---|---|---|---|
NetStreamMetricsBase(netStream:NetStream)
Constructor. | NetStreamMetricsBase | ||
| 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 | |
|
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 | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
Method invoked when the metrics should be recalculated. | NetStreamMetricsBase | ||
Property Detail
averageDroppedFPS | property |
currentIndex | property |
droppedFPS | property |
maxAllowedIndex | property |
maxFPS | property |
netStream | property |
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):voidupdateInterval | 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):voidConstructor 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.
ParametersnetStream:NetStream — The NetStream instance the class will monitor.
|
Method Detail
calculateMetrics | () | method |
protected function calculateMetrics():voidMethod invoked when the metrics should be recalculated. If updateInterval is set, this method will be invoked whenever the updateInterval is reached.
Wed Nov 21 2018, 06:34 AM -08:00