add audio capture functions

Author: ntsh-oni

source/scripting/api/index.rst

@@ -378,6 +378,10 @@ Functions related to audio.
 	  - Sets the master gain.
 	* - :doc:`/types/Script/getMasterGain/index`
 	  - Returns the master gain.
+	* - :doc:`/types/Script/startAudioInputCapture/index`
+	  - Starts audio input capture.
+	* - :doc:`/types/Script/stopAudioInputCapture/index`
+	  - Ends audio input capture.
 
 Animation
 ---------

source/types/AudioModuleInterface/index.rst

@@ -54,6 +54,10 @@ Functions
 	  - Sets the master gain.
 	* - :doc:`/types/AudioModuleInterface/getMasterGain/index`
 	  - Returns the master gain.
+	* - :doc:`/types/AudioModuleInterface/startAudioInputCapture/index`
+	  - Starts audio input capture.
+	* - :doc:`/types/AudioModuleInterface/stopAudioInputCapture/index`
+	  - Ends audio input capture.
 
 .. toctree::
 	:hidden:
@@ -77,4 +81,6 @@ Functions
 	./setSoundSourceLooping/index.rst
 	./isSoundSourceLooping/index.rst
 	./setMasterGain/index.rst
-	./getMasterGain/index.rst
+	./getMasterGain/index.rst
+	./startAudioInputCapture/index.rst
+	./stopAudioInputCapture/index.rst

source/types/AudioModuleInterface/startAudioInputCapture/index.rst

@@ -0,0 +1,28 @@
+startAudioInputCapture
+======================
+
+:doc:`/types/AudioModuleInterface/index`::startAudioInputCapture
+
+Starts audio input capture.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	virtual void startAudioInputCapture() = 0;
+
+Parameters
+----------
+
+None.
+
+Returns
+-------
+
+None.
+
+Notes
+-----
+
+End the audio input capture with :doc:`/scripting/api/index`'s function :doc:`/types/Script/stopAudioInputCapture/index` or the :doc:`/module/audio_module/index`'s :doc:`/types/AudioModuleInterface/stopAudioInputCapture/index` function.

source/types/AudioModuleInterface/stopAudioInputCapture/index.rst

@@ -0,0 +1,28 @@
+stopAudioInputCapture
+=====================
+
+:doc:`/types/AudioModuleInterface/index`::stopAudioInputCapture
+
+Ends audio input capture.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	virtual SoundID stopAudioInputCapture() = 0;
+
+Parameters
+----------
+
+None.
+
+Returns
+-------
+
+The :doc:`/types/SoundID` of the captured sound.
+
+Notes
+-----
+
+End the audio input capture started with :doc:`/scripting/api/index`'s function :doc:`/types/Script/startAudioInputCapture/index` or the :doc:`/module/audio_module/index`'s :doc:`/types/AudioModuleInterface/startAudioInputCapture/index` function.

source/types/Script/index.rst

@@ -324,6 +324,10 @@ Functions
 	  - Sets the master gain.
 	* - :doc:`/types/Script/getMasterGain/index`
 	  - Returns the master gain.
+	* - :doc:`/types/Script/startAudioInputCapture/index`
+	  - Starts audio input capture.
+	* - :doc:`/types/Script/stopAudioInputCapture/index`
+	  - Ends audio input capture.
 	* - :doc:`/types/Script/playAnimation/index`
 	  - Plays an :doc:`/types/Animation/index` on an :doc:`/entity_component_system/entity/index`.
 	* - :doc:`/types/Script/resumeAnimation/index`
@@ -535,6 +539,8 @@ Functions
 	./isSoundSourceLooping/index.rst
 	./setMasterGain/index.rst
 	./getMasterGain/index.rst
+	./startAudioInputCapture/index.rst
+	./stopAudioInputCapture/index.rst
 
 	./intersect/index.rst
 	./raycast/index.rst

source/types/Script/startAudioInputCapture/index.rst

@@ -0,0 +1,28 @@
+startAudioInputCapture
+======================
+
+:doc:`/types/Script/index`::startAudioInputCapture
+
+Starts audio input capture.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	void startAudioInputCapture();
+
+Parameters
+----------
+
+None.
+
+Returns
+-------
+
+None.
+
+Notes
+-----
+
+End the audio input capture with :doc:`/scripting/api/index`'s function :doc:`/types/Script/stopAudioInputCapture/index` or the :doc:`/module/audio_module/index`'s :doc:`/types/AudioModuleInterface/stopAudioInputCapture/index` function.

source/types/Script/stopAudioInputCapture/index.rst

@@ -0,0 +1,28 @@
+stopAudioInputCapture
+=====================
+
+:doc:`/types/Script/index`::stopAudioInputCapture
+
+Ends audio input capture.
+
+Declaration
+-----------
+
+.. code-block:: cpp
+
+	SoundID stopAudioInputCapture();
+
+Parameters
+----------
+
+None.
+
+Returns
+-------
+
+The :doc:`/types/SoundID` of the captured sound.
+
+Notes
+-----
+
+End the audio input capture started with :doc:`/scripting/api/index`'s function :doc:`/types/Script/startAudioInputCapture/index` or the :doc:`/module/audio_module/index`'s :doc:`/types/AudioModuleInterface/startAudioInputCapture/index` function.