org.osmf.net.rtmpstreaming.InsufficientBandwidthRule - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	org.osmf.net.rtmpstreaming
Class	public class InsufficientBandwidthRule
Inheritance	InsufficientBandwidthRule SwitchingRuleBase Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

InsufficientBandwidthRule is a switching rule that switches down when the bandwidth is insufficient for the current stream.

When comparing stream bitrates to available bandwidth, the class uses a "bitrate multiplier" against which the stream bitrate is multiplied.

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Protected Properties

	Property		Defined By
		metrics : NetStreamMetricsBase [read-only] The provider of metrics which the rule can use to determine whether to suggest a switch.	SwitchingRuleBase

Public Methods

	Method		Defined By
		InsufficientBandwidthRule(metrics:org.osmf.net.rtmpstreaming:RTMPNetStreamMetrics, bitrateMultiplier:Number = 1.15) Constructor.	InsufficientBandwidthRule
		getNewIndex():int Returns the index value in the active DynamicStreamingResource to which this switching rule thinks the bitrate should shift.	SwitchingRuleBase
		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
		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

Constructor Detail

InsufficientBandwidthRule

()

Constructor

public function InsufficientBandwidthRule(metrics:org.osmf.net.rtmpstreaming:RTMPNetStreamMetrics, bitrateMultiplier:Number = 1.15)

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Parameters

	`metrics:org.osmf.net.rtmpstreaming:RTMPNetStreamMetrics` — The metrics provider used by this rule to determine whether to switch.

	`bitrateMultiplier:Number` (default = `1.15`) — A multiplier that is used when the stream bitrate is compared against available bandwidth. The stream bitrate is multiplied by this amount. The default is 1.15.

[an error occurred while processing this directive]