Movie Plug-in Scripting Reference

Overview

The movie plugin plays Apple Quicktime movies on Macintosh or Windows machines, or Windows Media Format movies on Windows machines.

When the movie is not playing it has a movie poster on the front if desired.

The movie file can be specified on the local disk with a pathname or on the internet with a URL.

Messages: nodestart, nodestop, nodemove, nodechange

Nodemove is sent when the position of the movie changes.

Nodechange is sent when the movie's data changes.

Nodestop is sent when the movie is finished.

Nodestart is sent when the movie begins playing.

Commands and Functions

binaryget, binaryset

binary data $ = binaryget(node name $)
binaryset(node name $, binary data $)

Get or set binary data for the movie poster.

This routine is useful for serialization into xml and trading movie posters with pictures.

boundsget, boundsset

rectangle $ = boundsget(node name $)
boundsset(node name $, rectangle $)

Get or set the boundary rectangle of the movie.

click

click(node name $, hor #, ver #)

Perform some movie specific action, such as Quicktime VR scrolling.

directshowactive, quicktimeactive

is active TF = directshowactive()
is active TF = quicktimeactive()

Test for the proper installation of DirectShow and QuickTime.

The preferred version of DirectX is 8.0, preferred version of QuickTime is 4.0.

displayget, displayset

display TF = displayget(node name $)
displayset(node name $, display TF)

Get or set the movie's display property.

Set this to true and the movie will show current settings if there is no poster.

duration

duration #.# = duration(node name $)

Returns the duration of the movie in fractional seconds.
See: timeget, timeset

fullget, fullset, infoget, infoset

full $ = fullget(node name $)
fullset(node name $, full $)
info $ = infoget(node name $)
infoset(node name $, info $)

Get or set XML data that describes all the settings for this node.

The fullget and fullset routines have a header element with appropriate namespaces, infoget and infoset are an XML snippet for access as a property. Example:

mynode.info.title = "new title"

handlesget, handlesset

handles TF = handlesget(node name $)
handlesset(node name $, handles TF)

Turn on or off dragable handles for reshaping the node.

This routine is used by the system tool palettes for manual positioning.
See: markersget, markersset, partget, partset

hittest

hit TF = hittest(node name $, hor #, ver #)

Returns true if the point is in the movie.

isloaded

is loaded TF = isloaded(node name $)

Returns true if the movie's path points to a movie that can be played.
See: pathget, pathset

ispaused

is paused TF = ispaused(node name $)

Returns true if the movie is currently paused.
See: isplaying

isplaying

is playing TF = isplaying(node name $)

Returns true if the movie is currently playing or is currently paused.
See: ispaused

loopget, loopset

loop TF = loopget(node name $)
loopset(node name $, loop TF)

Get or set the movie's ability to perform looped playback.

markersget, markersset

markers TF = markersget(node name $)
markersset(node name $, markers TF)

Turn on or off the node outline to show selection.

This routine is used by the system tool palettes to show that a node is selected.
See: handlesset, handlesget, partget, partset

partget, partset

part # = partget(node name $, hor #, ver #)
partset(node name $, hor #, ver #, part #)

Get or set the points for an individual handle.
See: markersget, markersset, handlesset, handlesget

pathget, pathset

path name $ = pathget(node name $)
pathset(node name $, path name $)

Get or set the local path to the movie, or use a valid URL to refer to a streaming movie on the internet.

If you call pathset with the argument "" a getfile dialog will prompt the user to open a local file.

pause

pause(node name $)

Pause pauses the movie, use resume to restart.
See: ispaused, resume

play

play(node name $)

Play starts the movie playing.

playfullscreen

playfullscreen(node name $, with controller TF, allow aborts TF)

Playfullscreen starts the movie playing across the entire screen.

The withcontroller argument will add a controller to a quicktime movie.

The allowaborts argument will let a mouse click or escape key stop the movie.

posterclear, postergrab

posterclear(node name $)
postergrab(node name $)

Postergrab grabs the current start of the movie for display when the movie is not playing.

Posterclear disposes of this image.

rateget, rateset

rate #.# = rateget(node name $)
rateset(node name $, rate #.#)

Set and get the playback rate. Set the rate to 1.0 for normal playback, 2.0 for twice as fast, etc.

reset

reset(node name $)

Resets the width and height of the node to the size of the movie.

resume

resume(node name $)

Resume restarts the movie from the current location.
See: ispaused, pause

startget, startset

start time #.# = startget(node name $)
startset(node name $, start time #.#)

Set and get the starting time for the movie. This is how far into the movie playback will begin. Set this before the movie starts playing.

The routines timeget and timeset control the current time of the movie and are used while the movie is playing.
See: timeget, timeset, isplaying

stop

stop(node name $)

Stop stops the movie.

timeget, timeset

time #.# = timeget(node name $)
timeset(node name $, time #.#)

Timeget will return the current position of the movie in fractional seconds. If the movie is stopped it will return 0.0.

Timeset will position the movie at the specified time. If the movie is stopped it will do nothing.
See: duration

volumeget, volumeset

volume # = volumeget(node name $)
volumeset(node name $, volume #)

Get or set the sound volume. This ranges from 0 for silent to 255 for full volume.