AudioServer
继承
简要描述
用于低级别音频访问的服务器接口。
描述
AudioServer是用于音频访问的低级服务器接口。
成员
| 类型 | 属性名 | 默认值 |
|---|---|---|
| int | bus_count | 1 |
| String | device | "Default" |
| float | global_rate_scale | 1.0 |
方法
| 返回值类型 | 方法名称 |
|---|---|
| void | add_bus(at_position: int = -1) |
| void | add_bus_effect(bus_idx: int, effect: AudioEffect, at_position: int = -1) |
| String | capture_get_device() |
| Array | capture_get_device_list() |
| void | capture_set_device(name: String) |
| AudioBusLayout | generate_bus_layout() const |
| int | get_bus_channels(bus_idx: int) const |
| AudioEffect | get_bus_effect(bus_idx: int, effect_idx: int) |
| int | get_bus_effect_count(bus_idx: int) |
| AudioEffectInstance | get_bus_effect_instance(bus_idx: int, effect_idx: int, channel: int = 0) |
| int | get_bus_index(bus_name: String) const |
| String | get_bus_name(bus_idx: int) const |
| float | get_bus_peak_volume_left_db(bus_idx: int, channel: int) const |
| float | get_bus_peak_volume_right_db(bus_idx: int, channel: int) const |
| String | get_bus_send(bus_idx: int) const |
| float | get_bus_volume_db(bus_idx: int) const |
| Array | get_device_list() |
| float | get_mix_rate() const |
| float | get_output_latency() const |
| int | get_speaker_mode() const |
| float | get_time_since_last_mix() const |
| float | get_time_to_next_mix() const |
| bool | is_bus_bypassing_effects(bus_idx: int) const |
| bool | is_bus_effect_enabled(bus_idx: int, effect_idx: int) const |
| bool | is_bus_mute(bus_idx: int) const |
| bool | is_bus_solo(bus_idx: int) const |
| void | lock() |
| void | move_bus(index: int, to_index: int) |
| void | remove_bus(index: int) |
| void | remove_bus_effect(bus_idx: int, effect_idx: int) |
| void | set_bus_bypass_effects(bus_idx: int, enable: bool) |
| void | set_bus_effect_enabled(bus_idx: int, effect_idx: int, enabled: bool) |
| void | set_bus_layout(bus_layout: AudioBusLayout) |
| void | set_bus_mute(bus_idx: int, enable: bool) |
| void | set_bus_name(bus_idx: int, name: String) |
| void | set_bus_send(bus_idx: int, send: String) |
| void | set_bus_solo(bus_idx: int, enable: bool) |
| void | set_bus_volume_db(bus_idx: int, volume_db: float) |
| void | swap_bus_effects(bus_idx: int, effect_idx: int, by_effect_idx: int) |
| void | unlock() |
信号
- **bus_layout_changed**
AudioBusLayout更改时发出。
枚举
enum SpeakerMode:
- **SPEAKER_MODE_STEREO = 0**
检测到两个或更少的扬声器。
- **SPEAKER_SURROUND_31 = 1**
检测到3.1声道环绕设置。
- **SPEAKER_SURROUND_51 = 2**
检测到5.1声道环绕设置。
- **SPEAKER_SURROUND_71 = 3**
检测到7.1声道环绕设置。
常量
成员说明
- int bus_count
| Default | 1 |
|---|---|
| setter | set_bus_count(value) |
| getter | get_bus_count |
- String device
| Default | "Default" |
|---|---|
| setter | set_device(value) |
| getter | get_device |
- float global_rate_scale
| Default | 1.0 |
|---|---|
| setter | set_global_rate_scale(value) |
| getter | get_global_rate_scale |
方法说明
- add_bus add_bus(at_position: int = -1)
在at_position处添加总线。
- add_bus_effect add_bus_effect(bus_idx: int, effect: AudioEffect, at_position: int = -1)
在at_position处向总线bus_idx添加AudioEffect效果。
- capture_get_device capture_get_device()
用于音频输入的当前设备的名称（请参见capture_get_device_list）。
- capture_get_device_list capture_get_device_list()
返回系统上检测到的所有音频输入设备的名称。
- capture_set_device capture_set_device(name: String)
设置哪个音频输入设备用于音频捕获。
- generate_bus_layout generate_bus_layout() const
使用可用的总线和效果生成AudioBusLayout。
- get_bus_channels get_bus_channels(bus_idx: int) const
返回索引为bus_idx的总线通道数。
- get_bus_effect get_bus_effect(bus_idx: int, effect_idx: int)
返回总线bus_idx中位置effect_idx的AudioEffect。
- get_bus_effect_count get_bus_effect_count(bus_idx: int)
通过bus_idx返回总线上的效果数。
- get_bus_effect_instance get_bus_effect_instance(bus_idx: int, effect_idx: int, channel: int = 0)
返回分配给给定总线和效果索引（以及可选的通道）的AudioEffectInstance。
- get_bus_index get_bus_index(bus_name: String) const
返回名称为bus_name的总线的索引。
- get_bus_name get_bus_name(bus_idx: int) const
返回索引为bus_idx的总线名称。
- get_bus_peak_volume_left_db get_bus_peak_volume_left_db(bus_idx: int, channel: int) const
返回左扬声器在总线索引bus_idx和通道索引channel处的峰值音量。
- get_bus_peak_volume_right_db get_bus_peak_volume_right_db(bus_idx: int, channel: int) const
返回右扬声器在总线索引bus_idx和通道索引channel处的峰值音量。
- get_bus_send get_bus_send(bus_idx: int) const
返回索引为bus_idx的总线发送到的总线的名称。
- get_bus_volume_db get_bus_volume_db(bus_idx: int) const
以dB为单位返回索引为bus_idx的总线的音量。
- get_device_list get_device_list()
返回系统上检测到的所有音频设备的名称。
- get_mix_rate get_mix_rate() const
返回AudioServer输出上的采样率。
- get_output_latency get_output_latency() const
返回音频驱动程序的输出延迟。
- get_speaker_mode get_speaker_mode() const
返回扬声器配置。
- get_time_since_last_mix get_time_since_last_mix() const
返回自上次混合发生以来的相对 时间。
- get_time_to_next_mix get_time_to_next_mix() const
返回直到下一次混合发生的相对时间。
- is_bus_bypassing_effects is_bus_bypassing_effects(bus_idx: int) const
如果true为真，则索引为bus_idx的总线将绕过效果。
- is_bus_effect_enabled is_bus_effect_enabled(bus_idx: int, effect_idx: int) const
如果true，则启用索引为bus_idx的总线上的索引为effect_idx的效果。
- is_bus_mute is_bus_mute(bus_idx: int) const
如果true，则索引为bus_idx的总线被静音。
- is_bus_solo is_bus_solo(bus_idx: int) const
如果true为真，则索引为bus_idx的总线处于单独模式。
- lock lock()
锁定音频驱动程序的主循环。
注意：请记住，之后将其解锁。
- move_bus move_bus(index: int, to_index: int)
将总线从索引index移到索引to_index。
- remove_bus remove_bus(index: int)
删除索引为index的总线。
- remove_bus_effect remove_bus_effect(bus_idx: int, effect_idx: int)
从索引为bus_idx的总线上删除索引为effect_idx的效果。
- set_bus_bypass_effects set_bus_bypass_effects(bus_idx: int, enable: bool)
如果true为真，则索引为bus_idx的总线将绕过效果。
- set_bus_effect_enabled set_bus_effect_enabled(bus_idx: int, effect_idx: int, enabled: bool)
如果true，则启用索引为bus_idx的总线上的索引为effect_idx的效果。
- set_bus_layout set_bus_layout(bus_layout: AudioBusLayout)
覆盖当前使用的AudioBusLayout。
- set_bus_mute set_bus_mute(bus_idx: int, enable: bool)
如果true，则索引为bus_idx的总线被静音。
- set_bus_name set_bus_name(bus_idx: int, name: String)
将索引为bus_idx的总线名称设置为name。
- set_bus_send set_bus_send(bus_idx: int, send: String)
将位于bus_idx的总线输出连接到名为send的总线。
- set_bus_solo set_bus_solo(bus_idx: int, enable: bool)
如果true为真，则索引为bus_idx的总线处于单独模式。
- set_bus_volume_db set_bus_volume_db(bus_idx: int, volume_db: float)
将索引为bus_idx的总线的音量设置为volume_db。
- swap_bus_effects swap_bus_effects(bus_idx: int, effect_idx: int, by_effect_idx: int)
交换总线bus_idx中两个效果的位置。
- unlock unlock()
解锁音频驱动程序的主循环。