mirror/miniaudio
1
0
Fork 0
mirror of https://github.com/mackron/miniaudio.git synced 2026-04-23 08:44:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #413 from Clownacy/dev

Browse Source 
Update some outdated parts of the documentation
This commit is contained in:
David Reid
2022-01-20 17:18:07 +10:00
committed by GitHub
parent 252de0f0ad 56e41a0fde
commit ba2f46b6f1
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+6 -5
View File
@@ -2681,7 +2681,7 @@ initializing a simple channel converter which converts from mono to stereo.
NULL, // Output channel map NULL, // Output channel map
ma_channel_mix_mode_default); // The mixing algorithm to use when combining channels. ma_channel_mix_mode_default); // The mixing algorithm to use when combining channels.
result = ma_channel_converter_init(&config, &converter); result = ma_channel_converter_init(&config, NULL, &converter);
if (result != MA_SUCCESS) { if (result != MA_SUCCESS) {
// Error. // Error.
} }
@@ -2978,7 +2978,7 @@ object like this:
); );
ma_data_converter converter; ma_data_converter converter;
ma_result result = ma_data_converter_init(&config, &converter); ma_result result = ma_data_converter_init(&config, NULL, &converter);
if (result != MA_SUCCESS) { if (result != MA_SUCCESS) {
// An error occurred... // An error occurred...
} }
@@ -3003,7 +3003,7 @@ Something like the following may be more suitable depending on your requirements
Do the following to uninitialize the data converter: Do the following to uninitialize the data converter:
```c ```c
ma_data_converter_uninit(&converter); ma_data_converter_uninit(&converter, NULL);
``` ```
The following example shows how data can be processed The following example shows how data can be processed
@@ -3611,8 +3611,9 @@ Some backends have some nuance details you may want to be aware of.
WASAPI and Core Audio, however other backends such as PulseAudio may naturally support it, though WASAPI and Core Audio, however other backends such as PulseAudio may naturally support it, though
not all have been tested. not all have been tested.
- The contents of the output buffer passed into the data callback will always be pre-initialized to - The contents of the output buffer passed into the data callback will always be pre-initialized to
silence unless the `noPreZeroedOutputBuffer` config variable in `ma_device_config` is set to true, silence unless the `noPreSilencedOutputBuffer` config variable in `ma_device_config` is set to
in which case it'll be undefined which will require you to write something to the entire buffer. true, in which case it'll be undefined which will require you to write something to the entire
buffer.
- By default miniaudio will automatically clip samples. This only applies when the playback sample - By default miniaudio will automatically clip samples. This only applies when the playback sample
format is configured as `ma_format_f32`. If you are doing clipping yourself, you can disable this format is configured as `ma_format_f32`. If you are doing clipping yourself, you can disable this
overhead by setting `noClip` to true in the device config. overhead by setting `noClip` to true in the device config.