Filewatcher File Search File Search
Content Search
» » » » » pykaraoke-bin_0.7.5-1_all.deb » Content »
pkg://pykaraoke-bin_0.7.5-1_all.deb:10522/usr/share/man/man6/  info  control  downloads

pykaraoke-bin - free CDG/MIDI/MPEG karaoke player…  more info»


PYCDG(6)                                                    PYCDG(6)

       pykaraoke - free CDG/MIDI/MPEG karaoke player

       pycdg [ options ] songfilename.cdg

       pykaraoke  is  a  free  karaoke player for Linux, FreeBSD and

       pycdg is a CDG karaoke player which supports MP3+G and  OGG+G

       The  player uses the pygame library (, and can
       therefore run on any operating system that runs pygame  (cur‐
       rently Linux, FreeBSD, Windows and OSX).

       You  can  use  this  file as a standalone player, or together
       with PyKaraoke. PyKaraoke provides a  graphical  user  inter‐
       face, playlists, searchable song database etc.

       For those writing a media player or similar project who would
       like CDG support, this module has been designed to be  easily
       incorporated  into  such  projects  and is released under the

       Numeric module ( is  required  only  if
       you do not use the compiled C low-level CDG implementation in

       To start the player, pass the CDG filename/path on  the  com‐
       mand line:

            python /path/song.cdg

       You can also incorporate a CDG player in your own projects by
       importing this module. The class cdgPlayer is exported by the
       module. You can import and start it as follows:

            import pycdg
            player = pycdg.cdgPlayer("/path/song.cdg")

       If  you  do  this,  you  must also arrange to call‐
       ager.Poll() from time to time, at least every  100  millisec‐
       onds or so, to allow the player to do its work.

       The class also exports Close(), Pause(), Rewind(), GetPos().

       There   are  two  optional  parameters  to  the  initialiser,
       errorNotifyCallback and doneCallback:

       errorNotifyCallback, if provided, will be used to  print  out
       any  error  messages  (e.g. song file not found). This allows
       the module to fit together well with GUI playlist managers by
       utilising  the  same  GUI's  error popup window mechanism (or
       similar). If no callback is provided, errors are  printed  to
       stdout.  errorNotifyCallback  should  take one parameter, the
       error string, e.g.:

            def errorPopup (ErrorString):
                 msgBox (ErrorString)

       doneCallback can be used to register a callback so  that  the
       player  calls you back when the song is finished playing. The
       callback should take no parameters, e.g.:

            def songFinishedCallback():
                 msgBox ("Song is finished")

       To register callbacks, pass the  functions  in  to  the  ini‐

            cdgPlayer  ("/path/song.cdg",  errorPopup, songFinished‐

       These parameters are optional and default to None.

       If the initialiser fails (e.g. the song file is not present),
       __init__ raises an exception.

       pycdg also takes various command-line options for setting the
       window size, position, and update rate.  Type  the  following
       for a full list of options:

       $ pycdg --help

       You     can     find     PyKaraoke's     home     page    at:

       PyKaraoke was written by Kelvin Lawson <kelvinl@users.source‐> and William Ferrell <>.

       This   manual   page   was   written  by  Miriam  Ruiz  <lit‐>, for the Debian project (but may  be  used
       by others).

                            july 16, 2006                   PYCDG(6)
Results 1 - 1 of 1
Help - FTP Sites List - Software Dir.
Search over 15 billion files
© 1997-2017