diff options
Diffstat (limited to 'doc/classes/AudioServer.xml')
| -rw-r--r-- | doc/classes/AudioServer.xml | 60 |
1 files changed, 22 insertions, 38 deletions
diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 6dc1600cf2..7581ae6935 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioServer" inherits="Object" category="Core" version="3.2"> <brief_description> - Server interface for low level audio access. + Server interface for low-level audio access. </brief_description> <description> - AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. + AudioServer is a low-level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> @@ -68,13 +68,6 @@ Returns the amount of channels of the bus at index [code]bus_idx[/code]. </description> </method> - <method name="get_bus_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of available buses. - </description> - </method> <method name="get_bus_effect"> <return type="AudioEffect"> </return> @@ -165,29 +158,25 @@ Returns the volume of the bus at index [code]bus_idx[/code] in dB. </description> </method> - <method name="get_device"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="get_device_list"> <return type="Array"> </return> <description> + Returns the names of all audio devices detected on the system. </description> </method> <method name="get_mix_rate" qualifiers="const"> <return type="float"> </return> <description> - Returns the sample rate at the output of the audioserver. + Returns the sample rate at the output of the [AudioServer]. </description> </method> <method name="get_output_latency" qualifiers="const"> <return type="float"> </return> <description> + Returns the audio driver's output latency. </description> </method> <method name="get_speaker_mode" qualifiers="const"> @@ -251,7 +240,7 @@ <return type="void"> </return> <description> - Locks the audio drivers mainloop. Remember to unlock it afterwards. + Locks the audio driver's main loop. Remember to unlock it afterwards. </description> </method> <method name="move_bus"> @@ -296,15 +285,6 @@ If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. </description> </method> - <method name="set_bus_count"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Adds and removes buses to make the number of buses match [code]amount[/code]. - </description> - </method> <method name="set_bus_effect_enabled"> <return type="void"> </return> @@ -382,14 +362,6 @@ Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. </description> </method> - <method name="set_device"> - <return type="void"> - </return> - <argument index="0" name="device" type="String"> - </argument> - <description> - </description> - </method> <method name="swap_bus_effects"> <return type="void"> </return> @@ -407,10 +379,21 @@ <return type="void"> </return> <description> - Unlocks the audiodriver's main loop. After locking it always unlock it. + Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) </description> </method> </methods> + <members> + <member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count" default="1"> + Number of available audio buses. + </member> + <member name="device" type="String" setter="set_device" getter="get_device" default=""Default""> + Name of the current device (see [method get_device_list]). + </member> + <member name="global_rate_scale" type="float" setter="set_global_rate_scale" getter="get_global_rate_scale" default="1.0"> + Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast). + </member> + </members> <signals> <signal name="bus_layout_changed"> <description> @@ -420,15 +403,16 @@ </signals> <constants> <constant name="SPEAKER_MODE_STEREO" value="0" enum="SpeakerMode"> - Two or fewer speakers are detected. + Two or fewer speakers were detected. </constant> <constant name="SPEAKER_SURROUND_31" value="1" enum="SpeakerMode"> + A 3.1 channel surround setup was detected. </constant> <constant name="SPEAKER_SURROUND_51" value="2" enum="SpeakerMode"> - A 5.1 channel surround setup detected. + A 5.1 channel surround setup was detected. </constant> <constant name="SPEAKER_SURROUND_71" value="3" enum="SpeakerMode"> - A 7.1 channel surround setup detected. + A 7.1 channel surround setup was detected. </constant> </constants> </class> |