Source

pygame / src / doc / movie_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEMOVIE "pygame module for playback of mpeg video"

#define DOC_PYGAMEMOVIEMOVIE "Movie(filename) -> Movie\nMovie(object) -> Movie\nload an mpeg movie file"

#define DOC_MOVIEPLAY "play(loops=0) -> None\nstart playback of a movie"

#define DOC_MOVIESTOP "stop() -> None\nstop movie playback"

#define DOC_MOVIEPAUSE "pause() -> None\ntemporarily stop and resume playback"

#define DOC_MOVIESKIP "skip(seconds) -> None\nadvance the movie playback position"

#define DOC_MOVIEREWIND "rewind() -> None\nrestart the movie playback"

#define DOC_MOVIERENDERFRAME "render_frame(frame_number) -> frame_number\nset the current video frame"

#define DOC_MOVIEGETFRAME "get_frame() -> frame_number\nget the current video frame"

#define DOC_MOVIEGETTIME "get_time() -> seconds\nget the current vide playback time"

#define DOC_MOVIEGETBUSY "get_busy() -> bool\ncheck if the movie is currently playing"

#define DOC_MOVIEGETLENGTH "get_length() -> seconds\nthe total length of the movie in seconds"

#define DOC_MOVIEGETSIZE "get_size() -> (width, height)\nget the resolution of the video"

#define DOC_MOVIEHASVIDEO "has_video() -> bool\ncheck if the movie file contains video"

#define DOC_MOVIEHASAUDIO "has_audio() -> bool\ncheck if the movie file contains audio"

#define DOC_MOVIESETVOLUME "set_volume(value) -> None\nset the audio playback volume"

#define DOC_MOVIESETDISPLAY "set_display(Surface, rect=None) -> None\nset the video target Surface"



/* Docs in a comment... slightly easier to read. */

/*

pygame.movie
pygame module for playback of mpeg video

pygame.movie.Movie
 Movie(filename) -> Movie
 Movie(object) -> Movie
load an mpeg movie file

pygame.movie.Movie.play
 play(loops=0) -> None
start playback of a movie

pygame.movie.Movie.stop
 stop() -> None
stop movie playback

pygame.movie.Movie.pause
 pause() -> None
temporarily stop and resume playback

pygame.movie.Movie.skip
 skip(seconds) -> None
advance the movie playback position

pygame.movie.Movie.rewind
 rewind() -> None
restart the movie playback

pygame.movie.Movie.render_frame
 render_frame(frame_number) -> frame_number
set the current video frame

pygame.movie.Movie.get_frame
 get_frame() -> frame_number
get the current video frame

pygame.movie.Movie.get_time
 get_time() -> seconds
get the current vide playback time

pygame.movie.Movie.get_busy
 get_busy() -> bool
check if the movie is currently playing

pygame.movie.Movie.get_length
 get_length() -> seconds
the total length of the movie in seconds

pygame.movie.Movie.get_size
 get_size() -> (width, height)
get the resolution of the video

pygame.movie.Movie.has_video
 has_video() -> bool
check if the movie file contains video

pygame.movie.Movie.has_audio
 has_audio() -> bool
check if the movie file contains audio

pygame.movie.Movie.set_volume
 set_volume(value) -> None
set the audio playback volume

pygame.movie.Movie.set_display
 set_display(Surface, rect=None) -> None
set the video target Surface

*/