Play

Description

Starts playing an animation (an AVI clip).

Applies to

Animation controls

Syntax

animationname.Play ( from, to, replay )

Argument

Description

animationname

The name of the animation control displaying the AVI clip.

from

A long value in the range 0 to 65,535 indicating the frame where playing starts.The value 0 starts playing the clip at the first frame.

to

A long value in the range -1 to 65,535 indicating the frame where playing ends. The value -1 stops playing the clip at the last frame.

replay

A long value in the range -1 to 65,535 indicating the number of times to replay the clip. The value -1 continues playing the clip indefinitely.


Return value

Integer. Returns 1 for success and -1 for failure.

Usage

Start plays an opened AVI file in an animation control. If you specify a value for any argument that is not in the specified range, Start does nothing and returns -1.

Examples

This example starts playing an AVI clip at the first frame, plays to the last frame, and continues playing the clip indefinitely:

integer li_return
li_return = am_1.Play(0, -1, -1)

See also

Stop