Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | Download | RSS feed

  1. /*
  2.    uFMOD API reference (AC97SND mode)
  3.    =========================================================
  4.  
  5.    NOTE: ufmod.obj should be rebuilt setting UF_MODE=AC97SND
  6.    in order to make it usable in AC97SND player.
  7.  
  8.    The Infinity Sound driver handle should be available as
  9.    a public symbol named hSound. It is so when using Serge's
  10.    sound.lib.
  11. */
  12.  
  13. #ifdef __cplusplus
  14.         extern "C" {
  15. #endif
  16.  
  17. /* HANDLE uFMOD_LoadSong(char *lpXM);
  18.    ---
  19.    Description:
  20.    ---
  21.       Loads the given XM song and starts playing it as soon as you
  22.       call uFMOD_WaveOut for the first time. It will stop any
  23.       currently playing song before loading the new one. Heap should
  24.       be initialized before calling this function!
  25.    ---
  26.    Parameters:
  27.    ---
  28.      lpXM
  29.         Specifies the filename of the song to load.
  30.    ---
  31.    Return Values:
  32.    ---
  33.       On success, returns a non zero value. Returns 0 on failure.
  34. */
  35. int __cdecl uFMOD_LoadSong(char*);
  36.  
  37. /* int uFMOD_WaveOut(SNDBUF hBuff)
  38.    ---
  39.    Description:
  40.    ---
  41.       Updates the internal playback buffer.
  42.    ---
  43.    Parameters:
  44.    ---
  45.      hBuff
  46.         The Infinity Sound buffer to update.
  47.    ---
  48.    Remarks:
  49.    ---
  50.       Playback doesn't actually begin when calling uFMOD_LoadSong,
  51.       but when calling uFMOD_WaveOut after a successful uFMOD_LoadSong
  52.       call. Afterwards, you should call uFMOD_WaveOut repeatedly at
  53.       least once every 250 ms to prevent "buffer underruns".
  54.       uFMOD_WaveOut is a non-blocking function.
  55.    ---
  56.    Return Values:
  57.    ---
  58.       Returns non zero on error.
  59. */
  60. int __cdecl uFMOD_WaveOut(unsigned int);
  61.  
  62. /* void uFMOD_StopSong(void)
  63.    ---
  64.    Description:
  65.    ---
  66.       Stops the currently playing song, freeing the associated
  67.       resources.
  68.    ---
  69.    Remarks:
  70.    ---
  71.       Does nothing if no song is playing at the time the call is made.
  72. */
  73. void __cdecl uFMOD_StopSong();
  74.  
  75. /* unsigned char* _uFMOD_GetTitle(void)
  76.    ---
  77.    Description:
  78.    ---
  79.       Returns the current song's title.
  80.    ---
  81.    Remarks:
  82.    ---
  83.       Not every song has a title, so be prepared to get an empty string.
  84. */
  85. unsigned char* __cdecl uFMOD_GetTitle();
  86.  
  87. #ifdef __cplusplus
  88.         }
  89. #endif
  90.