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 

NetStreamSwitcher  - AS3 OSMF

Packageorg.osmf.net
Classpublic class NetStreamSwitcher
InheritanceNetStreamSwitcher Inheritance EventDispatcher Inheritance Object

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

Controller of the NetStream regarding switching. Intended to be used by an adaptive bitrate switch manager



Public Properties
 PropertyDefined By
  actualIndex : int
[read-only] The index of the quality level currently being downloaded
NetStreamSwitcher
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentIndex : uint
[read-only] Index of the quality level currently being played
NetStreamSwitcher
  switching : Boolean
[read-only] Flag indicating whether the NetStreamSwitcher is currently in a switching process.
NetStreamSwitcher
Public Methods
 MethodDefined By
  
Constructor.
NetStreamSwitcher
 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
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
Sets the availability of a dynamic property for loop operations.
Object
  
Initiates a switch to the specified index
NetStreamSwitcher
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  NetStreamSwitcher
Property Detail

actualIndex

property
actualIndex:int  [read-only]

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

The index of the quality level currently being downloaded



Implementation
    public function get actualIndex():int

currentIndex

property 
currentIndex:uint  [read-only]

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

Index of the quality level currently being played



Implementation
    public function get currentIndex():uint

switching

property 
switching:Boolean  [read-only]

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

Flag indicating whether the NetStreamSwitcher is currently in a switching process. This is set to true when a switch is initiated and is set back to false when the NetStream reports having initiated the transition (NetStatusEvent.TRANSITION).



Implementation
    public function get switching():Boolean
Constructor Detail

NetStreamSwitcher

()Constructor
public function NetStreamSwitcher(netStream:NetStream, dsResource:DynamicStreamingResource)

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

Constructor.

Parameters
netStream:NetStream — NetStream object to be controlled
 
dsResource:DynamicStreamingResource — The dynamic streaming resource
Method Detail

switchTo

()method
public function switchTo(index:int):void

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

Initiates a switch to the specified index

Parameters

index:int
Event Detail

runAlgorithm

Event
Event Object Type: org.osmf.net.abr.ABREvent