Client-Side Communication ActionScript > NetStream.pause

NetStream.pause

Availability

	Flash Player 6.
	Flash Communication Server MX.

Usage

myStream.pause([pauseResume])

Parameters

pauseResume An optional Boolean parameter specifying whether to pause play (true) or resume play (false). If you omit this parameter, pause acts as a toggle: the first time pause is called on a specified stream, it pauses play, and the next time it is called, it resumes play.

Returns

Nothing.

Description

Method; pauses or resumes playback of a stream. This method is available only to clients subscribed to the specified stream, not to the stream's publisher.

The first time you call this method on a given playlist (without sending a parameter), it pauses the playlist; 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.

myStream.pause(); // pauses play first time issued
myStream.pause(); // resumes play
myStream.pause(false); // no effect, play continues
myStream.pause(); // pauses play

In the following example, suppose you have a playlist of three recorded streams.

connection = new NetConnection();
connection.connect("rtmp://localhost/appName/appInstance");

// Create a NetStream for playing
dstStream = new NetStream(connection);
myVideoObject.attachVideo(dstStream);

// To play record1
dstStream.play("record1", 0, -1, false);

// To play record2
dstStream.play("record2", 0, -1, false);

// To play record3
dstStream.play("record3", 0, -1, false);

// You click a button to pause while record2 is playing
dstStream.pause(); 

// Later, you want to resume the play
dstStream.pause();

// Later, you want to start a new playlist

// To play record4
dstStream.play("record4", 0, -1, true);

// To play record5
dstStream.play("record5", 0, -1, false);

// To play record6
dstStream.play("record6", 0, -1, false);

See also

NetStream.play