Play Method (ANIMATE)

9.0, PLBCMP GUI Only

The Play method starts an AVI file that has been opened in an ANIMATE object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An ANIMATE object that is accessed.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

start

Optional. A Numeric Variable or decimal number that specifies the starting frame.

end

Optional. A Numeric Variable or decimal number that specifies the ending frame.

repeat

Optional. A Numeric Variable or decimal number that specifies the number of times to repeat the animation.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The first frame position is zero (0).

2. The default value for the {start} parameter is zero.

3. The default value for the {end} parameter is the last frame.

4. The default value for the {repeat} parameter is to replay the clip indefinitely.

5. A return value of zero indicates success.

6. If the value returned is zero, the ZERO Condition Flag is set.

7. The OVER and EOS Condition Flags are always cleared.

8. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

See Also: Example Code, Method Syntax, ANIMATE Methods