RTMPNetStreamMetrics

Package	org.osmf.net.rtmpstreaming
Class	public class RTMPNetStreamMetrics
Inheritance	RTMPNetStreamMetrics NetStreamMetricsBase EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

RTMPNetStreamMetrics is a metrics provider for RTMP-based NetStreams.

Public Properties

	Property		Defined By
		averageDroppedFPS : Number [read-only] The average frame-drop rate calculated over the life of the NetStream.	NetStreamMetricsBase
		averageMaxBytesPerSecond : Number [read-only] The average max bytes per second value, calculated based on a recent set of samples.	RTMPNetStreamMetrics
		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
		RTMPNetStreamMetrics(netStream:NetStream) Constructor.	RTMPNetStreamMetrics
		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
		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

Protected Methods

	Method		Defined By
		calculateMetrics():void Method invoked when the metrics should be recalculated.	NetStreamMetricsBase

Events

Click for more information on 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

Property Detail

averageMaxBytesPerSecond

property

averageMaxBytesPerSecond:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The average max bytes per second value, calculated based on a recent set of samples.

Implementation
public function get averageMaxBytesPerSecond():Number

Constructor Detail