godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-31 18:41:20 +00:00
Code Releases Wiki Activity

Merge pull request #113288 from goatchurchprime/gtch/audioservermic

Browse Source 
AudioServer to have function to access microphone buffer directly
This commit is contained in:
Thaddeus Crews
2025-12-03 16:50:32 -06:00
parent db077a4fec 3e8bf3ba91
commit 5a7e1bf0f4
7 changed files with 136 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/classes/AudioServer.xml
View File

@@ -124,6 +124,12 @@
Returns the name of the current audio driver. The default usually depends on the operating system, but may be overridden via the [code]--audio-driver[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url]. [code]--headless[/code] also automatically sets the audio driver to [code]Dummy[/code]. See also [member ProjectSettings.audio/driver/driver].
</description>
</method>
<method name="get_input_buffer_length_frames" experimental="">
<return type="int" />
<description>
Returns the absolute size of the microphone input buffer. This is set to a multiple of the audio latency and can be used to estimate the minimum rate at which the frames need to be fetched.
</description>
</method>
<method name="get_input_device_list">
<return type="PackedStringArray" />
<description>
@@ -131,6 +137,21 @@
[b]Note:[/b] [member ProjectSettings.audio/driver/enable_input] must be [code]true[/code] for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.
</description>
</method>
<method name="get_input_frames" experimental="">
<return type="PackedVector2Array" />
<param index="0" name="frames" type="int" />
<description>
Returns a [PackedVector2Array] containing exactly [param frames] audio samples from the internal microphone buffer if available, otherwise returns an empty [PackedVector2Array].
The buffer is filled at the rate of [method get_input_mix_rate] frames per second when [method set_input_device_active] has successfully been set to [code]true[/code].
The samples are signed floating-point PCM values between [code]-1[/code] and [code]1[/code].
</description>
</method>
<method name="get_input_frames_available" experimental="">
<return type="int" />
<description>
Returns the number of frames available to read using [method get_input_frames].
</description>
</method>
<method name="get_input_mix_rate" qualifiers="const">
<return type="float" />
<description>
@@ -330,6 +351,14 @@
[b]Note:[/b] This is enabled by default in the editor, as it is used by editor plugins for the audio stream previews.
</description>
</method>
<method name="set_input_device_active" experimental="">
<return type="int" enum="Error" />
<param index="0" name="active" type="bool" />
<description>
If [param active] is [code]true[/code], starts the microphone input stream specified by [member input_device] or returns an error if it failed.
If [param active] is [code]false[/code], stops the input stream if it is running.
</description>
</method>
<method name="swap_bus_effects">
<return type="void" />
<param index="0" name="bus_idx" type="int" />