From 1395b5e7cfad3e84a44a0cf4cfbbcf4eab723ec8 Mon Sep 17 00:00:00 2001 From: David Reid Date: Sat, 22 Jan 2022 12:11:13 +1000 Subject: [PATCH] Update documentation. --- docs/examples/custom_decoder.html | 4 +++- docs/manual/index.html | 11 ++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/examples/custom_decoder.html b/docs/examples/custom_decoder.html index 906b06a0..f314acc9 100644 --- a/docs/examples/custom_decoder.html +++ b/docs/examples/custom_decoder.html @@ -444,7 +444,7 @@ The onInitFile, return; } - ma_data_source_read_pcm_frames(pDataSource, pOutput, frameCount, NULL, MA_TRUE); + ma_data_source_read_pcm_frames(pDataSource, pOutput, frameCount, NULL); (void)pInput; } @@ -489,6 +489,8 @@ The onInitFile, return -1; } + ma_data_source_set_looping(&decoder, MA_TRUE); + /* Initialize the device. */ result = ma_data_source_get_data_format(&decoder, &format, &channels, &sampleRate, NULL, 0); diff --git a/docs/manual/index.html b/docs/manual/index.html index a68551b0..7d11d4b4 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -4383,7 +4383,7 @@ initializing a simple channel converter which converts from mono to stereo. NULL, // Output channel map 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) { // Error. } @@ -4973,7 +4973,7 @@ object like this: ); 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) { // An error occurred... } @@ -5004,7 +5004,7 @@ Do the following to uninitialize the data converter: 

-ma_data_converter_uninit(&converter);
+ma_data_converter_uninit(&converter, NULL);

The following example shows how data can be processed @@ -6147,8 +6147,9 @@ Automatic stream routing is enabled on a per-backend basis. Support is explicitl not all have been tested.

  • 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, - in which case it'll be undefined which will require you to write something to the entire buffer.
    • + silence unless the noPreSilencedOutputBuffer config variable in ma_device_config is set to + 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 format is configured as ma_format_f32. If you are doing clipping yourself, you can disable this