home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_BuildAudioCVT.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.0 KB  |  58 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_BuildAudioCVT"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_BuildAudioCVT- Initializes a SDL_AudioCVT structure for conversion
  13.  
  14. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  15. <p>
  16. <b>#include "SDL.h" <p>
  17. </b><b>int <b>SDL_BuildAudioCVT</b></b>(<b>SDL_AudioCVT *cvt, Uint16
  18. src_format, Uint8 src_channels, int src_rate, Uint16 dst_format, Uint8
  19. dst_channels, int dst_rate</b>); 
  20. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  21. <p>
  22. Before an <i><b>SDL_AudioCVT</b></i> structure
  23. can be used to convert audio data it must be initialized with source and
  24. destination information.  <p>
  25. <b>src_format</b> and <b>dst_format</b> are the source and destination
  26. format of the conversion. (For information on audio formats see <i><b> SDL_AudioSpec</b></i>).
  27. <b>src_channels</b> and <b>dst_channels</b> are the number of channels in the source
  28. and destination formats. Finally, <b>src_rate</b> and <b>dst_rate</b> are the frequency
  29. or samples-per-second of the source and destination formats. Once again, see
  30. <i><b>SDL_AudioSpec</b></i>. 
  31. <h2><a name='sect3' href='#toc3'>Return Values</a></h2>
  32. <p>
  33. Returns <b>-1</b> if the filter could not be built or
  34. 1 if it could. 
  35. <h2><a name='sect4' href='#toc4'>Examples</a></h2>
  36. <p>
  37. See <i><b>SDL_ConvertAudio</b></i>. 
  38. <h2><a name='sect5' href='#toc5'>See Also</a></h2>
  39. <p>
  40. <i><b>SDL_ConvertAudio</b></i>, <i><b>SDL_AudioCVT</b></i>
  41.  
  42. <!--
  43.   
  44.  <p>
  45.  
  46. <hr><p>
  47. <a name='toc'><b>Table of Contents</b></a><p>
  48. <ul>
  49. <li><a name='toc0' href='#sect0'>Name</a></li>
  50. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  51. <li><a name='toc2' href='#sect2'>Description</a></li>
  52. <li><a name='toc3' href='#sect3'>Return Values</a></li>
  53. <li><a name='toc4' href='#sect4'>Examples</a></li>
  54. <li><a name='toc5' href='#sect5'>See Also</a></li>
  55. </ul>
  56. </body>
  57. </html>
  58.