跳转至

GFAudioBackendCapability

API Reference / Standard / 类索引

  • 路径:addons/gf/standard/utilities/audio/gf_audio_backend_capability.gd
  • 模块:Standard
  • 继承:Resource
  • API:public
  • 类别:值对象 (value_object)
  • 首次版本:3.17.0

音频后端能力声明。 用布尔能力与元数据描述一个后端能处理哪些通用音频请求。

成员概览

类型 名称 签名
属性 supports_bgm var supports_bgm: bool = false
属性 supports_sfx var supports_sfx: bool = false
属性 supports_ambient var supports_ambient: bool = false
属性 supports_spatial_sfx var supports_spatial_sfx: bool = false
属性 supports_events var supports_events: bool = false
属性 supports_parameters var supports_parameters: bool = false
属性 supports_states var supports_states: bool = false
属性 supports_switches var supports_switches: bool = false
属性 supports_listeners var supports_listeners: bool = false
属性 supports_async_loading var supports_async_loading: bool = false
属性 metadata var metadata: Dictionary = {}
方法 has_capability func has_capability(capability_id: StringName) -> bool:
方法 duplicate_capability func duplicate_capability() -> GFAudioBackendCapability:
方法 to_dictionary func to_dictionary() -> Dictionary:

属性

supports_bgm

  • API:public
var supports_bgm: bool = false

是否支持 BGM。

supports_sfx

  • API:public
var supports_sfx: bool = false

是否支持 SFX。

supports_ambient

  • API:public
var supports_ambient: bool = false

是否支持环境音。

supports_spatial_sfx

  • API:public
var supports_spatial_sfx: bool = false

是否支持空间音效。

supports_events

  • API:public
var supports_events: bool = false

是否支持资源化事件。

supports_parameters

  • API:public
var supports_parameters: bool = false

是否支持参数写入。

supports_states

  • API:public
var supports_states: bool = false

是否支持状态写入。

supports_switches

  • API:public
var supports_switches: bool = false

是否支持开关写入。

supports_listeners

  • API:public
var supports_listeners: bool = false

是否支持监听器。

supports_async_loading

  • API:public
var supports_async_loading: bool = false

是否支持异步加载或卸载。

metadata

  • API:public
var metadata: Dictionary = {}

可选元数据,供项目层或调试面板展示。

结构:

  • metadata: 后端能力元数据 Dictionary;键和值由具体后端或项目工具约定。

方法

has_capability

  • API:public
func has_capability(capability_id: StringName) -> bool:

检查能力是否存在。

参数:

名称 说明
capability_id 能力标识。

返回:支持返回 true。

duplicate_capability

  • API:public
func duplicate_capability() -> GFAudioBackendCapability:

创建同内容拷贝。

返回:新能力声明。

to_dictionary

  • API:public
func to_dictionary() -> Dictionary:

转换为字典。

返回:能力字典。

结构:

  • return: 能力 Dictionary,包含 bgm、sfx、ambient、spatial_sfx、events、parameters、states、switches、listeners、async_loading 和 metadata 字段。