movie Reference

Play a movie in a window



Plays a movie in a separate window. All movie playback control is managed by messages to the object.


Play a movie, or move through it in a variety of ways... Hold multiple movies (which are stored in reverse order from the order received)


Note: The movie object requires that QuickTime be installed on your system. If you are using Max on Windows, we recommend that you install QuickTime and choose a complete install of all optional components.The movie object plays a movie in its own window, and the imovie object plays a movie in a box inside a patcher window.


filename [symbol]


Specifies the name of a movie file to be read into movie automatically when the patch is loaded. The same effect can be achieved for imovie by selecting the object in an unlocked patcher and choosing Get Info... from the Object menu to select a movie file. Both objects retain the name(s) of the movie(s) they have loaded at the time that the patch is saved, and attempt to load the same movie(s) the next time the patch is opened.


autofit [int] (default: 0)

Toggles scaling the movie to fit in the window currently displayed.

border [int] (default: 1)

Toggles the movie’s border type. The message border 1 (the default) uses the traditional Macintosh-style border for the movie window. The message border 0 displays only the rectangle in which the movie plays.

Possible values:

0 = 'Plain'
1 = 'Document'

name [symbol]

Name of the movie file loaded.

Common Box Attributes



Same as resume.



location [int]
Sets the current time location of the movie. If the movie is playing, it will play from the newly set location. 0 is always the beginning. The end time varies from one movie to another. (The length message reports the end time location out the left outlet.)


When a QuickTIme movie file is dragged from the Max File Browser to a movie object, the file will be loaded.



flag [int]
The word active, followed by a non-zero number, makes the movie active (the default). Followed by a 0, active makes the movie inactive. An inactive movie will not play or change location.


Has the same effect as dispose with no arguments.


Double-clicking on the movie object will make the movie window active.



filename [symbol]
Closes the movie window if it is open, and removes all movies from the movie object's memory. If the word dispose is followed by the name of a loaded movie, only the named movie will be removed.


Reports the duration of the movie (in time units) out the left-most outlet.


The word ff fast-forwards the movie.


Reports the end time position of the movie (in QuickTime Time Units) from the left outlet.


Reports the current rate multiplied by 65536 out the right outlet. Thus, normal speed is reported as 65536, half speed is reported as 32768, double speed backward is reported as -131072, etc. If the movie is not playing, the rate is reported as 0, and if no movie has yet been loaded nothing is sent out.


Reports the current time location of the movie.


The length message's functionality is equivalent to the getduration message.



flag [int]
The word loadintoram, followed by a non-zero number, attempts to load the entire movie into memory, if possible. The default is 0.



flag [int]
The word loop, followed by a number in the range 0-2, controls looping for the current film on. The options are:
0: looping off (default) 1: looping on 2: palindrome mode (forward and then backward)



end [int]
The word loopend, followed by a number, sets the end point of a loop. The default value is corresponds to the end of the film.



beginning [int]
end [int]
The word looppoints, followed by two numbers, sets the beginning and end points of a loop. the default values are 0 (i.e., the start of the film) for the start point and the end of the film for the endpoint.



beginning [int]
end [int]
The loopset message's functionality is equivalent to the looppoints message.



beginning [int]
The word loopstart, followed by a number, sets the beginning point of a loop. The default value is 0 (i.e., the start of the film).



matrix [list]
The word matrix, followed by nine floating point numbers, reloads the current movie into RAM after performing a transformation matrix operation on the image. This transformation is the same one used for the mapping in QuickTime of points from one coordinate space (i.e, the original image) into another coordinate space (a scaled, rotated, or translated version of the original image).

The transform matrix operation consists of nine matrix elements



flag [int]
The word mute, followed by a non-zero number, turns off the movie's sound (if it has any). Followed by a 0, mute turns on the movie's sound (the default).



time-units [int]
The word next, followed by a number, moves the time location ahead by that amount. If no number is supplied, next moves the time ahead by 5. (The actual time meaning of these units varies from movie to movie.)


Stops the movie if it is playing, and switches to the movie that was loaded just prior to the current movie. (The movies are stored in reverse order from the order in which they were loaded.) If there is no prior movie, nextmovie wraps around back to the most recently loaded movie. Note that the title of the movie window is not automatically changed, even though the "current movie" has been changed by nextmovie.


