NetStreamSwitchManagerBase

Package	org.osmf.net
Class	public class NetStreamSwitchManagerBase
Inheritance	NetStreamSwitchManagerBase EventDispatcher Object
Subclasses	NetStreamSwitchManager, RuleSwitchManagerBase

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

NetStreamSwitchManagerBase is a base class for classes that need to manage transitions between multi-bitrate (MBR) streams.

A NetStreamSwitchManagerBase can work in manual or auto mode. For the former, it will execute upon request the NetStream call that performs the switch. For the latter, it will execute the switch based on its own internal logic.

A NetStreamSwitchManagerBase doesn't dispatch any events indicating state changes. The assumption is that a client will already be listening to events on the NetStream, so there's no need for duplicative events here.

This is an abstract base class, clients must subclass it to implement their own switching logic.

Public Properties

	Property		Defined By
		autoSwitch : Boolean Indicates whether the switching manager should automatically switch between streams.	NetStreamSwitchManagerBase
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentIndex : uint [read-only] Returns the current stream index that is rendering on the client.	NetStreamSwitchManagerBase
		maxAllowedIndex : int The highest stream index that the switching manager is allowed to switch to.	NetStreamSwitchManagerBase

Protected Properties

	Property		Defined By
		_autoSwitch : Boolean	NetStreamSwitchManagerBase
		_maxAllowedIndex : int	NetStreamSwitchManagerBase

Public Methods

	Method		Defined By
		NetStreamSwitchManagerBase() Constructor.	NetStreamSwitchManagerBase
		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
		switchTo(index:int):void Initiate a switch to the stream with the given index.	NetStreamSwitchManagerBase
		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

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

_autoSwitch

property

protected var _autoSwitch:Boolean

_maxAllowedIndex

property

protected var _maxAllowedIndex:int

autoSwitch

property

autoSwitch:Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the switching manager should automatically switch between streams. The default is true.

Implementation
public function get autoSwitch():Boolean
public function set autoSwitch(value:Boolean):void

currentIndex

property

currentIndex:uint [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the current stream index that is rendering on the client. Note this may differ from the last index requested if this property is queried after a switch has begun but before it has completed.

Implementation
public function get currentIndex():uint

maxAllowedIndex

property

maxAllowedIndex:int

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The highest stream index that the switching manager is allowed to switch to.

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

Constructor Detail