Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: audio stream processor, number of channels #4753

Merged
merged 2 commits into from
Feb 8, 2025
Merged

doc: audio stream processor, number of channels #4753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77cb188
doc: audio stream processor
goto40 Feb 6, 2025
83e075e
fixed accidental encoding effect
goto40 Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions parser/output/raylib_api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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": [
{
Expand All @@ -12170,4 +12170,4 @@
]
}
]
}
}
4 changes: 2 additions & 2 deletions parser/output/raylib_api.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
Expand All @@ -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"}
Expand Down
4 changes: 2 additions & 2 deletions parser/output/raylib_api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions parser/output/raylib_api.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3104,15 +3104,15 @@
<Param type="AudioStream" name="stream" desc="" />
<Param type="AudioCallback" name="callback" desc="" />
</Function>
<Function name="AttachAudioStreamProcessor" retType="void" paramCount="2" desc="Attach audio stream processor to stream, receives the samples as 'float'">
<Function name="AttachAudioStreamProcessor" retType="void" paramCount="2" desc="Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)">
<Param type="AudioStream" name="stream" desc="" />
<Param type="AudioCallback" name="processor" desc="" />
</Function>
<Function name="DetachAudioStreamProcessor" retType="void" paramCount="2" desc="Detach audio stream processor from stream">
<Param type="AudioStream" name="stream" desc="" />
<Param type="AudioCallback" name="processor" desc="" />
</Function>
<Function name="AttachAudioMixedProcessor" retType="void" paramCount="1" desc="Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'">
<Function name="AttachAudioMixedProcessor" retType="void" paramCount="1" desc="Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)">
<Param type="AudioCallback" name="processor" desc="" />
</Function>
<Function name="DetachAudioMixedProcessor" retType="void" paramCount="1" desc="Detach audio stream processor from the entire audio pipeline">
Expand Down
4 changes: 2 additions & 2 deletions projects/Notepad++/raylib_npp_parser/raylib_npp.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3634,7 +3634,7 @@
</KeyWord>

<KeyWord name="AttachAudioStreamProcessor" func="yes">
<Overload retVal="void" descr="Attach audio stream processor to stream, receives the samples as 'float'">
<Overload retVal="void" descr="Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)">
<Param name="AudioStream stream" />
<Param name="AudioCallback processor" />
</Overload>
Expand All @@ -3647,7 +3647,7 @@
</KeyWord>

<KeyWord name="AttachAudioMixedProcessor" func="yes">
<Overload retVal="void" descr="Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'">
<Overload retVal="void" descr="Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)">
<Param name="AudioCallback processor" />
</Overload>
</KeyWord>
Expand Down
4 changes: 2 additions & 2 deletions projects/Notepad++/raylib_npp_parser/raylib_to_parse.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

4 changes: 2 additions & 2 deletions src/raylib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down