Error getting tags :
error 404Error getting tags :
error 404 play | revDocs | RunRev
Welcome Guest (Log in)
Product Edition
Expander triangle
play [filePath | type] [looping] [at point] [options xOptions] play [stop | pause | resume | step {forward | back}] clip
Desktop, Web and Server
Platform Support
MacOS,Mac OS X,Windows,Linux
None required
Plays a movie or sound.

play "/usr/local/clips/music.aiff" -- a file
play videoClip "Movie" at 100,100 -- an imported video clip
play audioClip "Trust No One" looping
play pause videoClip "Sample"

Additional Comments
Expander triangle

Use the play command to control playing of a movie or sound.


The filePath is the location and name of the file you want to play. If you specify a name but not a location, Revolution assumes the file is in the defaultFolder.

The type is "audioClip" or "videoClip".

The clip is a reference to an audio clip or video clip in an open stack.

The point specifies the center of the movie to be played, relative to the current stack window. If the point is not specified, the movie is positioned at the center of the current card. If a sound is being played, the point has no effect.

The xOptions are command line parameters passed to the "xanim" package on Unix systems. (On Mac OS and Windows systems, this parameter has no effect.)


If you use the play...looping form, the sound or video plays continuously from start to beginning until you stop it.

You can stop playing of a movie or sound with the stop command or with the play stop form. If you specify a clip, only that clip is stopped. If you specify a type but not a clip, the last clip of that type is stopped. (On Unix systems, you must wait a second or two after starting a movie or sound before you can stop it, to give the external player time to start up.)

To pause a movie, use the play pause form. Continue playing with play resume. You can move one frame backward or forward with the play step form. If you use one of these commands with a clip that is not currently playing, the result function returns "videoClip is not playing". If the clip is a sound, these forms simply play the sound, ignoring the words "pause", "resume", or "step".

You can play multiple movies at once by starting each one of them with the play command.

Movies cannot be played while any tool other than the Browse tool is in use.

If you start playing an audio clip when another one is playing, the first audio clip is stopped, and a playStopped message is sent to the current card. You cannot play two sounds at the same time, nor can you queue a sound while another sound is playing.

On Unix systems, the "xanim" program must be located in a directory in the PATH environment variable. You can set the PATH from within Revolution by using the put command:

put newPath into $PATH

The play command does not work on some Unix systems that lack built-in support for sound. On these systems, when the play command executes, the result is set to "no sound support".

User Comments
Expander triangle