QuickTime Information

JavaScript Reference

QuickTime JavaScript Reference
T Method Description
© 2004 by Age Bosma
Movie Commands
v Play() Starts playing the movie.
v Stop() Stops playing the movie at the point in time at which the command is received.
v Rewind() Sets the current time to the movie's start time and pauses the movie.
v Step(i count) Steps the movie forward or backward the specified number of frames from the point at which the command is received.
v ShowDefaultView() Displays a QuickTime VR movie's default node, using the default pan angle, tilt angle, and field of view.
v GoPreviousNode() Returns to the previous node in a QuickTime VR movie.
Movie Properties
v SetRate(f rate) Sets the playback rate of the movie. A value of '1' indicates that the movie is playing in normally. A paused movie has a rate of '0'. Negative values indicate that the movie is playing in reverse. Setting the rate of a paused movie to a non-zero value starts the movie playing.
f GetRate() Returns the playback rate of the movie.
v SetTime(i time) Sets the current time of the specified QuickTime movie. Setting this property causes the movie to go to that time in the movie and stop.
i GetTime() Returns the current time of the specified QuickTime movie.
v SetVolume(i volume) Sets the audio volume of the movie. A negative value mutes the movie.
i GetVolume() Returns the audio volume of the movie.
v SetMovieName(s movieName) Sets the name optionally used by a wired sprite when targeting an external movie.
s GetMovieName() Returns the name optionally used by a wired sprite when targeting an external movie.
v SetMovieID(i movieID) Sets the ID optionally used by a wired sprite when targeting an external movie.
i GetMovieID() Returns the ID optionally used by a wired sprite when targeting an external movie.
v SetStartTime(i time) Sets the time at which it begins to play, and the time at which it loops when playing in reverse. Initially, the startTime of a movie is set to '0'.
i GetStartTime() Returns the time at which it begins to play.
v SetEndTime(i time) Sets the time at which the movie will loop or stop playing. Initially, the endTime of a movie is set to its duration
i GetEndTime() Returns the time at which the movie will loop or stop playing.
v SetBgColor(s color) Sets the color used to fill any space within the embed region not covered by the movie.
s GetBgColor() Returns the color used to fill any space and always returns the color number.
v SetIsLooping(b loop) Sets whether or not a movie loops when it reaches its end.
b GetIsLooping() Returns whether or not a movie loops when it reaches its end.
v SetLoopIsPalindrome(b loop) Sets whether or not a looping movie will reverse direction when it loops.
b GetLoopIsPalindrome() Returns whether or not a looping movie will reverse direction when it loops.
v SetMute(b mute) Sets the audio mute of a movie while maintaining the magnitude of the volume, so turning mute off restores the volume.
b GetMute() Returns the audio mute of a movie while maintaining the magnitude of the volume.
v SetPlayEveryFrame(b playAll) Sets whether or not a movie will play every frame.
b GetPlayEveryFrame() Returns whether or not a movie will play every frame.
v SetAutoPlay(b autoPlay) Sets Whether or not a movie will automatically start playing.
b GetAutoPlay() Returns whether or not a movie will automatically start playing.
v SetControllerVisible(b visible) Sets the visibility of the movie controller.
b GetControllerVisible() Returns the visibility of the movie controller.
v SetHREF(s URI) Sets the movie's 'href' parameter URI.
s GetHREF() Returns the movie's 'href' parameter URI.
v SetTarget(s target) Sets the movie's 'href' parameter URI target.
s GetTarget() Returns the movie's 'href' parameter URI target.
v SetQTNEXTUrl(i index, s URI) Sets the specified 'qtnextn' parameter URI and target.
s GetQTNEXTUrl(i index) Returns the specified 'qtnextn' parameter URI and target.
v SetHotspotUrl(i hotspotID, s URI) Sets the specified VR movie hotspot URI.
s GetHotspotUrl(i hotspotID) Returns the specified VR movie hotspot URI.
v SetHotspotTarget(i hotspotID, s target) Sets the specified VR movie hotspot URI target.
s GetHotspotTarget(i hotspotID) Returns the specified VR movie hotspot URI target.
v SetURL(s URI) Replaces the movie with that specified by the parameter.
s GetURL() Returns the movie's fully specified URI.
v SetKioskMode(b kioskMode) Sets whether or not the movie has to be playing in Kioskmode.
Note: If the movie's kioskmode parameter kioskmode set to 'true' this propertie does nothing.
b GetKioskMode() Returns whether or not the movie has to be playing in Kioskmode.
i GetDuration() Returns the length of the movie. in the movie's time scale
i GetMaxTimeLoaded() Returns the amount of the movie that has been downloaded. in the movie's time scale
i GetTimeScale() Returns the number of units of time per second in the movie.
i GetMovieSize() Returns the size of the movie in bytes.
i GetMaxBytesLoaded() Returns the number of bytes of the movie that have been downloaded.
v SetMatrix(s matrix) These allow you to set the movie's transformation matrix. QuickTime uses a 3 x 3 transformation matrix, represented in JavaScript by three lines of three numbers separated by commas:

