Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

Inside Macintosh: Apple Guide Complete / Part 4 - Scripting Guide Files

Chapter 10 - Guide Script Command Reference / Guide Script Command Descriptions

<QuickTime>
You can use the <QuickTime> command to specify a QuickTime movie in a panel.
<QuickTime> QTMovie, location, QTcontroller [, moviePict]
QTMovie
A filename of the file containing the movie to place on the panel. This file must be located in the same folder as your source files when you compile your guide file. A guide file and any movies used by the guide file must reside in the same folder.
location
A constant specifying the general location of the movie or a specific point describing the coordinates of the movie relative to the current pen location.

To describe a specific point (relative to the current pen location), use the Point function. The current pen location's horizontal coordinate is the left edge of the current format; its vertical coordinate corresponds to the bottom edge of the last object not specifically placed using coordinates.

You can use these constants to describe the movie location:
LEFT CENTER RIGHT

If you specify one of these constants, Guide Maker justifies the movie accordingly within the current format.
QTcontroller
A constant specifying the type of controller to use with the QuickTime movie. You can use these constants to describe the type of controller:
CONTROL BADGE PLAIN

Use the CONTROL constant to display the standard movie controller with the movie. The user can use the elements in the movie controller to control the playback of the movie. Use the BADGE constant to display a badge, a visual element that appears on the movie when the controller is not showing or the movie is not playing. When the user double-clicks a badge, a controller appears. Use the PLAIN constant if you do not want to provide a controller or a badge with the movie. Regardless of which constant you specify, the user can double-click the movie to play the movie, and click again to stop playing the movie.
moviePict
A resource ID or resource name of a 'PICT' graphic, or a filename of a file containing a 'PICT' graphic, that Apple Guide uses in place of the QuickTime movie described by the QTMovie parameter only if QuickTime is not loaded or the movie file cannot be found. The replacement picture should have the same size as the QuickTime movie. This parameter is optional.

If you specify the picture by resource ID or resource name, you must make the resource available to Guide Maker using the <Resource> command. If you specify a filename, the file must be in the same folder as your source files in order for Guide Maker to find the file.

DESCRIPTION
The <QuickTime> command places a QuickTime movie on a panel.
The movie appears inline with the surrounding text. To specify the movie's general location use the constants LEFT, CENTER, or RIGHT. If you do this, Guide Maker justifies the movie according to the current format. You can also specify the movie's location relative to the current pen position by specifying a specific point. For example, if you specify the movie location as Point(50, 100), Guide Maker positions the movie 50 pixels to the right and 100 pixels down from the current pen location.

SPECIAL CONSIDERATIONS
You can use only one QuickTime movie per panel. In Apple Guide, the amount of memory available for a QuickTime movie is limited; large movies might exceed the limit.

EXAMPLES
<Define Panel> "Example Panel With Movie 1"
   #place a QuickTime movie on the panel (specified by filename),
   # centered in current format, display badge, 
   # and specify replacement picture by filename
   <QuickTime> "My QT Movie", CENTER, BADGE, "My Movie PICT"
<End Panel>

<Resource> "My Movie Pict 2", 'PICT', "Movie Pict"
<Define Panel> "Example Panel With Movie 2"
   #place a QuickTime movie on the panel (specified by filename),
   # centered in current format, display controller, 
   # and specify replacement picture by resource name
   <QuickTime> "My QT Movie", CENTER, BADGE, "Movie Pict"
<End Panel>

<Resource> "My Pict for Movie", 'PICT', 2228
<Define Panel> "Example Panel With Movie 3"
   #place a QuickTime movie on the panel (specified by filename),
   # centered in current format, no controller and no badge, 
   # and specify replacement picture as resource w/ res ID 2228
   <QuickTime> "My QT Movie", CENTER, PLAIN, 2228
<End Panel>
SEE ALSO
The <Resource> command is described in the next section.