|
⇤ ← Revision 1 as of 2009-11-12 22:38:15
Size: 1103
Comment: create page, add content
|
Size: 1286
Comment: edit content
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Use this function to get the human-readable name of a specific audio device. | Use this function to get the name of a specific audio device. |
| Line 16: | Line 16: |
| ||'''index'''||the index of the audio device; the value ranges from 0 to 1 - [[SDL_GetNumAudioDevices]]()|| ||'''iscapture'''||non-0 to specify a device that has recording capability|| |
|
| Line 18: | Line 20: |
The string returned by this function is UTF-8 encoded, read-only, and managed internally. You are not to free it. If you need to keep the string for any length of time, you should make your own copy of it, as it will be invalid next time any of several other SDL functions is called. |
The name of the audio device at the requested index. |
| Line 27: | Line 28: |
| Must be a value between 0 and (number of audio devices-1). Only valid after successfully initializing the audio subsystem. The values returned by this function reflect the latest call to [[SDL_GetNumAudioDevices]](); recall that function to redetect available hardware. |
This function is only valid after successfully initializing the audio subsystem. The values returned by this function reflect the latest call to [[SDL_GetNumAudioDevices]](); re-call that function to re-detect available hardware. |
| Line 31: | Line 31: |
| The string returned by this function is UTF-8 encoded, read-only, and managed internally. You are not to free it. If you need to keep the string for any length of time, you should make your own copy of it, as it will be invalid next time any of several other SDL functions is called. |
SDL_GetAudioDeviceName
Use this function to get the name of a specific audio device.
Contents
Syntax
const char * SDL_GetAudioDeviceName (int index,
int iscapture)
Function Parameters
index |
the index of the audio device; the value ranges from 0 to 1 - SDL_GetNumAudioDevices() |
iscapture |
non-0 to specify a device that has recording capability |
Return Value
The name of the audio device at the requested index.
Code Examples
You can add your code example here
Remarks
This function is only valid after successfully initializing the audio subsystem. The values returned by this function reflect the latest call to SDL_GetNumAudioDevices(); re-call that function to re-detect available hardware.
The string returned by this function is UTF-8 encoded, read-only, and managed internally. You are not to free it. If you need to keep the string for any length of time, you should make your own copy of it, as it will be invalid next time any of several other SDL functions is called.
