Skip to content

Commit 6a644b4

Browse files
authored
doc: audio stream processor, number of channels (#4753)
* doc: audio stream processor * fixed accidental encoding effect
1 parent cceabf6 commit 6a644b4

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

parser/output/raylib_api.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -12119,7 +12119,7 @@
1211912119
},
1212012120
{
1212112121
"name": "AttachAudioStreamProcessor",
12122-
"description": "Attach audio stream processor to stream, receives the samples as 'float'",
12122+
"description": "Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)",
1212312123
"returnType": "void",
1212412124
"params": [
1212512125
{
@@ -12149,7 +12149,7 @@
1214912149
},
1215012150
{
1215112151
"name": "AttachAudioMixedProcessor",
12152-
"description": "Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'",
12152+
"description": "Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)",
1215312153
"returnType": "void",
1215412154
"params": [
1215512155
{
@@ -12170,4 +12170,4 @@
1217012170
]
1217112171
}
1217212172
]
12173-
}
12173+
}

parser/output/raylib_api.lua

+2-2
Original file line numberDiff line numberDiff line change
@@ -8276,7 +8276,7 @@ return {
82768276
},
82778277
{
82788278
name = "AttachAudioStreamProcessor",
8279-
description = "Attach audio stream processor to stream, receives the samples as 'float'",
8279+
description = "Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)",
82808280
returnType = "void",
82818281
params = {
82828282
{type = "AudioStream", name = "stream"},
@@ -8294,7 +8294,7 @@ return {
82948294
},
82958295
{
82968296
name = "AttachAudioMixedProcessor",
8297-
description = "Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'",
8297+
description = "Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)",
82988298
returnType = "void",
82998299
params = {
83008300
{type = "AudioCallback", name = "processor"}

parser/output/raylib_api.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -4659,7 +4659,7 @@ Function 578: SetAudioStreamCallback() (2 input parameters)
46594659
Function 579: AttachAudioStreamProcessor() (2 input parameters)
46604660
Name: AttachAudioStreamProcessor
46614661
Return type: void
4662-
Description: Attach audio stream processor to stream, receives the samples as 'float'
4662+
Description: Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)
46634663
Param[1]: stream (type: AudioStream)
46644664
Param[2]: processor (type: AudioCallback)
46654665
Function 580: DetachAudioStreamProcessor() (2 input parameters)
@@ -4671,7 +4671,7 @@ Function 580: DetachAudioStreamProcessor() (2 input parameters)
46714671
Function 581: AttachAudioMixedProcessor() (1 input parameters)
46724672
Name: AttachAudioMixedProcessor
46734673
Return type: void
4674-
Description: Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'
4674+
Description: Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)
46754675
Param[1]: processor (type: AudioCallback)
46764676
Function 582: DetachAudioMixedProcessor() (1 input parameters)
46774677
Name: DetachAudioMixedProcessor

parser/output/raylib_api.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3104,15 +3104,15 @@
31043104
<Param type="AudioStream" name="stream" desc="" />
31053105
<Param type="AudioCallback" name="callback" desc="" />
31063106
</Function>
3107-
<Function name="AttachAudioStreamProcessor" retType="void" paramCount="2" desc="Attach audio stream processor to stream, receives the samples as 'float'">
3107+
<Function name="AttachAudioStreamProcessor" retType="void" paramCount="2" desc="Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)">
31083108
<Param type="AudioStream" name="stream" desc="" />
31093109
<Param type="AudioCallback" name="processor" desc="" />
31103110
</Function>
31113111
<Function name="DetachAudioStreamProcessor" retType="void" paramCount="2" desc="Detach audio stream processor from stream">
31123112
<Param type="AudioStream" name="stream" desc="" />
31133113
<Param type="AudioCallback" name="processor" desc="" />
31143114
</Function>
3115-
<Function name="AttachAudioMixedProcessor" retType="void" paramCount="1" desc="Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'">
3115+
<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)">
31163116
<Param type="AudioCallback" name="processor" desc="" />
31173117
</Function>
31183118
<Function name="DetachAudioMixedProcessor" retType="void" paramCount="1" desc="Detach audio stream processor from the entire audio pipeline">

projects/Notepad++/raylib_npp_parser/raylib_npp.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3634,7 +3634,7 @@
36343634
</KeyWord>
36353635

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

36493649
<KeyWord name="AttachAudioMixedProcessor" func="yes">
3650-
<Overload retVal="void" descr="Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'">
3650+
<Overload retVal="void" descr="Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)">
36513651
<Param name="AudioCallback processor" />
36523652
</Overload>
36533653
</KeyWord>

projects/Notepad++/raylib_npp_parser/raylib_to_parse.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -734,9 +734,9 @@ RLAPI void SetAudioStreamPan(AudioStream stream, float pan); // Set pan
734734
RLAPI void SetAudioStreamBufferSizeDefault(int size); // Default size for new audio streams
735735
RLAPI void SetAudioStreamCallback(AudioStream stream, AudioCallback callback); // Audio thread callback to request new data
736736

737-
RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives the samples as 'float'
737+
RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)
738738
RLAPI void DetachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Detach audio stream processor from stream
739739

740-
RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'
740+
RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)
741741
RLAPI void DetachAudioMixedProcessor(AudioCallback processor); // Detach audio stream processor from the entire audio pipeline
742742

src/raylib.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -1701,10 +1701,10 @@ RLAPI void SetAudioStreamPan(AudioStream stream, float pan); // Set pan
17011701
RLAPI void SetAudioStreamBufferSizeDefault(int size); // Default size for new audio streams
17021702
RLAPI void SetAudioStreamCallback(AudioStream stream, AudioCallback callback); // Audio thread callback to request new data
17031703

1704-
RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives the samples as 'float'
1704+
RLAPI void AttachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Attach audio stream processor to stream, receives frames x 2 samples as 'float' (stereo)
17051705
RLAPI void DetachAudioStreamProcessor(AudioStream stream, AudioCallback processor); // Detach audio stream processor from stream
17061706

1707-
RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives the samples as 'float'
1707+
RLAPI void AttachAudioMixedProcessor(AudioCallback processor); // Attach audio stream processor to the entire audio pipeline, receives frames x 2 samples as 'float' (stereo)
17081708
RLAPI void DetachAudioMixedProcessor(AudioCallback processor); // Detach audio stream processor from the entire audio pipeline
17091709

17101710
#if defined(__cplusplus)

0 commit comments

Comments
 (0)