a, b, u
c, d, v
h, k, w
Note: Normally, the QuickTime Plug-in keeps the movie centered within the embed area, even if the embed area changes. Once a movie's location is changed with SetRect or SetMatrix, the movie's absolute location within the embed area is maintained rather than centering it.
s GetMatrix() Returns the movie's transformation matrix.
v SetRectangle(s rect) These allow you to set location and dimensions of the movie within the embed area.
Note: Normally, the QuickTime Plug-in keeps the movie centered within the embed area, even if the embed area changes. Once a movie's location is changed with SetRect or SetMatrix, the movie's absolute location within the embed area is maintained rather than centering it.
s GetRectangle() Returns location and dimensions of the movie within the embed area.
v SetLanguage(s language) Sets the movie's current language. This causes the tracks associated with that language to be enabled and tracks associated with other languages to be disabled. If it cannot find an appropriate track for the specified language, the movie's language is not changed.
s GetLanguage() Returns the name of movie's current language.
s GetMIMEType() Returns the movie's MIME type.
s GetUserData(s type) Returns the movie user data text with the specified tag. The tag is specified with a four character string
e.g. `@cpy' returns a movie's copyright string.
Track Properties
i GetTrackCount() Returns the number of tracks in the movie.
s GetTrackName(i index) Returns the name of the specified track.
s GetTrackType(i index) Returns the type of the specified track.
v SetTrackEnabled(i index, b enabled) Sets the enabled state of a track.
b GetTrackEnabled(i index) Returns the enabled state of a track.
Sprite Track Properties
v SetSpriteTrackVariable(i trackIndex, i variableIndex, s value) Sets the specified sprite track variable in the specified track.
s GetSpriteTrackVariable(i trackIndex, i variableIndex) Returns the specified sprite track variable in the specified track.
VR Movie Properties
b GetIsVRMovie() Returns 'true' if the movie is a QuickTime VR movie, 'false' otherwise.
v SetPanAngle(f angle) Sets the QuickTime VR movie's pan angle.
in degrees
f GetPanAngle() Returns the QuickTime VR movie's pan angle.
in degrees
v SetTiltAngle(f angle) Sets the QuickTime VR movie's tilt angle.
in degrees
f GetTiltAngle() Returns the QuickTime VR movie's tilt angle.
in degrees
v SetFieldOfView(f fov) Sets the QuickTime VR movie's field of view.
in degrees
f GetFieldOfView() Returns the QuickTime VR movie's field of view.
in degrees
i GetNodeCount() Returns the number of nodes in a QuickTime VR movie.
i GetNodeID() Returns the ID of the current node in a QuickTime VR movie.
v SetNodeID(i id) Sets the current node in a QuickTime VR movie.
by ID
i.e., it goes to the node with the specified ID
Plug-in Properties
s GetPluginVersion() Returns the version of the QuickTime Plug-in.
s GetPluginStatus() Returns a string with the status of the current movie.
Possible states are:
  • "Waiting" - waiting for the movie data stream to begin
  • "Loading" - data stream has begun, not able to play/display the movie yet
  • "Playable" - movie is playable, although not all data has been downloaded
  • "Complete" - all data has been downloaded
  • "Error: <error number>" - the movie failed with the specified error number
v SetResetPropertiesOnReload(b reset)  
b GetResetPropertiesOnReload()  
QuickTime Properties
s GetQuickTimeVersion() Returns the version of QuickTime.
s GetQuickTimeLanguage() Returns the user's QuickTime language.
i GetQuickTimeConnectionSpeed() Returns the connection speed setting from the users QuickTime preferences.
b GetIsQuickTimeRegistered() Returns 'true' if the user is registered for the Pro version of QuickTime, it otherwise returns 'false'.
s GetComponentVersion(s type, s subType, s manufacturer) Returns the version of a specific QuickTime component. The component is specified using a four character string for the type, subType, and manufacturer.
e.g., to check the version of Apple's JPEG graphics importer call
GetComponentVersion('grip', 'JPEG', 'appl')
'0' is a wildcard for any field. If the component is not available, '0.0' is returned.