[r255]: trunk / framework / OSMF / org / osmf / net / NetStreamSwitchManagerBase.as  Maximize  Restore  History

Download this file

150 lines (140 with data), 4.4 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*****************************************************
*
* Copyright 2009 Adobe Systems Incorporated. All Rights Reserved.
*
*****************************************************
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
*
* The Initial Developer of the Original Code is Adobe Systems Incorporated.
* Portions created by Adobe Systems Incorporated are Copyright (C) 2009 Adobe Systems
* Incorporated. All Rights Reserved.
*
*****************************************************/
package org.osmf.net
{
import flash.events.EventDispatcher;
/**
* NetStreamSwitchManagerBase is a base class for classes that need to
* manage transitions between multi-bitrate (MBR) streams.
*
* <p>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.</p>
*
* <p>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.</p>
*
* <p>This is an abstract base class, clients must subclass it to implement
* their own switching logic.</p>
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public class NetStreamSwitchManagerBase extends EventDispatcher
{
/**
* Constructor.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public function NetStreamSwitchManagerBase()
{
super();
_autoSwitch = true;
_maxAllowedIndex = int.MAX_VALUE;
}
/**
* Indicates whether the switching manager should automatically
* switch between streams. The default is true.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public function get autoSwitch():Boolean
{
return _autoSwitch;
}
public function set autoSwitch(value:Boolean):void
{
_autoSwitch = value;
}
/**
* 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.
*
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public function get currentIndex():uint
{
// Subclasses must override.
return 0;
}
/**
* The highest stream index that the switching manager is
* allowed to switch to.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public function get maxAllowedIndex():int
{
return _maxAllowedIndex;
}
/**
* The highest stream index that the switching manager is
* allowed to switch to.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public function set maxAllowedIndex(value:int):void
{
_maxAllowedIndex = value;
}
/**
* Initiate a switch to the stream with the given index.
* Note: If the media is paused, switching will not take place until after play resumes.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion OSMF 1.0
*/
public function switchTo(index:int):void
{
// Subclasses must override.
}
// Internals
//
protected var _autoSwitch:Boolean;
protected var _maxAllowedIndex:int;
}
}