home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PROG_C / SOUNDS.ZIP / MANUAL.DOC < prev    next >
Text File  |  1994-01-04  |  5KB  |  142 lines
  1. Sounds Class for C++.
  2. =====================
  3.  
  4.     This  class  contains  the necessary  functions to  enable  your  C++
  5. programs  to  output .VOC format  sound  files  through your SoundBlaster
  6. (or compatible) sound card.
  7.  
  8.     The version of  the software  works with 8-Bit  unpacked  .VOC  files,
  9. it  also  assumes that your  sound card uses  DMA  channel 1 and that  you
  10. know what  Interrupt number and  Base Address the  card uses. If in doubt,
  11. consult the  documentation that  came with your  sound card.  The upgraded
  12. version of the software (available to registered users) will automatically
  13. detect the Base Address and Interrupt number.
  14.  
  15.  
  16.  
  17. Functions.
  18. ==========
  19.  
  20. Sounds ( enum IRQ I, enum BASE B, enum SIZE s );
  21. ------------------------------------------------
  22. This  is the  constructor. Use  this to  create an  instance of the Sounds
  23. class, it  requires  that you give an  Interrupt Number,  Base Address and
  24. buffer size. Within the Sounds.h header file you will  find the enumerated
  25. data types  IRQ,  BASE  and  SIZE it is recommended that use you use these
  26. with the constructor
  27.  
  28. ~Sounds();
  29. ----------
  30. This  is  the  destructor.  Use  this  when  you  are  finished,  it  will
  31. de-allocate memory and de-install the interrupt handler.
  32.  
  33. long int Play( char * FileName);
  34. --------------------------------
  35. This  function actually plays the .VOC file. The FileName argument must be
  36. the  directory  (if not current directory)  and filename  of a valid 8-Bit
  37. unpacked .VOC file.  Always  check the  return value  for this function, a
  38. value of 1 is normal, anything else is an error condition.
  39.  
  40. void Error( long int status, char ** ptr );
  41. -------------------------------------------
  42. Translates  an  return  status  from Play ( see above ) in to a text error
  43. message.  If the return status from Play is anything other than 1 use this
  44. function  to get a description ( if somewhat terse ) of the error that has
  45. occured.
  46.  
  47. long int Finished;
  48. ------------------
  49. Not a  function  at all,  but still  important.  If you are playing a file
  50. how  does  your program  know when  the  file has finished playing? When a
  51. sound  file is  playing  Finished  will  have a  value of 0, when the file
  52. has finished playing it will have a value of 1.
  53.  
  54.     If  the above explanations  are not clear take a look at example1.cpp,
  55. all should become clear.
  56.  
  57.  
  58.  
  59. Files.
  60. ======
  61. The following files are include in this package.
  62.  
  63. Example1.cpp
  64. ------------
  65. An  example  of  the  use  of the  functions  provided in this version of
  66. the Sounds class.
  67.  
  68. Example1.voc, example2.voc, example3.voc
  69. ----------------------------------------
  70. Some sample sound files for use with example1.cpp.
  71.  
  72. Sndssmal.bat
  73. ------------
  74. A batch file to compile Example1.cpp using the small memory model and link
  75. it with the small memory model class library sndssmal.lib.
  76.  
  77. Sndsmedm.bat
  78. ------------
  79. A batch file to compile Example1.cpp using the medium memory model and link
  80. it with the medium memory model class library sndsmedm.lib.
  81.  
  82. Sndslrge.bat
  83. ------------
  84. A batch file to compile Example1.cpp using the large memory model and link
  85. it with the large memory model class library sndslrge.lib.
  86.  
  87. Sndssmal.lib, sndsmedm.lib, sndslrge.lib.
  88. -----------------------------------------
  89. Class libraries for the small medium and large memory models respectively.
  90.  
  91. Manual.doc
  92. ----------
  93. You are reading it now.
  94.  
  95.  
  96.  
  97. Registration
  98. ============
  99.  
  100.     This Shareware is available  for your  use and distribution without
  101. charge. However,  this version contains only a sub-set of the available
  102. functions. If you  do find these  functions usefull and think you would
  103. benefit from the expanded functionality in the upgraded version I would
  104. urge you to register with us by completing the form below.
  105.  
  106. Alternatively Compuserve members can register using GO SWREG.
  107.  
  108. ========================================================================
  109. Stephen A. Edwards                             Questions: (302) 234-1071
  110. 712 Chimney Hill Lane,                         Compuserve: 72520,1121
  111. Hockessin,
  112. Delaware,
  113. 19707.
  114.  
  115. If you  wish to register  with us so as to  receive the upgraded version
  116. of  the Sounds C++  Class please  complete  the  form below, remembering
  117. to circle  the disk size  that  you require.  Please include  a check or
  118. money order made payable to Stephen Edwards for $15 plus $2 for shipping
  119. and handling ( a total of $17). For international orders  please include
  120. $4 for shipping and handling ( a total of $19 ).
  121.  
  122. Thank you very much for your support.
  123.  
  124. IMPORTANT: Please circle disk size     5.25  or  3.5.
  125.  
  126. Your Details:
  127.  
  128.    Name:__________________________________________________
  129.  
  130. Address:__________________________________________________
  131.  
  132.    City:__________________________________________________
  133.  
  134.   State:____
  135.  
  136.     Zip:_________
  137.  
  138. Country:____________________
  139.  
  140.   Phone:_____________________________
  141.  
  142. =============================================================================