NetStream.onStatus

Availability

Flash Player 7.

Note: This handler is also supported in Flash Player 6 when used with Flash Communication Server. For more information, see your Flash Communication Server documentation.

Usage

my_ns.onStatus = function(infoObject) {
  // Your code here
}

Parameters

infoObject A parameter defined according to the status or error message. For more information about this parameter, see "Description," below.

Returns

Nothing.

Description

Event handler; invoked every time a status change or error is posted for the NetStream object. If you want to respond to this event handler, you must create a function to process the information object.

The information object has a code property containing a string that describes the result of the onStatus handler, and a level property containing a string that is either "Status" or "Error".

In addition to this onStatus handler, Flash also provides a "super" function called System.onStatus. If onStatus is invoked for a particular object and there is no function assigned to respond to it, Flash processes a function assigned to System.onStatus if it exists.

The following events notify you when certain NetStream activities occur.

Code property	Level property	Meaning
`NetStream.Buffer.Empty`	Status	Data is not being received quickly enough to fill the buffer. Data flow will be interrupted until the buffer refills, at which time a `NetStream.Buffer.Full` message will be sent and the stream will begin playing again.
`NetStream.Buffer.Full`	Status	The buffer is full and the stream will begin playing.
`NetStream.Play.Start`	Status	Playback has started.
`NetStream.Play.Stop`	Status	Playback has stopped.
`NetStream.Play.StreamNotFound`	Error	The FLV passed to the `play()` method can't be found.

Example

The following example writes data about the stream to a log file.

my_ns.onStatus = function(info)
{
  _root.log_stream += "Stream status.\n";
  _root.log_stream += "Event: " + info.code + "\n";
  _root.log_stream += "Type: " + info.level + "\n";
}