home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 22 / AACD 22.iso / AACD / Programming / XMPlayer-library / AutoDoc / xmplayer.doc
Encoding:
Text File  |  2001-04-17  |  5.0 KB  |  238 lines
  1.  
  2. TABLE OF CONTENTS
  3.  
  4. xmplayer.library/XMPl_Init
  5. xmplayer.library/XMPl_Play
  6. xmplayer.library/XMPl_StopPlay
  7. xmplayer.library/XMPl_PausePlay
  8. xmplayer.library/XMPl_ContPlay
  9. xmplayer.library/XMPl_SetPos
  10. xmplayer.library/XMPl_GetPos
  11. xmplayer.library/XMPl_DeInit
  12.  
  13. xmplayer.library/XMPl_Init     xmplayer.library/XMPl_Init
  14.  
  15.    NAME
  16.     XMPl_Init -- Inits a player structure & player.
  17.  
  18.    SYNOPSIS
  19.     error=XMPl_Init(XMPlayerInfo)
  20.       D0      A0
  21.  
  22.     BOOL XMPl_Init(struct XMPlayerInfo *);
  23.  
  24.    FUNCTION
  25.     This function initialize a XMPlayerInfo filled by user and initialies a player.
  26.  
  27.    INPUTS
  28.  
  29.     XMPlayerInfo - a structure XMPlayerInfo filled by user
  30.  
  31.     XMPlayerInfo must be filled with the following information:
  32.         -----------------------------------------------------------
  33.     XMPl_Cont = pointer to a FastTracker module (XM).
  34.     XMPl_MixType = type of module mixing. Following types available:
  35.             XM_MONO = mono mixing - fast but low quality.
  36.             XM_STEREO = stereo mixing - fast and medium quality.
  37.             XM_SURROUND = stereo surround mixing - pseudo surround,
  38.                                       partly eliminates "Paula Stereo" problem.
  39.             XM_REALSURR = stereo real surround mixing - better surround,
  40.                                       partly eliminates "Paula Stereo" problem.
  41.             XM_STEREO14 = 14 bit stereo mixing - high quality but slowest.
  42.     XMPl_MixFreq = mixing frequency in Hz (0-n). Maximum frequency is dependent from
  43.                        display mode. High mixing frequency works slower.
  44.     XMPl_VBoost  = volume boost value (0-8).
  45.     XMPl_PrName  = pointer to NULL terminated string which contain name for player
  46.                        process.
  47.     XMPl_PrPri   = Priority for player process (-127 - 127).
  48.  
  49.    RESULT
  50.     In D0 returns FALSE if initialization fails.
  51.  
  52.    NOTES
  53.      XMPlayerInfo MUST be filled with valid values and XMPl_Cont must be a XM module.
  54.  
  55.    SEE ALSO
  56.         xmplayer.library/XMPl_DeInit
  57. xmplayer.library/XMPl_Play     xmplayer.library/XMPl_Play
  58.  
  59.    NAME
  60.     XMPl_Play -- Plays a FastTracker module.
  61.  
  62.    SYNOPSIS
  63.     error = XMPl_Play()
  64.         D0
  65.  
  66.     BOOL XMPl_Play(void);
  67.  
  68.    FUNCTION
  69.     This function creates port (see XMPlayerInfo -> XMPl_PrName) and
  70.     plays a FastTracker module.
  71.  
  72.    INPUTS
  73.     NONE
  74.  
  75.    RESULT
  76.     error - if the player started successfully, this will be TRUE.
  77.         Else an error value will be FALSE.
  78.  
  79.    NOTES
  80.     You cannot play two module at the same time.
  81.  
  82.    SEE ALSO
  83.     xmplayer.library/XMPl_Play
  84. xmplayer.library/XMPl_StopPlay     xmplayer.library/XMPl_StopPlay
  85.  
  86.    NAME
  87.     XMPl_StopPlay -- Stops playing a FastTracker module.
  88.  
  89.    SYNOPSIS
  90.     XMPl_StopPlay()
  91.  
  92.     void XMPl_StopPlay(void);
  93.  
  94.    FUNCTION
  95.     This function stops playing a FastTracker module.
  96.  
  97.    INPUTS
  98.     NONE
  99.  
  100.    RESULT
  101.     NONE
  102.  
  103.    NOTES
  104.     You cannot stop if you don't call XMPl_Play becourse this will wait for
  105.     player process ends and creates a infinite loop.
  106.  
  107.    SEE ALSO
  108.     xmplayer.library/XMPl_Play
  109. xmplayer.library/XMPl_PausePlay     xmplayer.library/XMPl_PausePlay
  110.  
  111.    NAME
  112.     XMPl_PausePlay -- Pause a a FastTracker module.
  113.  
  114.    SYNOPSIS
  115.     XMPl_PausePlay()
  116.  
  117.     void XMPl_PausePlay(void);
  118.  
  119.    FUNCTION
  120.     This function pause a FastTracker module.
  121.  
  122.    INPUTS
  123.     NONE
  124.  
  125.    RESULT
  126.     NONE
  127.  
  128.    NOTES
  129.     NONE
  130.  
  131.    SEE ALSO
  132.     xmplayer.library/XMPl_ContPlay
  133.  
  134. xmplayer.library/XMPl_ContPlay     xmplayer.library/XMPl_ContPlay
  135.  
  136.    NAME
  137.     XMPl_ContPlay -- Continues a paused FastTracker module.
  138.  
  139.    SYNOPSIS
  140.     XMPl_ContPlay()
  141.  
  142.     void XMPl_ContPlay(void);
  143.  
  144.    FUNCTION
  145.     This function continues a paused FastTracker module.
  146.  
  147.    INPUTS
  148.     NONE
  149.  
  150.    RESULT
  151.     NONE
  152.  
  153.    NOTES
  154.     NONE
  155.  
  156.    SEE ALSO
  157.     xmplayer.library/XMPl_PausePlay
  158. xmplayer.library/XMPl_SetPos     xmplayer.library/XMPl_SetPos
  159.  
  160.    NAME
  161.     XMPl_SetPos -- Set a new position for a FastTracker module.
  162.  
  163.    SYNOPSIS
  164.     XMPl_SetPos( NewPosition )
  165.             D0
  166.  
  167.     void XMPl_SetPos( LONG );
  168.  
  169.    FUNCTION
  170.     After this function has been called, player will jump to a NewPosition in
  171.     FastTracker module.
  172.  
  173.    INPUTS
  174.     NewPosition = new position in a FastTracker module.
  175.  
  176.    RESULT
  177.     NONE
  178.  
  179.    NOTES
  180.     NONE
  181.  
  182.    SEE ALSO
  183.     xmplayer.library/XMPl_GetPos
  184. xmplayer.library/XMPl_GetPos     xmplayer.library/XMPl_GetPos
  185.  
  186.    NAME
  187.     XMPl_GetPos -- Gets and returns a position in a FastTracker module and a
  188.                current pattern position to a XMPlayer structure.
  189.  
  190.    SYNOPSIS
  191.     XMPl_GetPos(XMPlayerPos)
  192.           A0
  193.  
  194.     void XMPl_GetPos(  struct XMPlayerPos * );
  195.  
  196.    FUNCTION
  197.     This function gets and returns a position in FastTracker module and a
  198.     current pattern position to a XMPlayer structure.
  199.  
  200.    INPUTS
  201.     NONE
  202.  
  203.    RESULT
  204.     XMPlayerPos structure will be filled with the following information:
  205.         --------------------------------------------------------------------
  206.     XMPl_ModPos = position in a FastTracker module.
  207.     XMPl_PattPos = current pattern position.
  208.  
  209.    NOTES
  210.     NONE
  211.  
  212.    SEE ALSO
  213.     xmplayer.library/XMPl_SetPos
  214. xmplayer.library/XMPl_DeInit     xmplayer.library/XMPl_DeInit
  215.  
  216.    NAME
  217.     XMPl_DeInit -- Deinits a player.
  218.  
  219.    SYNOPSIS
  220.     XMPl_DeInit()
  221.  
  222.     void XMPl_DeInit(void);
  223.  
  224.    FUNCTION
  225.     This function deinitialize a player.
  226.  
  227.    INPUTS
  228.     NONE
  229.  
  230.    RESULT
  231.     NONE
  232.  
  233.    NOTES
  234.     NONE
  235.  
  236.    SEE ALSO
  237.     xmplayer.library/XMPl_Init
  238.