home *** CD-ROM | disk | FTP | other *** search
/ PC Loisirs 18 / cd.iso / sharewar / mikm202 / docs / mplayer.doc < prev    next >
Encoding:
Text File  |  1995-09-18  |  2.5 KB  |  120 lines
  1. ┌──────────────────────────────┐
  2. │MPLAYER.C Module Documentation│
  3. └──────────────────────────────┘
  4.  
  5. Date last modified: April 14, 1995
  6.  
  7. If you want to use any of the routines of this module, include "mplayer.h"
  8. and add MPLAYER.C to your project. This module also uses MDRIVER.C, UNITRK.C
  9. so add those to your project too.
  10.  
  11. ════════════════════════════════════════════════════════════════════════════════
  12.  
  13. MPLAYER public variables:
  14.  
  15. // read only (not really, but it's not wise to change 'em):
  16.  
  17. AUDTMP mp_audio[32];    // the 32 temporary channels
  18. UBYTE  mp_bpm;        // beats-per-minute speed
  19. UWORD  mp_patpos;    // current row number
  20. int    mp_sngpos;    // current song position
  21. UWORD  mp_sngspd;    // current songspeed
  22.  
  23. // read/write variables:
  24.  
  25. BOOL  mp_loop       // enable/disable looping
  26. BOOL  mp_panning    // enable/disable panning
  27. BOOL  mp_extspd        // enable/disable extended (bpm) speed 
  28. UBYTE mp_volume         // song volume (0-100)
  29.  
  30. ════════════════════════════════════════════════════════════════════════════════
  31.  
  32. void MP_Init(UNIMOD *m)
  33. =======================
  34.  
  35. Input parms:
  36.  
  37.     m       Pointer to a UNIMOD module (which was loaded with MLOADER.C)
  38.  
  39.  
  40. Returns:
  41.  
  42.     -
  43.  
  44. Description:
  45.  
  46. Initializes the module player to start playing this module the next time 
  47. MP_HandleTick() is called.
  48.  
  49. ════════════════════════════════════════════════════════════════════════════════
  50.  
  51. void MP_HandleTick(void)
  52. =======================
  53.  
  54. Input parms:
  55.  
  56.     -
  57.  
  58. Returns:
  59.  
  60.     -
  61.  
  62. Description:
  63.  
  64. You have to call this routine at the current BPM rate (mp_bpm) to play the 
  65. song you initialized with MP_Init().
  66.  
  67. ════════════════════════════════════════════════════════════════════════════════
  68.  
  69. BOOL MP_Ready(void)
  70. ===================
  71.  
  72. Input parms:
  73.  
  74.     -
  75.  
  76. Returns:
  77.  
  78.     True if the song is finished, FALSE if not.
  79.  
  80. Description:
  81.  
  82. Use this routine to check if a module is done playing. This is only useful if 
  83. you set the variable mp_loop to 0, so a song won't restart when it's done.
  84.  
  85. ════════════════════════════════════════════════════════════════════════════════
  86.  
  87. void MP_PrevPosition(void)
  88. ==========================
  89.  
  90. Input parms:
  91.  
  92.     -
  93.  
  94. Returns:
  95.  
  96.     -
  97.  
  98. Description:
  99.  
  100. skips a song to the previous pattern.
  101.  
  102. ════════════════════════════════════════════════════════════════════════════════
  103.  
  104. void MP_NextPosition(void)
  105. ==========================
  106.  
  107. Input parms:
  108.  
  109.     -
  110.  
  111. Returns:
  112.  
  113.     -
  114.  
  115. Description:
  116.  
  117. skips a song to the next pattern.
  118.  
  119. ════════════════════════════════════════════════════════════════════════════════
  120.