godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-04 10:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
9b1e91529099ea2a779922e835c27a619daef6d7
godot-docs-l10n/classes/zh_CN/class_audioserver.rst

933 lines
50 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.4/doc/classes/AudioServer.xml.
.. _class_AudioServer:
AudioServer
===========
**继承：** :ref:`Object<class_Object>`
低级音频访问的服务器接口。
.. rst-class:: classref-introduction-group
描述
----
**AudioServer** 是用于音频访问的底层服务器接口。它负责创建样本数据（可播放的音频）以及通过语音接口进行播放。
.. rst-class:: classref-introduction-group
教程
----
- :doc:`音频总线 <../tutorials/audio/audio_buses>`
- `音频设备切换演示 <https://godotengine.org/asset-library/asset/2758>`__
- `音频麦克风录音演示 <https://godotengine.org/asset-library/asset/2760>`__
- `音频频谱可视化演示 <https://godotengine.org/asset-library/asset/2762>`__
.. rst-class:: classref-reftable-group
属性
----
.. table::
:widths: auto
+-----------------------------+------------------------------------------------------------------------------+---------------+
| :ref:`int<class_int>` | :ref:`bus_count<class_AudioServer_property_bus_count>` | ``1`` |
+-----------------------------+------------------------------------------------------------------------------+---------------+
| :ref:`String<class_String>` | :ref:`input_device<class_AudioServer_property_input_device>` | ``"Default"`` |
+-----------------------------+------------------------------------------------------------------------------+---------------+
| :ref:`String<class_String>` | :ref:`output_device<class_AudioServer_property_output_device>` | ``"Default"`` |
+-----------------------------+------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`playback_speed_scale<class_AudioServer_property_playback_speed_scale>` | ``1.0`` |
+-----------------------------+------------------------------------------------------------------------------+---------------+
.. rst-class:: classref-reftable-group
方法
----
.. table::
:widths: auto
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_bus<class_AudioServer_method_add_bus>`\ (\ at_position\: :ref:`int<class_int>` = -1\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_bus_effect<class_AudioServer_method_add_bus_effect>`\ (\ bus_idx\: :ref:`int<class_int>`, effect\: :ref:`AudioEffect<class_AudioEffect>`, at_position\: :ref:`int<class_int>` = -1\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioBusLayout<class_AudioBusLayout>` | :ref:`generate_bus_layout<class_AudioServer_method_generate_bus_layout>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_channels<class_AudioServer_method_get_bus_channels>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioEffect<class_AudioEffect>` | :ref:`get_bus_effect<class_AudioServer_method_get_bus_effect>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_method_get_bus_effect_count>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioEffectInstance<class_AudioEffectInstance>` | :ref:`get_bus_effect_instance<class_AudioServer_method_get_bus_effect_instance>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, channel\: :ref:`int<class_int>` = 0\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_method_get_bus_index>`\ (\ bus_name\: :ref:`StringName<class_StringName>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_bus_name<class_AudioServer_method_get_bus_name>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_method_get_bus_peak_volume_left_db>`\ (\ bus_idx\: :ref:`int<class_int>`, channel\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_method_get_bus_peak_volume_right_db>`\ (\ bus_idx\: :ref:`int<class_int>`, channel\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_bus_send<class_AudioServer_method_get_bus_send>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_method_get_bus_volume_db>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bus_volume_linear<class_AudioServer_method_get_bus_volume_linear>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_driver_name<class_AudioServer_method_get_driver_name>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_input_device_list<class_AudioServer_method_get_input_device_list>`\ (\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_input_mix_rate<class_AudioServer_method_get_input_mix_rate>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_method_get_mix_rate>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_output_device_list<class_AudioServer_method_get_output_device_list>`\ (\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_output_latency<class_AudioServer_method_get_output_latency>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` | :ref:`get_speaker_mode<class_AudioServer_method_get_speaker_mode>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_since_last_mix<class_AudioServer_method_get_time_since_last_mix>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_to_next_mix<class_AudioServer_method_get_time_to_next_mix>`\ (\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_method_is_bus_bypassing_effects>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_method_is_bus_effect_enabled>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_method_is_bus_mute>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_method_is_bus_solo>`\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stream_registered_as_sample<class_AudioServer_method_is_stream_registered_as_sample>`\ (\ stream\: :ref:`AudioStream<class_AudioStream>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`lock<class_AudioServer_method_lock>`\ (\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`move_bus<class_AudioServer_method_move_bus>`\ (\ index\: :ref:`int<class_int>`, to_index\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`register_stream_as_sample<class_AudioServer_method_register_stream_as_sample>`\ (\ stream\: :ref:`AudioStream<class_AudioStream>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_bus<class_AudioServer_method_remove_bus>`\ (\ index\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_bus_effect<class_AudioServer_method_remove_bus_effect>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_bypass_effects<class_AudioServer_method_set_bus_bypass_effects>`\ (\ bus_idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_effect_enabled<class_AudioServer_method_set_bus_effect_enabled>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_layout<class_AudioServer_method_set_bus_layout>`\ (\ bus_layout\: :ref:`AudioBusLayout<class_AudioBusLayout>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_mute<class_AudioServer_method_set_bus_mute>`\ (\ bus_idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_name<class_AudioServer_method_set_bus_name>`\ (\ bus_idx\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_send<class_AudioServer_method_set_bus_send>`\ (\ bus_idx\: :ref:`int<class_int>`, send\: :ref:`StringName<class_StringName>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_solo<class_AudioServer_method_set_bus_solo>`\ (\ bus_idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_volume_db<class_AudioServer_method_set_bus_volume_db>`\ (\ bus_idx\: :ref:`int<class_int>`, volume_db\: :ref:`float<class_float>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_bus_volume_linear<class_AudioServer_method_set_bus_volume_linear>`\ (\ bus_idx\: :ref:`int<class_int>`, volume_linear\: :ref:`float<class_float>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_enable_tagging_used_audio_streams<class_AudioServer_method_set_enable_tagging_used_audio_streams>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`swap_bus_effects<class_AudioServer_method_swap_bus_effects>`\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, by_effect_idx\: :ref:`int<class_int>`\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`unlock<class_AudioServer_method_unlock>`\ (\ ) |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
信号
----
.. _class_AudioServer_signal_bus_layout_changed:
.. rst-class:: classref-signal
**bus_layout_changed**\ (\ ) :ref:`🔗<class_AudioServer_signal_bus_layout_changed>`
添加、修改、删除音频总线时发出。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_signal_bus_renamed:
.. rst-class:: classref-signal
**bus_renamed**\ (\ bus_index\: :ref:`int<class_int>`, old_name\: :ref:`StringName<class_StringName>`, new_name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AudioServer_signal_bus_renamed>`
当索引为 ``bus_index`` 的音频总线的名称从 ``old_name`` 更改为 ``new_name`` 时发出。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
枚举
----
.. _enum_AudioServer_SpeakerMode:
.. rst-class:: classref-enumeration
enum **SpeakerMode**: :ref:`🔗<enum_AudioServer_SpeakerMode>`
.. _class_AudioServer_constant_SPEAKER_MODE_STEREO:
.. rst-class:: classref-enumeration-constant
:ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **SPEAKER_MODE_STEREO** = ``0``
检测到两个或更少的扬声器。
.. _class_AudioServer_constant_SPEAKER_SURROUND_31:
.. rst-class:: classref-enumeration-constant
:ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **SPEAKER_SURROUND_31** = ``1``
检测到 3.1 声道环绕声设置。
.. _class_AudioServer_constant_SPEAKER_SURROUND_51:
.. rst-class:: classref-enumeration-constant
:ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **SPEAKER_SURROUND_51** = ``2``
检测到 5.1 声道环绕声设置。
.. _class_AudioServer_constant_SPEAKER_SURROUND_71:
.. rst-class:: classref-enumeration-constant
:ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **SPEAKER_SURROUND_71** = ``3``
检测到 7.1 声道环绕声设置。
.. rst-class:: classref-item-separator
----
.. _enum_AudioServer_PlaybackType:
.. rst-class:: classref-enumeration
enum **PlaybackType**: :ref:`🔗<enum_AudioServer_PlaybackType>`
.. _class_AudioServer_constant_PLAYBACK_TYPE_DEFAULT:
.. rst-class:: classref-enumeration-constant
:ref:`PlaybackType<enum_AudioServer_PlaybackType>` **PLAYBACK_TYPE_DEFAULT** = ``0``
**实验性：** 未来版本中可能会修改或移除该常量。
播放将被视为在 :ref:`ProjectSettings.audio/general/default_playback_type<class_ProjectSettings_property_audio/general/default_playback_type>` 处声明的类型。
.. _class_AudioServer_constant_PLAYBACK_TYPE_STREAM:
.. rst-class:: classref-enumeration-constant
:ref:`PlaybackType<enum_AudioServer_PlaybackType>` **PLAYBACK_TYPE_STREAM** = ``1``
**实验性：** 未来版本中可能会修改或移除该常量。
强制将播放视为流。
.. _class_AudioServer_constant_PLAYBACK_TYPE_SAMPLE:
.. rst-class:: classref-enumeration-constant
:ref:`PlaybackType<enum_AudioServer_PlaybackType>` **PLAYBACK_TYPE_SAMPLE** = ``2``
**实验性：** 未来版本中可能会修改或移除该常量。
强制将播放视为样本。这可以提供更低的延迟和更稳定的播放（音频噼啪声的风险更小），但代价是灵活性较低。
\ **注意：**\ 目前仅支持 Web 平台。
\ **注意：**\ 将播放视为样本时不支持 :ref:`AudioEffect<class_AudioEffect>`\ 。
.. _class_AudioServer_constant_PLAYBACK_TYPE_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`PlaybackType<enum_AudioServer_PlaybackType>` **PLAYBACK_TYPE_MAX** = ``3``
**实验性：** 未来版本中可能会修改或移除该常量。
代表 :ref:`PlaybackType<enum_AudioServer_PlaybackType>` 枚举的大小。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
属性说明
--------
.. _class_AudioServer_property_bus_count:
.. rst-class:: classref-property
:ref:`int<class_int>` **bus_count** = ``1`` :ref:`🔗<class_AudioServer_property_bus_count>`
.. rst-class:: classref-property-setget
- |void| **set_bus_count**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_bus_count**\ (\ )
可用音频总线的数量。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_property_input_device:
.. rst-class:: classref-property
:ref:`String<class_String>` **input_device** = ``"Default"`` :ref:`🔗<class_AudioServer_property_input_device>`
.. rst-class:: classref-property-setget
- |void| **set_input_device**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_input_device**\ (\ )
当前音频输入设备的名称（见 :ref:`get_input_device_list()<class_AudioServer_method_get_input_device_list>`\ ）。在具有多个音频输入（例如模拟、USB、HDMI 音频）的系统中，可用于选择音频输入设备。为 ``"Default"`` 时会从系统默认的音频输入录制音频。如果设置了无效的设备名称，该值会被恢复为 ``"Default"``\ 。
\ **注意：**\ :ref:`ProjectSettings.audio/driver/enable_input<class_ProjectSettings_property_audio/driver/enable_input>` 必须为 ``true`` 音频输入才能正常工作。另见该设置项的描述，了解权限和操作系统隐私设置相关的说明。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_property_output_device:
.. rst-class:: classref-property
:ref:`String<class_String>` **output_device** = ``"Default"`` :ref:`🔗<class_AudioServer_property_output_device>`
.. rst-class:: classref-property-setget
- |void| **set_output_device**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_output_device**\ (\ )
当前音频输出设备的名称（见 :ref:`get_output_device_list()<class_AudioServer_method_get_output_device_list>`\ ）。在具有多个音频输出（例如模拟、USB、HDMI 音频）的系统中，可用于选择音频输出设备。为 ``"Default"`` 时会从系统默认的音频输出播放音频。如果设置了无效的设备名称，该值会被恢复为 ``"Default"``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_property_playback_speed_scale:
.. rst-class:: classref-property
:ref:`float<class_float>` **playback_speed_scale** = ``1.0`` :ref:`🔗<class_AudioServer_property_playback_speed_scale>`
.. rst-class:: classref-property-setget
- |void| **set_playback_speed_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_playback_speed_scale**\ (\ )
音频播放的缩放速率（即将其设置为 ``0.5`` 将使音频以其一半的速度播放）。另见 :ref:`Engine.time_scale<class_Engine_property_time_scale>` 影响一般模拟速度，它独立于 :ref:`playback_speed_scale<class_AudioServer_property_playback_speed_scale>`\ 。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
方法说明
--------
.. _class_AudioServer_method_add_bus:
.. rst-class:: classref-method
|void| **add_bus**\ (\ at_position\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_AudioServer_method_add_bus>`
在 ``at_position`` 处添加一条总线。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_add_bus_effect:
.. rst-class:: classref-method
|void| **add_bus_effect**\ (\ bus_idx\: :ref:`int<class_int>`, effect\: :ref:`AudioEffect<class_AudioEffect>`, at_position\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_AudioServer_method_add_bus_effect>`
为在 ``at_position`` 处索引为 ``bus_idx`` 的总线添加 :ref:`AudioEffect<class_AudioEffect>` 效果。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_generate_bus_layout:
.. rst-class:: classref-method
:ref:`AudioBusLayout<class_AudioBusLayout>` **generate_bus_layout**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_generate_bus_layout>`
使用可用的总线和效果来生成 :ref:`AudioBusLayout<class_AudioBusLayout>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_channels:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_bus_channels**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_channels>`
返回索引为 ``bus_idx`` 的总线的通道数。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_effect:
.. rst-class:: classref-method
:ref:`AudioEffect<class_AudioEffect>` **get_bus_effect**\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_get_bus_effect>`
返回索引为 ``bus_idx`` 的总线中位于 ``effect_idx`` 的 :ref:`AudioEffect<class_AudioEffect>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_effect_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_bus_effect_count**\ (\ bus_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_get_bus_effect_count>`
返回索引为 ``bus_idx`` 的总线上的效果数。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_effect_instance:
.. rst-class:: classref-method
:ref:`AudioEffectInstance<class_AudioEffectInstance>` **get_bus_effect_instance**\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, channel\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_AudioServer_method_get_bus_effect_instance>`
返回分配给给定总线和效果索引（以及可选的通道）的\ :ref:`AudioEffectInstance<class_AudioEffectInstance>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_index:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_bus_index**\ (\ bus_name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_index>`
返回名称为 ``bus_name`` 的总线的索引。如果不存在指定名称的总线，则返回 ``-1``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_bus_name**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_name>`
返回索引为 ``bus_idx`` 的总线的名称。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_peak_volume_left_db:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_bus_peak_volume_left_db**\ (\ bus_idx\: :ref:`int<class_int>`, channel\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_peak_volume_left_db>`
返回总线索引为 ``bus_idx`` 且通道索引为 ``channel`` 处的左扬声器的峰值音量。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_peak_volume_right_db:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_bus_peak_volume_right_db**\ (\ bus_idx\: :ref:`int<class_int>`, channel\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_peak_volume_right_db>`
返回总线索引为 ``bus_idx`` 且通道索引为 ``channel`` 处的右扬声器的峰值音量。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_send:
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_bus_send**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_send>`
返回索引为 ``bus_idx`` 的总线的发送目标总线的名称。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_volume_db:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_bus_volume_db**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_volume_db>`
返回索引为 ``bus_idx`` 的总线的音量，单位为 dB。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_bus_volume_linear:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_bus_volume_linear**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_get_bus_volume_linear>`
返回索引为 ``bus_idx`` 处的总线音量对应的线性值。
\ **注意：**\ 返回的值等价于使用 :ref:`get_bus_volume_db()<class_AudioServer_method_get_bus_volume_db>` 的结果调用 :ref:`@GlobalScope.db_to_linear()<class_@GlobalScope_method_db_to_linear>` 的结果。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_driver_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_driver_name**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_driver_name>`
返回当前音频驱动的名称。默认值通常与操作系统相关，但可以被 ``--audio-driver`` :doc:`命令行参数 <../tutorials/editor/command_line_tutorial>`\ 覆盖。\ ``--headless`` 也会自动将音频驱动设置为 ``Dummy``\ 。另见 :ref:`ProjectSettings.audio/driver/driver<class_ProjectSettings_property_audio/driver/driver>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_input_device_list:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_input_device_list**\ (\ ) :ref:`🔗<class_AudioServer_method_get_input_device_list>`
返回系统中检测到的所有音频输入设备的名称。
\ **注意：**\ :ref:`ProjectSettings.audio/driver/enable_input<class_ProjectSettings_property_audio/driver/enable_input>` 必须为 ``true`` 音频输入才能正常工作。另见该设置的说明，了解与权限和操作系统隐私设置相关的注意事项。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_input_mix_rate:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_input_mix_rate**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_input_mix_rate>`
返回 **AudioServer** 输入的采样率。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_mix_rate:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_mix_rate**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_mix_rate>`
返回 **AudioServer** 输出的采样率。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_output_device_list:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_output_device_list**\ (\ ) :ref:`🔗<class_AudioServer_method_get_output_device_list>`
返回系统中检测到的所有音频输出设备的名称。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_output_latency:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_output_latency**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_output_latency>`
返回音频驱动的实际输出延迟。基于 :ref:`ProjectSettings.audio/driver/output_latency<class_ProjectSettings_property_audio/driver/output_latency>`\ ，但实际的返回值取决于操作系统和音频驱动。
\ **注意：**\ 可能开销较大；不建议每帧都调用 :ref:`get_output_latency()<class_AudioServer_method_get_output_latency>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_speaker_mode:
.. rst-class:: classref-method
:ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **get_speaker_mode**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_speaker_mode>`
返回扬声器的配置。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_time_since_last_mix:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_time_since_last_mix**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_time_since_last_mix>`
返回自上次混合以来的相对时间。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_get_time_to_next_mix:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_time_to_next_mix**\ (\ ) |const| :ref:`🔗<class_AudioServer_method_get_time_to_next_mix>`
返回下一次混合之前的相对时间。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_is_bus_bypassing_effects:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_bus_bypassing_effects**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_is_bus_bypassing_effects>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线会绕过效果。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_is_bus_effect_enabled:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_bus_effect_enabled**\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_is_bus_effect_enabled>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线上启用了索引为 ``effect_idx`` 的效果。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_is_bus_mute:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_bus_mute**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_is_bus_mute>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线已静音。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_is_bus_solo:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_bus_solo**\ (\ bus_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioServer_method_is_bus_solo>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线处于独奏模式。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_is_stream_registered_as_sample:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_stream_registered_as_sample**\ (\ stream\: :ref:`AudioStream<class_AudioStream>`\ ) :ref:`🔗<class_AudioServer_method_is_stream_registered_as_sample>`
**实验性：** 未来版本中可能会修改或移除该方法。
如果为 ``true``\ ，则该流已被注册为样本。引擎无需在播放样本之前对其进行注册。
如果为 ``false``\ ，则必须在播放之前注册该流。为防止延迟峰值，请使用 :ref:`register_stream_as_sample()<class_AudioServer_method_register_stream_as_sample>` 将流注册为样本。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_lock:
.. rst-class:: classref-method
|void| **lock**\ (\ ) :ref:`🔗<class_AudioServer_method_lock>`
锁定音频驱动程序的主循环。
\ **注意：**\ 之后记得解锁。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_move_bus:
.. rst-class:: classref-method
|void| **move_bus**\ (\ index\: :ref:`int<class_int>`, to_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_move_bus>`
将总线从索引 ``index`` 移动到索引 ``to_index``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_register_stream_as_sample:
.. rst-class:: classref-method
|void| **register_stream_as_sample**\ (\ stream\: :ref:`AudioStream<class_AudioStream>`\ ) :ref:`🔗<class_AudioServer_method_register_stream_as_sample>`
**实验性：** 未来版本中可能会修改或移除该方法。
强制将流注册为样本。
\ **注意：**\ 调用该方法时可能会出现延迟峰值，尤其是在单线程构建中。建议在加载资产时调用该方法，这样可以掩盖延迟峰值，而不是在需要播放样本之前才注册样本。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_remove_bus:
.. rst-class:: classref-method
|void| **remove_bus**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_remove_bus>`
移除索引 ``index`` 处的总线。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_remove_bus_effect:
.. rst-class:: classref-method
|void| **remove_bus_effect**\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_remove_bus_effect>`
将索引 ``effect_idx`` 的效果从索引 ``bus_idx`` 的总线上移除。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_bypass_effects:
.. rst-class:: classref-method
|void| **set_bus_bypass_effects**\ (\ bus_idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_bypass_effects>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线会绕过效果。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_effect_enabled:
.. rst-class:: classref-method
|void| **set_bus_effect_enabled**\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_effect_enabled>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线上启用了索引为 ``effect_idx`` 的效果。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_layout:
.. rst-class:: classref-method
|void| **set_bus_layout**\ (\ bus_layout\: :ref:`AudioBusLayout<class_AudioBusLayout>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_layout>`
覆盖当前使用的 :ref:`AudioBusLayout<class_AudioBusLayout>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_mute:
.. rst-class:: classref-method
|void| **set_bus_mute**\ (\ bus_idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_mute>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线已静音。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_name:
.. rst-class:: classref-method
|void| **set_bus_name**\ (\ bus_idx\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_name>`
将索引为 ``bus_idx`` 的总线的名称设为 ``name``\ 。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_send:
.. rst-class:: classref-method
|void| **set_bus_send**\ (\ bus_idx\: :ref:`int<class_int>`, send\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_send>`
将索引为 ``bus_idx`` 处的总线输出连接到名为 ``send`` 的总线。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_solo:
.. rst-class:: classref-method
|void| **set_bus_solo**\ (\ bus_idx\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_solo>`
如果为 ``true``\ ，则索引为 ``bus_idx`` 的总线处于独奏模式。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_volume_db:
.. rst-class:: classref-method
|void| **set_bus_volume_db**\ (\ bus_idx\: :ref:`int<class_int>`, volume_db\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_volume_db>`
将索引为 ``bus_idx`` 的总线的音量设为 ``volume_db``\ ，单位为分贝。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_bus_volume_linear:
.. rst-class:: classref-method
|void| **set_bus_volume_linear**\ (\ bus_idx\: :ref:`int<class_int>`, volume_linear\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AudioServer_method_set_bus_volume_linear>`
将索引\ ``bus_idx``\ 处的总线容量线性值设置为\ ``volume_linear``\ 。
\ **注意：**\ 使用该方法，与对某个值执行\ :ref:`@GlobalScope.linear_to_db()<class_@GlobalScope_method_linear_to_db>`\ 并基于所得结果调用\ :ref:`set_bus_volume_db()<class_AudioServer_method_set_bus_volume_db>`\ ，是等价的。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_set_enable_tagging_used_audio_streams:
.. rst-class:: classref-method
|void| **set_enable_tagging_used_audio_streams**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AudioServer_method_set_enable_tagging_used_audio_streams>`
如果设置为 ``true``\ ，\ :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` 的所有实例将在每个混音步骤调用 :ref:`AudioStreamPlayback._tag_used_streams()<class_AudioStreamPlayback_private_method__tag_used_streams>`\ 。
\ **注意：**\ 这在编辑器中默认启用，因为编辑器插件将其用于音频流预览。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_swap_bus_effects:
.. rst-class:: classref-method
|void| **swap_bus_effects**\ (\ bus_idx\: :ref:`int<class_int>`, effect_idx\: :ref:`int<class_int>`, by_effect_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioServer_method_swap_bus_effects>`
在索引为 ``bus_idx`` 的总线中交换两个效果的位置。
.. rst-class:: classref-item-separator
----
.. _class_AudioServer_method_unlock:
.. rst-class:: classref-method
|void| **unlock**\ (\ ) :ref:`🔗<class_AudioServer_method_unlock>`
解锁音频驱动程序的主循环。（锁定后，你始终需要手动解锁它。）
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)`
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)`
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)`
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
.. |void| replace:: :abbr:`void (无返回值。)`
Reference in New Issue View Git Blame Copy Permalink