|
Size: 2473
Comment: update content
|
Size: 3038
Comment: update content for consistency
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 47: | Line 47: |
| ^If audio format conversion is not supported this function returns -1.^ <<Color2(green,Is there a 'you can call' function to get more information in this case like there was for SetTextureScaleMode SetTextureColorMod SetTextureBlendMode SetTextureAlphaMod etc?)>> | ^If audio format conversion is not supported this function returns -1.^ <<Color2(green,Is there a 'you can call' function to "automatically" get more information in this case like there was for [[SDL_SetTextureScaleMode]] [[SDL_SetTextureColorMod]] [[SDL_SetTextureBlendMode]] [[SDL_SetTextureAlphaMod]] etc? I thought it would be [[SDL_ConvertAudio]]() but that seems to ''use'' the struct not set it up. If this is the only other RF then does the programmer need to determine whether conversion is possible and manually set that as a fixed data value when the struct is first set up?)>> ^You can call [[some function]]() to fill in an [[SDL_AudioCVT]] structure with the remaining information about the current audio converter. This structure will have the `needed` member/mask set to 1 if conversion is possible.^ |
DRAFT |
SDL_BuildAudioCVT
Use this function to initialize an SDL_AudioCVT structure for conversion.
Contents
Syntax
int SDL_BuildAudioCVT(SDL_AudioCVT* cvt,
SDL_AudioFormat src_format,
Uint8 src_channels,
int src_rate,
SDL_AudioFormat dst_format,
Uint8 dst_channels,
int dst_rate)
Function Parameters
cvt |
a pointer to an SDL_AudioCVT structure that is filled in with audio conversion information |
src_format |
the source format of the audio data; for more info see SDL_AudioFormat |
src_channels |
the number of channels in the source |
src_rate |
the frequency or samples-per-second of the source |
dst_format |
the destination format of the audio data; for more info see SDL_AudioFormat |
dst_channels |
the number of channels in the destination |
dst_rate |
the frequency or samples-per-second of the destination |
green
Return Value
Returns 1 if the audio filter is set up, 0 if there's no conversion needed, or a negative error code on failure -1 if the format conversion is not supported; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
Before an SDL_AudioCVT structure can be used to convert audio data it must be initialized with source and destination information.
For information on audio formats see SDL_AudioSpec.
*
Currently only rate conversions of 2x and (1/2)x with x > 0 are done, nearing whichever most closely approximates the requested rate conversion.
*
If audio format conversion is not supported this function returns -1.
green
You can call [[some function]]() to fill in an [[SDL_AudioCVT]] structure with the remaining information about the current audio converter. This structure will have the `needed` member/mask set to 1 if conversion is possible.
