The options listed below should be passed to whoosh on its URL, as described on the publishing animations page.

basename

Required. This provides the base name for the animation, the part of the image filename up to (but not including) the number.

first

Default is 1. Paid version only. This specifies the number of the first keyframe. Note that it must be less than the last keyframe number.

last

Default is 10. Maximum of 10 in free version. This specifies the number of the last keyframe. Note that it must be more than the first keyframe number.

digits

Paid version only. This indicates how many digits to use in the keyframe numbers. If you do not specify a number, whoosh will determine the number of digits required for the last keyframe number, and use that. You can use this if you have used extra zeroes in your keyframe numbers.

speed

Default is 0.5. Paid version only. This specifies the default animation speed, in keyframes per second. (The default value thus indicates each keyframe will take two seconds.) The viewer can change this value once the movie is loaded, but this allows you to set the initial value.

rotate

Default is 0.025. Paid version only. This specifies the default rotation speed, in complete rotations per second. (The default value thus indicates a full 360° rotation will take forty seconds.) The viewer can change this value once the movie is loaded, but this allows you to set the initial value. Note that increasing this value too much can produce a very disorienting animation.

cushion

Default is 4.0. Paid version only. This value is used to control the acceleration of both zoom speed and rotation speed. It indicates the number of seconds it takes to accelerate one unit of speed. Note that a value of zero will result in instantaneous speed changes, which is very jarring. Also note that if you increase the default speed without also changing the cushion, it will take longer to reach the maximum speed. The viewer cannot change this value.

start

Default is auto for paid version, preload for free version. This controls how the movie should load and play images. Use auto to download images immediately and begin playing the movie as soon as images are loaded. Use preload to download the images immediately, but wait to begin playing until the viewer clicks a big “play” button. Use none to delay loading images until the user clicks “play” (then play the movie as the images are loaded).

loop

Default is bounce. Paid version only. This allows you to control what happens when the movie reaches the end. Use none to stop the movie. Use bounce to play the movie backwards. Use loop to reset to the beginning of the movie after stopping. Use loopfast to reset to the beginning of the movie without slowing down.

music

Paid version only. This provides the filename of an MP3 file to play along with the movie. You should be careful to only use MP3 files you have permission to publish on a web site; making copyrighted music available without permission can get you into legal trouble.

musicloop

Paid version only. This indicates whether the audio should stop when it reaches the end (use none) or continue playing from the beginning (use loop). This is ignored if no audio file was specified.

volume

Default is 75. Paid version only. This is the default volume, in percent. This is ignored if no audio file was specified.

moviecredit

Paid version only. This is a text string that is used to indicate a title and/or artist for the animation. Note that spaces and punctuation must be URL-encoded.

musiccredit

Paid version only. This is a text string that is used to indicate a title and/or artist for the audio. Note that spaces and punctuation must be URL-encoded. Giving credit is not a substitute for getting permission to use copyrighted music. This is ignored if no audio file was specified.

textcolor

Default is FFFFFF. Paid version only. This is a hex value that indicates the color for credit text. The default value gives the color white.

shadowcolor

Default is 000000. Paid version only. This is a hex value that indicates the color for credit text shadows. The default value gives the color black.

sx, sy

Defaults are 0. Paid version only. These options give the offset, in pixels, of credit text shadows. If zero is specified for both values, and the sr value is also zero, shadows are disabled.

sr

Default is 0. Paid version only. This sets the amount of blurring to use on the credit text shadows. If zero is specified for this and also for sx and sy, shadows are disabled.