MovieWidget::PlayMovie

Defined in: C4Movies.h

Plays the movie associated with a movie widget.

Prototype

void PlayMovie(void);

Description

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

If a movie was previously stopped part way through, then calling the 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 PlayMovie function has no effect.