docs/html/sdlbuildaudiocvt.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_BuildAudioCVT</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
   8 "><LINK
   9 REL="HOME"
  10 TITLE="SDL Library Documentation"
  11 HREF="index.html"><LINK
  12 REL="UP"
  13 TITLE="Audio"
  14 HREF="audio.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="SDL_AudioCVT"
  17 HREF="sdlaudiocvt.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_ConvertAudio"
  20 HREF="sdlconvertaudio.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFF8DC"
  24 TEXT="#000000"
  25 LINK="#0000ee"
  26 VLINK="#551a8b"
  27 ALINK="#ff0000"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 SUMMARY="Header navigation table"
  32 WIDTH="100%"
  33 BORDER="0"
  34 CELLPADDING="0"
  35 CELLSPACING="0"
  36 ><TR
  37 ><TH
  38 COLSPAN="3"
  39 ALIGN="center"
  40 >SDL Library Documentation</TH
  41 ></TR
  42 ><TR
  43 ><TD
  44 WIDTH="10%"
  45 ALIGN="left"
  46 VALIGN="bottom"
  47 ><A
  48 HREF="sdlaudiocvt.html"
  49 ACCESSKEY="P"
  50 >Prev</A
  51 ></TD
  52 ><TD
  53 WIDTH="80%"
  54 ALIGN="center"
  55 VALIGN="bottom"
  56 ></TD
  57 ><TD
  58 WIDTH="10%"
  59 ALIGN="right"
  60 VALIGN="bottom"
  61 ><A
  62 HREF="sdlconvertaudio.html"
  63 ACCESSKEY="N"
  64 >Next</A
  65 ></TD
  66 ></TR
  67 ></TABLE
  68 ><HR
  69 ALIGN="LEFT"
  70 WIDTH="100%"></DIV
  71 ><H1
  72 ><A
  73 NAME="SDLBUILDAUDIOCVT"
  74 ></A
  75 >SDL_BuildAudioCVT</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN7002"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_BuildAudioCVT&nbsp;--&nbsp;Initializes a SDL_AudioCVT structure for conversion</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN7005"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN7006"
  95 ></A
  96 ><P
  97 ></P
  98 ><PRE
  99 CLASS="FUNCSYNOPSISINFO"
 100 >#include "SDL.h"</PRE
 101 ><P
 102 ><CODE
 103 ><CODE
 104 CLASS="FUNCDEF"
 105 >int <B
 106 CLASS="FSFUNC"
 107 >SDL_BuildAudioCVT</B
 108 ></CODE
 109 >(SDL_AudioCVT *cvt, Uint16 src_format, Uint8 src_channels, int src_rate, Uint16 dst_format, Uint8 dst_channels, int dst_rate);</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN7012"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 >Before an <A
 124 HREF="sdlaudiocvt.html"
 125 ><SPAN
 126 CLASS="STRUCTNAME"
 127 >SDL_AudioCVT</SPAN
 128 ></A
 129 > structure can be used to convert audio data it must be initialized with source and destination information. </P
 130 ><P
 131 ><TT
 132 CLASS="PARAMETER"
 133 ><I
 134 >src_format</I
 135 ></TT
 136 > and <TT
 137 CLASS="PARAMETER"
 138 ><I
 139 >dst_format</I
 140 ></TT
 141 > are the source and destination format of the conversion. (For information on audio formats see <A
 142 HREF="sdlaudiospec.html"
 143 ><SPAN
 144 CLASS="STRUCTNAME"
 145 > SDL_AudioSpec</SPAN
 146 ></A
 147 >). <TT
 148 CLASS="PARAMETER"
 149 ><I
 150 >src_channels</I
 151 ></TT
 152 > and <TT
 153 CLASS="PARAMETER"
 154 ><I
 155 >dst_channels</I
 156 ></TT
 157 > are the number of channels in the source and destination formats. Finally, <TT
 158 CLASS="PARAMETER"
 159 ><I
 160 >src_rate</I
 161 ></TT
 162 > and <TT
 163 CLASS="PARAMETER"
 164 ><I
 165 >dst_rate</I
 166 ></TT
 167 > are the frequency or samples-per-second of the source and destination formats. Once again, see <A
 168 HREF="sdlaudiospec.html"
 169 ><SPAN
 170 CLASS="STRUCTNAME"
 171 >SDL_AudioSpec</SPAN
 172 ></A
 173 >.</P
 174 ></DIV
 175 ><DIV
 176 CLASS="REFSECT1"
 177 ><A
 178 NAME="AEN7028"
 179 ></A
 180 ><H2
 181 >Return Values</H2
 182 ><P
 183 >Returns <SPAN
 184 CLASS="RETURNVALUE"
 185 >-1</SPAN
 186 > if the filter could not be built or 1 if it could.</P
 187 ></DIV
 188 ><DIV
 189 CLASS="REFSECT1"
 190 ><A
 191 NAME="AEN7032"
 192 ></A
 193 ><H2
 194 >Examples</H2
 195 ><P
 196 >See <A
 197 HREF="sdlconvertaudio.html"
 198 ><TT
 199 CLASS="FUNCTION"
 200 >SDL_ConvertAudio</TT
 201 ></A
 202 >.</P
 203 ></DIV
 204 ><DIV
 205 CLASS="REFSECT1"
 206 ><A
 207 NAME="AEN7037"
 208 ></A
 209 ><H2
 210 >See Also</H2
 211 ><P
 212 ><A
 213 HREF="sdlconvertaudio.html"
 214 ><TT
 215 CLASS="FUNCTION"
 216 >SDL_ConvertAudio</TT
 217 ></A
 218 >,
 219 <A
 220 HREF="sdlaudiocvt.html"
 221 ><TT
 222 CLASS="FUNCTION"
 223 >SDL_AudioCVT</TT
 224 ></A
 225 ></P
 226 ></DIV
 227 ><DIV
 228 CLASS="NAVFOOTER"
 229 ><HR
 230 ALIGN="LEFT"
 231 WIDTH="100%"><TABLE
 232 SUMMARY="Footer navigation table"
 233 WIDTH="100%"
 234 BORDER="0"
 235 CELLPADDING="0"
 236 CELLSPACING="0"
 237 ><TR
 238 ><TD
 239 WIDTH="33%"
 240 ALIGN="left"
 241 VALIGN="top"
 242 ><A
 243 HREF="sdlaudiocvt.html"
 244 ACCESSKEY="P"
 245 >Prev</A
 246 ></TD
 247 ><TD
 248 WIDTH="34%"
 249 ALIGN="center"
 250 VALIGN="top"
 251 ><A
 252 HREF="index.html"
 253 ACCESSKEY="H"
 254 >Home</A
 255 ></TD
 256 ><TD
 257 WIDTH="33%"
 258 ALIGN="right"
 259 VALIGN="top"
 260 ><A
 261 HREF="sdlconvertaudio.html"
 262 ACCESSKEY="N"
 263 >Next</A
 264 ></TD
 265 ></TR
 266 ><TR
 267 ><TD
 268 WIDTH="33%"
 269 ALIGN="left"
 270 VALIGN="top"
 271 >SDL_AudioCVT</TD
 272 ><TD
 273 WIDTH="34%"
 274 ALIGN="center"
 275 VALIGN="top"
 276 ><A
 277 HREF="audio.html"
 278 ACCESSKEY="U"
 279 >Up</A
 280 ></TD
 281 ><TD
 282 WIDTH="33%"
 283 ALIGN="right"
 284 VALIGN="top"
 285 >SDL_ConvertAudio</TD
 286 ></TR
 287 ></TABLE
 288 ></DIV
 289 ></BODY
 290 ></HTML
 291 >