Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_BuildAudioCVT.3 @ 4159:a1b03ba2fcd0 SDL-1.2
Updated copyright date
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Mon, 08 Dec 2008 00:25:42 +0000 |
parents | 4e3b250c950e |
children | 1238da4a7112 |
rev | line source |
---|---|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_BuildAudioCVT" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" |
0 | 2 .SH "NAME" |
4107
4e3b250c950e
Erik Heckers fixed bug #493
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
3 SDL_BuildAudioCVT \- Initializes a SDL_AudioCVT structure for conversion |
0 | 4 .SH "SYNOPSIS" |
5 .PP | |
6 \fB#include "SDL\&.h" | |
7 .sp | |
8 \fBint \fBSDL_BuildAudioCVT\fP\fR(\fBSDL_AudioCVT *cvt, Uint16 src_format, Uint8 src_channels, int src_rate, Uint16 dst_format, Uint8 dst_channels, int dst_rate\fR); | |
9 .SH "DESCRIPTION" | |
10 .PP | |
11 Before an \fI\fBSDL_AudioCVT\fR\fR structure can be used to convert audio data it must be initialized with source and destination information\&. | |
12 .PP | |
13 \fBsrc_format\fR and \fBdst_format\fR are the source and destination format of the conversion\&. (For information on audio formats see \fI\fB SDL_AudioSpec\fR\fR)\&. \fBsrc_channels\fR and \fBdst_channels\fR are the number of channels in the source and destination formats\&. Finally, \fBsrc_rate\fR and \fBdst_rate\fR are the frequency or samples-per-second of the source and destination formats\&. Once again, see \fI\fBSDL_AudioSpec\fR\fR\&. | |
14 .SH "RETURN VALUES" | |
15 .PP | |
16 Returns \fB-1\fR if the filter could not be built or 1 if it could\&. | |
17 .SH "EXAMPLES" | |
18 .PP | |
19 See \fI\fBSDL_ConvertAudio\fP\fR\&. | |
20 .SH "SEE ALSO" | |
21 .PP | |
22 \fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioCVT\fP\fR | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
23 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 |