Source

pygame / src / doc / music_doc.h

Full commit
/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEMIXERMUSIC "pygame module for controlling streamed audio"

#define DOC_PYGAMEMIXERMUSICLOAD "pygame.mixer.music.load(filename): return None\npygame.mixer.music.load(object): return None\nLoad a music file for playback"

#define DOC_PYGAMEMIXERMUSICPLAY "pygame.mixer.music.play(loops=0, start=0.0): return None\nStart the playback of the music stream"

#define DOC_PYGAMEMIXERMUSICREWIND "pygame.mixer.music.rewind(): return None\nrestart music"

#define DOC_PYGAMEMIXERMUSICSTOP "pygame.mixer.music.stop(): return None\nstop the music playback"

#define DOC_PYGAMEMIXERMUSICPAUSE "pygame.mixer.music.pause(): return None\ntemporarily stop music playback"

#define DOC_PYGAMEMIXERMUSICUNPAUSE "pygame.mixer.music.unpause(): return None\nresume paused music"

#define DOC_PYGAMEMIXERMUSICFADEOUT "pygame.mixer.music.fadeout(time): return None\nstop music playback after fading out"

#define DOC_PYGAMEMIXERMUSICSETVOLUME "pygame.mixer.music.set_volume(value): return None\nset the music volume"

#define DOC_PYGAMEMIXERMUSICGETVOLUME "pygame.mixer.music.get_volume(): return value\nget the music volume"

#define DOC_PYGAMEMIXERMUSICGETBUSY "pygame.mixer.music.get_busy(): return bool\ncheck if the music stream is playing"

#define DOC_PYGAMEMIXERMUSICGETPOS "pygame.mixer.music.get_pos(): return time\nget the music play time"

#define DOC_PYGAMEMIXERMUSICQUEUE "pygame.mixer.music.queue(filename): return None\nqueue a music file to follow the current"

#define DOC_PYGAMEMIXERMUSICSETENDEVENT "pygame.mixer.music.set_endevent(): return None\npygame.mixer.music.set_endevent(type): return None\nhave the music send an event when playback stops"

#define DOC_PYGAMEMIXERMUSICGETENDEVENT "pygame.mixer.music.get_endevent(): return type\nget the event a channel sends when playback stops"



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


/*

pygame.mixer.music
 pygame module for controlling streamed audio



pygame.mixer.music.load
 pygame.mixer.music.load(filename): return None
pygame.mixer.music.load(object): return None
Load a music file for playback



pygame.mixer.music.play
 pygame.mixer.music.play(loops=0, start=0.0): return None
Start the playback of the music stream



pygame.mixer.music.rewind
 pygame.mixer.music.rewind(): return None
restart music



pygame.mixer.music.stop
 pygame.mixer.music.stop(): return None
stop the music playback



pygame.mixer.music.pause
 pygame.mixer.music.pause(): return None
temporarily stop music playback



pygame.mixer.music.unpause
 pygame.mixer.music.unpause(): return None
resume paused music



pygame.mixer.music.fadeout
 pygame.mixer.music.fadeout(time): return None
stop music playback after fading out



pygame.mixer.music.set_volume
 pygame.mixer.music.set_volume(value): return None
set the music volume



pygame.mixer.music.get_volume
 pygame.mixer.music.get_volume(): return value
get the music volume



pygame.mixer.music.get_busy
 pygame.mixer.music.get_busy(): return bool
check if the music stream is playing



pygame.mixer.music.get_pos
 pygame.mixer.music.get_pos(): return time
get the music play time



pygame.mixer.music.queue
 pygame.mixer.music.queue(filename): return None
queue a music file to follow the current



pygame.mixer.music.set_endevent
 pygame.mixer.music.set_endevent(): return None
pygame.mixer.music.set_endevent(type): return None
have the music send an event when playback stops



pygame.mixer.music.get_endevent
 pygame.mixer.music.get_endevent(): return type
get the event a channel sends when playback stops



*/