Flash Media Server

Client-Side ActionScript Language Reference for Flash Media Server 2 > Client-Side ActionScript Language Reference > NetStream class > NetStream.pause()

NetStream.pause()

Availability

• Flash Player 6.
• Flash Communication Server MX 1.0.

Usage

public pause( [ flag : Boolean] ) : Void

Parameters

flag Optional: 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.

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.

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

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

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

// Create a NetStream for playing back in a Video object named my_video.
var my_ns:NetStream = new NetStream(my_nc);
my_video.attachVideo(my_ns);

// to play record1
my_ns.play("record1", 0, -1, false);

// to play record2
my_ns.play("record2", 0, -1, false);

// to play record3
my_ns.play("record3", 0, -1, false);

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

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

// Later, you want to start a new playlist.

// to play record4
my_ns.play("record4", 0, -1, true);

// to play record5
my_ns.play("record5", 0, -1, false);

// to play record6
my_ns.play("record6", 0, -1, false);

See also

NetStream.close(), NetStream.play()

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/fms/2/docs/00000587.html

Add Comment