MovieWidget::StopMovie

Defined in: C4Movies.h

Stops the movie associated with a movie widget.

Prototype

void StopMovie(void);

Description

The StopMovie function stops the movie associated with a movie widget. A movie can be played with the MovieWidget::PlayMovie function.

If a movie is stopped part way through, then a future call to the MovieWidget::PlayMovie function will resume playback at the point it was previously stopped. To reset the playback time to the beginning of the movie, call the MovieWidget::GetMovieObject function to retrieve the Movie object, and then call the Movie::SetMovieTime function to set the play time to zero before playing the movie.

If there is no movie associated with the movie widget, or there was an error loading the movie, then the StopMovie function has no effect.