Brings the movie window to the foreground (applies only to movie, not imovie).



flag [int]
The word palindrome, followed by a non-zero number, sets the movie to play in palindrome mode (forward and then backward). Looping must be turned on. palindrome 0 (the default) disables palindrome mode.



mode [int]
The word passive, followed by a non-zero number, sets the passive mode. In passive mode, starting a movie will not cause the frame to change unless a bang message is received. passive 0 (the default) sets the movie object to respond to normal start messages.


Stops the movie.



index [float]
The word pos followed by a floating-point number which denotes a position-index within the movie will cause the playback-position to jump to the specified position in the movie.



time-units [int]
The word prev, followed by a number, moves the time location backward by that amount. If no number is supplied, prev moves the time backward by 5.



interval [int]
The word quality, followed by a number, sets the minimum interval, in milliseconds, between movie redraws. The default is 0 (i.e., no minimum).



input [list]
The word rate, followed by one or more integers or floats, sets the playing speed of the movie. If rate is followed by one integer, that number is taken to be a whole number playing speed. If rate is followed by two numbers, the first number is taken to be the numerator and the second the denominator of a fractional speed. 1 is the normal playing speed, 0 means the movie is stopped, and a negative rate plays backwards. rate 1 2 would play the movie at half speed. Immediately after you send a non-zero rate message, the movie will begin playing, so you may wish to precede any rate messages with an integer to locate to the desired starting position.



filename [symbol]
Same as read.



filename [symbol]
The word read, followed by a symbol, looks for a movie file with that name in Max's file search path, and opens it if it exists, displaying the movie's first frame in a movie window. If the filename contains any spaces or special characters, the name should be enclosed in double quotes or each special character should be preceded by a backslash (\). The word read by itself puts up a standard Open Document dialog box and reads in any movie file you select. The read message will open at least 26 different types of files that can be opened by QuickTime, these include movie files such as MPEG, audio files including AIFF and MP3, and graphics files including GIF and JPEG.



filename [symbol]
The readany message opens any type of file, using QuickTime routines to try to interpret it as a movie or other supported media file.



x-position-coordinate [int]
y-position-coordinate [int]
width (pixels) [int]
height (pixels) [int]
The word rect, followed by four numbers, specifies the size of the rectangle in which the movie is displayed within the movie window. The first two numbers specify the position of the rectangle within the movie window, in relative coordinates, and the second two numbers specify the width and height, in pixels, of the rectangle.


The word reload will reload the current movie into memory (can be used to refresh; for example, if a movie is playing and the stop message is sent followed by reload, the movie will reload into memory and be set to play from the beginning as a newly loaded movie).


Begins playing the movie from its current location, at the most recently specified rate.


The word rw rewinds the movie.



filename [symbol]
Sets the movie's rate to 1 and begins playing from the beginning. If the word start is followed by the name of a specific loaded movie, that movie becomes the current movie before starting.



location [list]
The word startat, followed by a number, set the current time location of the movie and begins playing from that point.


Stops the movie.



filename [symbol]
The word switch, followed by a symbol, makes the named movie the active one without changing the transport state (See the start message).



frame [list]
The word time, followed by a number that specifies a QuickTime frame number, goes to the time location specified by the number. When no argument is present, the time message's functionality is equivalent to the gettime message.


Reports the timescale of the movie out the left-most outlet.


The word toggleplay activates or pauses playback of the movie.



volume [int]
The word vol, followed by a number in the range 1-255, sets the movie's sound volume. Optionally, the volume can be set by using the word vol, followed by a floating-point value in the range 0. - 1.0.


Closes the movie window.



left-coordinate [int]
top-coordinate [int]
right-coordinate [int]
bottom-coordinate [int]
The word windowpos, followed by four numbers, specifies the location and size of the movie window on the screen. The four numbers specify the left, top, right, and bottom of the movie window in global coordinates. This message is only supported by the movie object, not the imovie object.



Out left outlet: The current time location, when a time message is received; the end time location when a length message is received.

Out middle outlet: The horizontal position of the mouse, relative to the left side of the movie box or window, when the mouse is clicked or dragged inside the movie.

Out right outlet: The vertical position of the mouse, relative to the top of the movie box or window, when the mouse is clicked or dragged inside the movie.

Also, in response to a getrate message, the current movie rate multiplied by 65536 is sent out the right outlet.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter