Packageorg.openvideoplayer.net.dynamicstream
Classpublic class DynamicStreamItem
InheritanceDynamicStreamItem Inheritance Object

This class provides a container to hold the constituents of a dynamic streaming package. It is based on the original class by Adobe Systems, but we have extended it to represent each item as an instance of the new DynamicStreamBitrate class, so that each bitrate can store some infomration about itself and its state.



Public Properties
 PropertyDefined By
  len : Number
len:Number Default is -1 to coincide with defaults for NetStream.play()
DynamicStreamItem
  reset : Boolean
reset:Boolean Default is true to coincide with defaults for NetStream.play()
DynamicStreamItem
  start : Number
Start time for the stream Default is -2 to coincide with defaults for NetStream.play()
DynamicStreamItem
  startingIndex : Number
Stores the preferred starting index
DynamicStreamItem
  streamAuth : String
Specifies stream auth params to use with this DSI.
DynamicStreamItem
  streamCount : Number
Stores the number of items held by this class
DynamicStreamItem
  streams : Array
[read-only] Returns the array of DynamicStreamBitrate objects
DynamicStreamItem
Public Methods
 MethodDefined By
  
DynamicStreamItem
  
addStream(streamName:String, bitRate:Number):void
Adds a stream and bitrate pair to the DynamicStreamItem object
DynamicStreamItem
  
Returns the DynamicStreamBitrate object at the requested index
DynamicStreamItem
  
getNameAt(index:uint):String
Returns the name of the stream at the given index
DynamicStreamItem
  
getRateAt(index:int):Number
Returns the bitrate of the stream at the given index
DynamicStreamItem
  
incrementFailCountAt(index:uint):void
Increments the failed counter at the requested index
DynamicStreamItem
  
indexFromName(name:String):int
Returns the index associated with a bitrate name.
DynamicStreamItem
  
isAvailable(index:int):Boolean
Returns true if a index is available
DynamicStreamItem
  
isLockedAt(index:int):Boolean
Returns true if this index level is currently locked.
DynamicStreamItem
  
lock(index:int):void
Sets the lock level at the provided index.
DynamicStreamItem
Property Detail
lenproperty
public var len:Number

len:Number Default is -1 to coincide with defaults for NetStream.play()

resetproperty 
public var reset:Boolean

reset:Boolean Default is true to coincide with defaults for NetStream.play()

startproperty 
public var start:Number

Start time for the stream Default is -2 to coincide with defaults for NetStream.play()

startingIndexproperty 
public var startingIndex:Number

Stores the preferred starting index

streamAuthproperty 
public var streamAuth:String

Specifies stream auth params to use with this DSI. Default is ""

streamCountproperty 
public var streamCount:Number

Stores the number of items held by this class

streamsproperty 
streams:Array  [read-only]

Returns the array of DynamicStreamBitrate objects


Implementation
    public function get streams():Array
Constructor Detail
DynamicStreamItem()Constructor
public function DynamicStreamItem()



Method Detail
addStream()method
public function addStream(streamName:String, bitRate:Number):void

Adds a stream and bitrate pair to the DynamicStreamItem object

Parameters

streamName:String
 
bitRate:Number — in kbps

getBitrateAt()method 
public function getBitrateAt(index:uint):DynamicStreamBitrate

Returns the DynamicStreamBitrate object at the requested index

Parameters

index:uint

Returns
DynamicStreamBitrate
getNameAt()method 
public function getNameAt(index:uint):String

Returns the name of the stream at the given index

Parameters

index:uint

Returns
String
getRateAt()method 
public function getRateAt(index:int):Number

Returns the bitrate of the stream at the given index

Parameters

index:int

Returns
Number
incrementFailCountAt()method 
public function incrementFailCountAt(index:uint):void

Increments the failed counter at the requested index

Parameters

index:uint

indexFromName()method 
public function indexFromName(name:String):int

Returns the index associated with a bitrate name. The match will be tried both with and without a mp4: prefix.

Parameters

name:String

Returns
int
isAvailable()method 
public function isAvailable(index:int):Boolean

Returns true if a index is available

Parameters

index:int

Returns
Boolean
isLockedAt()method 
public function isLockedAt(index:int):Boolean

Returns true if this index level is currently locked.

Parameters

index:int

Returns
Boolean
lock()method 
public function lock(index:int):void

Sets the lock level at the provided index. Any item at this index or higher will be unavailable until the LOCK_INTERVAL has passed.

Parameters

index:int