ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
NetStreamPlayOptions

Package | flash.net
Class | public dynamic class NetStreamPlayOptions
Inheritance | NetStreamPlayOptions EventDispatcher Object

The NetStreamPlayOptions class specifies the various options that could be passed to the `NetStream.play2` call. Its passed in as the argument to the call and the options specified through the various properties of the class

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | len : Number Specified the length in seconds the streamName should play. | NetStreamPlayOptions
|  | oldStreamName : String Specifies the name of the stream to play to transition from to streamName When NetStream.play2 is used to simply play a stream, this should either be null or undefined otherwise this should specify the stream that needs to be transitioned to streamNamedynamically | NetStreamPlayOptions
|  | prototype : Object [static] A reference to the prototype object of a class or function object. | Object
|  | start : Number Specified the time in seconds the <streamName> should start from with the NetStream.play2() call. | NetStreamPlayOptions
|  | streamName : String Specifies the name of the stream to play or transition to. | NetStreamPlayOptions
|  | transition : String Specifies the mode in which the streamName is played or transitioned to. | NetStreamPlayOptions

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NetStreamPlayOptions() Create a new instance to specify the options to be passed to the NetStream.play2 command. | NetStreamPlayOptions
|  | 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
|  | 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
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | Dispatched when Flash Player gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | Dispatched when Flash Player loses operating system focus and is becoming inactive. | EventDispatcher

Property Detail

len | property

`public var len:Number`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specified the length in seconds the `streamName` should play. A default value of -1 would make it play the full length of the `streamName` and follows the same rules as defined by the start parameter for the `NetStream.play()` call

See also

NetStream.play
NetStream.play2

oldStreamName | property |

`public var oldStreamName:String`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the name of the stream to play to transition from to `streamName` When `NetStream.play2` is used to simply play a stream, this should either be null or undefined otherwise this should specify the stream that needs to be transitioned to `streamName`dynamically

See also

streamName
NetStream.play
NetStream.play2

start | property |

`public var start:Number`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specified the time in seconds the <streamName> should start from with the `NetStream.play2()` call. A default value of 0 makes it start from the beginning and follows the same rules as defined by the start parameter for the `NetStream.play()` call

See also

NetStream.play
NetStream.play2

streamName | property |

`public var streamName:String`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the name of the stream to play or transition to. When `oldStreamName` is null or undefined `NetStream.play2()`plays this stream. If `oldStreamName` is specified then `NetStream.play2()` would transition `oldStreamName` to this stream in a transition mode as specified in the `transition` property

See also

oldStreamName
NetStream.play
NetStream.play2

transition | property |

`public var transition:String`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Specifies the mode in which the streamName is played or transitioned to. It can take values as specified in the `NetStreamPlayTansitions` class. Again depending on whether `Netstream.play2()` is called to play or transition a stream, these values would cause different behaviors. For more descriptions on the various transition modes see the `NetStreamPlayTransitions` class

See also

NetStreamPlayTransitions
NetStream.play2
Constructor Detail

NetStreamPlayOptions | () | Constructor

`public function NetStreamPlayOptions()`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 10

Create a new instance to specify the options to be passed to the NetStream.play2 command.

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00