int mmpAnimate(idMovie)
This function prompts the Movie Player to advance to the next segment in the animation. The action taken by the Movie Player depends on the current state of the animation. The mmpAnimate return values describe the action taken and report the animation status.
MMPID idMovie
Identifies the movie ID of the Movie Player instance.
Returns zero if unsuccessful or a status code if successful. Negative status codes indicate the Movie Player is waiting for a Windows message; when calling mmpAnimate from the message loop, you should call WaitMessage if mmpAnimate returns a negative value. The following return values report the current state of the animation:
MMP_ANIM_DRAW
The Movie Player drew a subframe on this call. If the movie frame contains complex transitions involving subframes, the MMP_ANIM_DRAW value is returned multiple times until the last drawing step is completed for the given frame (at which point the function returns MMP_ANIM_DRAWN).
If the movie frame contains a simple transition such as a straight copy, the transition requires only one mmpAnimate call and the function never returns MMP_ANIM_DRAW for the current frame.
MMP_ANIM_DRAWN
The Movie Player finished drawing the frame on this call. This value is returned once per frame.
MMP_TEMPO_WAIT
The Movie Player is waiting for the frame's display period (defined by its tempo setting) to expire. This value is also returned when the Movie Player is waiting for a cast sound to finish playing. This value can be returned multiple times per frame.
MMP_ANIM_SCRIPT_PROCESSED
The Movie Player processed the frame script text on this call. This value is returned once for each frame that contains script-channel text.
MMP_FRAME_DONE
The Movie Player has completed all processing for the current frame and will begin processing the next frame. This flag is returned once for each frame and is always the last value returned for the frame. If you want to stop the animation on a certain frame number, call mmpStopAnimating after receiving this return flag for the given frame.
MMP_MOUSE_WAIT
The Movie Player is waiting for the stage window to receive a mouse-button message. This return value occurs on movie frames that specify a wait-for-mouse tempo value. This value can be returned multiple times per frame.
MMP_DEVICE_WAIT
The Movie Player is waiting for an MCI device to finish playing. This return value occurs on movie frames that specify an mciWait script-channel command. This value can be returned multiple times per frame.
MMP_ANIM_STOPPED
The animation is stopped. Possible reasons are mmpStartAnimating has not been called, mmpStopAnimating was called, or the movie reached the last frame.
To notify the Movie Player that animation is to begin, you must call mmpStartAnimating once before calling this function.
mmpStartAnimating, mmpStopAnimating, mmpAnimStatus, mmpAnimStopped