User Guide

NetStream.pause() 637

NetStream.pause()

Availability

Flash Player 7.

Note: This method is also supported in Flash Player 6 when used with Flash Communication Server.

For more information, see the Flash Communication Server documentation.

Usage

my_ns.pause( [ pauseResume:Boolean ] ) : Void

Parameters

pauseResume

A Boolean value specifying whether to pause play (true) or resume play (false).

If you omit this parameter,

NetStream.pause() acts as a toggle: the first time it is called on a

specified stream, it pauses play, and the next time it is called, it resumes play. This parameter is

optional.

Returns

Nothing.

Description

Method; pauses or resumes playback of a stream.

The first time you call this method (without sending a parameter), it pauses play; the next time, it

resumes play. You might want to attach this method to a button that the user presses to pause or

resume playback.

Example

The following examples illustrate some uses of this method:

my_ns.pause(); // pauses play first time issued

my_ns.pause(); // resumes play

my_ns.pause(false); // no effect, play continues

my_ns.pause(); // pauses play