NetStream class

Availability

Flash Player 7.

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

Description

The NetStream class provides methods and properties for playing Flash Video (FLV) files from the local file system or an HTTP address. You use a NetStream object to stream video through a NetConnection object. Playing external FLV files provides several advantages over embedding video in a Flash document, such as better performance and memory management, and independent video and Flash frame rates. This class provides a number of methods and properties you can use to track the progress of the file as it loads and plays, and to give the user control over playback (stopping, pausing, and so on).

For more information on video playback, see Playing back external FLV files dynamically.

Method summary for the NetStream class

The following methods and properties of the NetConnection and NetStream classes are used to control FLV playback.

Method

Purpose

NetStream.close()

Closes the stream but does not clear the video object.

NetStream.pause()

Pauses or resumes playback of a stream.

NetStream.play()

Begins playback of an external video (FLV) file.

NetStream.seek()

Seeks a specific position in the FLV file.

NetStream.setBufferTime()

Specifies how long to buffer data before starting to display the stream.

Property summary for the NetStream class

Property

Description

NetStream.bufferLength

The number of seconds of data currently in the buffer.

NetStream.bufferTime

Read-only: the number of seconds assigned to the buffer by NetStream.setBufferTime().

NetStream.bytesLoaded

Read-only; the number of bytes of data that have been loaded into the player.

NetStream.bytesTotal

Read-only; the total size in bytes of the file being loaded into the player.

NetStream.currentFps

The number of frames per second being displayed.

NetStream.time

Read-only; the position of the playhead, in seconds.

Event handler summary for the NetStream class

Event handler

Description

NetStream.onStatus

Invoked every time a status change or error is posted for the NetStream object.

Constructor for the NetStream class

Availability

Flash Player 7.

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

Usage

new NetStream(my_nc)

Parameters

my_nc A NetConnection object.

Returns

Nothing.

Description

Constructor; creates a stream that can be used for playing FLV files through the specified NetConnection object.

Example

The following code first constructs a new NetConnection object, my_nc, and uses it to construct a new NetStream object called videoStream_ns.

my_nc = new NetConnection();
my_nc.connect(null);
videoStream_ns = new NetStream(my_nc);

See also

NetConnection class, NetStream class, Video.attachVideo()