From 6a644b48f01fafe3edb626267a4ec1bcb2c19000 Mon Sep 17 00:00:00 2001 From: goto40 Date: Sat, 8 Feb 2025 11:22:34 +0100 Subject: [PATCH] doc: audio stream processor, number of channels (#4753) * doc: audio stream processor * fixed accidental encoding effect --- parser/output/raylib_api.json | 6 +++--- parser/output/raylib_api.lua | 4 ++-- parser/output/raylib_api.txt | 4 ++-- parser/output/raylib_api.xml | 4 ++-- projects/Notepad++/raylib_npp_parser/raylib_npp.xml | 4 ++-- projects/Notepad++/raylib_npp_parser/raylib_to_parse.h | 4 ++-- src/raylib.h | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/parser/output/raylib_api.json b/parser/output/raylib_api.json index 9fd9bcef0..9acb14710 100644 --- a/parser/output/raylib_api.json +++ b/parser/output/raylib_api.json @@ -12119,7 +12119,7 @@ }, { "name": "AttachAudioStreamProcessor", - "description": "Attach audio stream processor to stream, receives the samples as 'float'", + "description": "Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)", "returnType": "void", "params": [ { @@ -12149,7 +12149,7 @@ }, { "name": "AttachAudioMixedProcessor", - "description": "Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'", + "description": "Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)", "returnType": "void", "params": [ { @@ -12170,4 +12170,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/parser/output/raylib_api.lua b/parser/output/raylib_api.lua index 59eb4b0fc..81dd7f932 100644 --- a/parser/output/raylib_api.lua +++ b/parser/output/raylib_api.lua @@ -8276,7 +8276,7 @@ return { }, { name = "AttachAudioStreamProcessor", - description = "Attach audio stream processor to stream, receives the samples as 'float'", + description = "Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)", returnType = "void", params = { {type = "AudioStream", name = "stream"}, @@ -8294,7 +8294,7 @@ return { }, { name = "AttachAudioMixedProcessor", - description = "Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'", + description = "Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)", returnType = "void", params = { {type = "AudioCallback", name = "processor"} diff --git a/parser/output/raylib_api.txt b/parser/output/raylib_api.txt index f0fb4eab4..c74a79a5f 100644 --- a/parser/output/raylib_api.txt +++ b/parser/output/raylib_api.txt @@ -4659,7 +4659,7 @@ Function 578: SetAudioStreamCallback() (2 input parameters) Function 579: AttachAudioStreamProcessor() (2 input parameters) Name: AttachAudioStreamProcessor Return type: void - Description: Attach audio stream processor to stream, receives the samples as 'float' + Description: Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo) Param[1]: stream (type: AudioStream) Param[2]: processor (type: AudioCallback) Function 580: DetachAudioStreamProcessor() (2 input parameters) @@ -4671,7 +4671,7 @@ Function 580: DetachAudioStreamProcessor() (2 input parameters) Function 581: AttachAudioMixedProcessor() (1 input parameters) Name: AttachAudioMixedProcessor Return type: void - Description: Attach audio stream processor to the entire audio pipeline, receives the samples as 'float' + Description: Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo) Param[1]: processor (type: AudioCallback) Function 582: DetachAudioMixedProcessor() (1 input parameters) Name: DetachAudioMixedProcessor diff --git a/parser/output/raylib_api.xml b/parser/output/raylib_api.xml index 21e9d30e6..b7af0c41a 100644 --- a/parser/output/raylib_api.xml +++ b/parser/output/raylib_api.xml @@ -3104,7 +3104,7 @@ - + @@ -3112,7 +3112,7 @@ - + diff --git a/projects/Notepad++/raylib_npp_parser/raylib_npp.xml b/projects/Notepad++/raylib_npp_parser/raylib_npp.xml index 3c642ad31..0fada9c4f 100644 --- a/projects/Notepad++/raylib_npp_parser/raylib_npp.xml +++ b/projects/Notepad++/raylib_npp_parser/raylib_npp.xml @@ -3634,7 +3634,7 @@ - + @@ -3647,7 +3647,7 @@ - + diff --git a/projects/Notepad++/raylib_npp_parser/raylib_to_parse.h b/projects/Notepad++/raylib_npp_parser/raylib_to_parse.h index 2ff4c9cb3..c6b34b777 100644 --- a/projects/Notepad++/raylib_npp_parser/raylib_to_parse.h +++ b/projects/Notepad++/raylib_npp_parser/raylib_to_parse.h @@ -734,9 +734,9 @@ RLAPI void SetAudioStreamPan(AudioStream stream, float pan); // Set pan RLAPI void SetAudioStreamBufferSizeDefault(int size); // Default size for new audio streams RLAPI void SetAudioStreamCallback(AudioStream stream, AudioCallback callback); // Audio thread callback to request new data -RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives the samples as 'float' +RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo) RLAPI void DetachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Detach audio stream processor from stream -RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives the samples as 'float' +RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo) RLAPI void DetachAudioMixedProcessor(AudioCallback processor); // Detach audio stream processor from the entire audio pipeline diff --git a/src/raylib.h b/src/raylib.h index b8428e7ac..791e16c00 100644 --- a/src/raylib.h +++ b/src/raylib.h @@ -1701,10 +1701,10 @@ RLAPI void SetAudioStreamPan(AudioStream stream, float pan); // Set pan RLAPI void SetAudioStreamBufferSizeDefault(int size); // Default size for new audio streams RLAPI void SetAudioStreamCallback(AudioStream stream, AudioCallback callback); // Audio thread callback to request new data -RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives the samples as 'float' +RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo) RLAPI void DetachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Detach audio stream processor from stream -RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives the samples as 'float' +RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo) RLAPI void DetachAudioMixedProcessor(AudioCallback processor); // Detach audio stream processor from the entire audio pipeline #if defined(__cplusplus)