Spatial Audio 对象
WAAPI 小组件
Event-Based Packaging 所用的类

AkAudioEvent

代表 Wwise Event 的 Unreal 对象。在使用 素材同步 时，会在 Sound Data Folder 中自动创建素材。在不使用 Automatic Asset Synchronization 时，可通过从 Wwise Picker 拖放 或在 Unreal Content Browser 中右键单击来创建 AkAudioEvent。其名称必须与 Wwise 工程中 Event 的名称完全一致。

• 属性
  • Required Bank：指定包含此 Event 的 SoundBank 及其结构和媒体。
• Unreal Content Browser 上下文菜单选项
  • Play Event：发送 Event。
  • Stop Event：停止当前播放的所有 Event。

AkAuxBus

代表 Wwise Auxiliary Bus 的 Unreal 对象。在使用 素材同步 时，会在 Sound Data Folder 中自动创建素材。在不使用 Automatic Asset Synchronization 时，可通过从 Wwise Picker 拖放 或在 Unreal Content Browser 中右键单击来创建 AkAuxBus。其名称必须与 Wwise 工程中 Auxiliary Bus 的名称完全一致。这样方便在 Unreal Editor 内将插件媒体添加到 SoundBank。

• 属性
  • Required Bank：指定包含此 Auxiliary Bus 的 SoundBank 及关联的插件媒体。

AkAudioBank

代表 Wwise SoundBank 的 Unreal 对象。可通过在 Unreal Content Browser 中右键单击来创建。在使用 Event-Based Packaging 工作流程时，它相当于一组 Event（不含媒体）。在不使用 Event-Based Packaging 工作流程时，只能通过它来创建 SoundBank。

• 属性
  • Auto Load：若启用，则自动加载和卸载 SoundBank 及引用该 SoundBank 的 Event 或 Auxiliary Bus。注意：此标记仅用于不使用 Event-Based Packaging 工作流程的情形。
• Unreal Content Browser 上下文菜单选项
  • Generate Selected SoundBank(s)...：打开对话框窗口以便针对一系列 SoundBank 执行 SoundBank Generation 操作。
  • Refresh All Banks：停止播放所有声音；将当前加载的所有 SoundBank 先卸载再加载。

AkAmbientSound

AkAmbientSound 是一个 AActor 类，其使用方式与默认 Unreal Audio 系统提供的 AAmbientSound 对象相同。可通过其自有对象 Blueprint 函数或使用全局辅助函数（Start All Ambient Sounds 和 Stop All Ambient Sounds）来控制其播放行为。同时，AkAmbientSound 还包含 AkComponent （具有自己的属性）。

• 属性
  • Stop When Owner Is Destroyed：若启用，则在销毁 AkAmbientSound 时自动停止 Event。
  • Auto Post：在 BeginPlay 时自动发送关联的 AkAudioEvent 。
• Blueprint 函数
  • Start All Ambient Sounds：开始播放所有环境声。
  • Start Ambient Sound：开始播放所选环境声。
  • Stop All Ambient Sounds：停止播放所有环境声。
  • Stop Ambient Sound：停止播放所选环境声。

AkReverbVolume

AkReverbVolume 是一个 AVolume 类，其使用方式与默认 Unreal Audio 系统提供的 AReverbVolume 对象相同。它可以通过 Editor 中的任何 Brush 生成。通过 AkLateReverbComponent 来获得混响效果。

AkLateReverbComponent

您可以将此组件添加到任何 UPrimitiveComponent 以通过该 Primitive 组件创建混响区域。通过将 Wwise Auxiliary Bus 指派给组件，并把所有进入此 Volume 的 AkComponent 发送到关联的 Wwise Auxiliary Bus，即可获得混响效果。若 Volume 之间存在重叠，则使用 Priority 属性来决定将目标 AkComponent 发送到哪条 Auxiliary Bus。在进入/离开 AkReverbVolume 时，会向 Auxiliary Bus 的电平应用即时淡入/淡出效果。注意，若 Actor 上绑定有活跃的 Ak Late Reverb Component，而且还带有 AkRoomComponent ，则将禁用 Late Reverb Component，并由 AkRoomComponent 处理混响，同时使用 Spatial Audio 引擎来渲染效果。

• 属性
  • Enable Late Reverb：启用或禁用此组件。
  • Send Level：与 Wwise Auxiliary Bus 关联的最大发送电平。
  • Fade Rate：进入/离开当前 Late Reverb Component 时的 SendLevel 淡入/淡出速率，单位为百分比每秒（在值为 0.2 时，淡变时间为 5 秒）。
  • Priority：Late Reverb Component 的应用优先级。若 Volume 之间存在重叠，则仅选择优先级最高的 Late Reverb Component（可在 Unreal Editor Project Settings 的 Plugins > Wwise 下配置同时可有多少个 Late Reverb Component）。若两个或多个重叠的 Late Reverb Component 拥有相同的优先级，则无法预测会选择哪个 Late Reverb Component。
  • Auto Assign Aux Bus：若启用，则自动为此 Late Reverb 组件指派 Aux Bus。为此，可依据体积和表面积来估算父级 Primitive 组件产生的混响衰减时间。此衰减值用于通过 Integration Settings 中的 Aux Bus Assignment Map 来选择 Aux Bus。该项默认设为启用状态。
  • Aux Bus：指派给此 Volume 的 AkAuxBus 。在 Wwise 工程中，此 Aux Bus 需启用游戏定义的辅助发送。若要结合 AkRoomComponent 和 AkPortalComponent 使用 Late Reverb，则还需针对 Positioning 启用 Listener Relative Routing 并指派 3D Spatialization。
  • Environment Decay Estimate：混响环境的 T60 估值（声压级降低 60 dB 所需的时间），基于与 Late Reverb 绑定的 Primitive 组件。此 T60 值可用于通过 Integration Settings 中的 Aux Bus Assignment Map 来自动指派 Aux Bus，并驱动 "Decay Estimate" RTPC（Integration Settings 中的 全局混响 RTPC ）。
  • HFDamping：环境产生的高频阻尼估值，基于关联的 AkGeometryComponent 或 AkSurfaceReflectorSetComponent （如所属 Actor 为 Volume）。要想估算 HFDamping，必须时用 AssociateAkTextureSetComponent 函数将 Geometry 组件与此 Reverb 组件关联。若该 Late Reverb 组件包含同级 Geometry 组件或 Surface Reflector Set 组件，则会自动与之进行关联，而无需调用 AssociateAkTextureSetComponent 函数。若使用 AssociateAkTextureSetComponent，则 HFDamping 值只有在播放时才是准确的。若值等于 0.0，则表示所有频率的阻尼相同。若值大于 0.0，则表示高频的阻尼大于低频。若值小于 0.0，则表示低频的阻尼大于高频。此值可用于驱动 "HFDamping" RTPC（Integration Settings 中的 全局混响 RTPC ）。
  • Time to First Reflection：一阶反射声到达听者位置预计所需的时间，基于与 Late Reverb 绑定的 Primitive 组件。其估算基于放在父级 Primitive 组件中央的发声体和听者。此值可用于驱动 "Time To First Reflection" RTPC（Integration Settings 中的 全局混响 RTPC ）。
• Blueprint 函数
  • Associate Ak Texture Set Component：设置组件（AkGeometryComponent 或 AkSurfaceReflectorSetComponent ）以用于估算 HFDamping。比如，在 Blueprint 所含 Static Mesh 组件带有 AkGeometryComponent 子组件的情况下，可通过在 BeginPlay 时调用该函数来将所述 AkGeometryComponent 与此 Late Reverb 组件关联。若该 Late Reverb 组件包含同级 AkGeometryComponent 或 AkSurfaceReflectorSetComponent ，则会自动与之进行关联，而无需调用此函数。

注記： Ak Late Reverb 组件必须与组件层级结构中的 UPrimitiveComponent 绑定。若 Ak Late Reverb 组件没有 UPrimitiveComponent 父对象，则日志中将显示错误，组件也会不起作用。

注記： 在自定义 Blueprint 类中使用 AkLateReverbComponent 时，建议将 Simple Collision 组件用作父对象。比如，您可以使用 BoxCollision、 SphereCollision 或 CapsuleCollision 组件。有关详细信息，请参阅 Spatial Audio Blueprint 组件 章节。

注記： 只有 Late Reverb 组件包含同级 AkRoomComponent （即 AkRoomComponent 共用同一 Primitive 父组件），才能结合 Integration Settings 中的 全局混响 RTPC 使用 Environment Decay Estimate、HFDamping 和 Time to First Reflection 值。这些 RTPC 值设在 Room ID 上。

注記： 在 Level Editor 中设置 Ak Late Reverb 组件时，强烈建议在 Viewport Options 中启用 Realtime。若禁用 Realtime，则在调节 Actor 时或在 Wwise 工程中更改 Acoustic Texture 参数时将不会更新 Reverb Parameter Estimation 值。

AkComponent

AkComponent 由 USceneComponent 派生，代表活跃的 Wwise Event。

• 属性

  • Attenuation Scaling Factor：若 Ambient Sound 使用 Wwise 中的衰减，则此属性允许修改该环境声的衰减计算结果，以便模拟具有更大或更小传播区域的声音。
  • Use Reverb Volumes：指定组件是否会受 AAkReverbVolumes 影响。
  • Occlusion
    • Occlusion Refresh Interval：设置声笼/声障检查之间的时间间隔（听者和此游戏对象之间的直接视线）。若设为 0，则针对此组件禁用声笼/声障。若要使用全方位 Spatial Audio 衍射，则建议将其禁用。
  • Spatial Audio
    • Enable Spot Reflectors：针对此 AkComponent 在 AkSpotReflector 上启用反射。
    • Radial Emitter
      • Outer Radius：将字段设为所需外径大小。该数值将直接发送到 Spatial Audio AK:SpatialAudio::SetGameObjectRadius() 调用而不进行任何转换。在选中 Actor 时，将围绕该游戏对象所在位置绘制黄色球体框线，以此直观地反映所输入的数值大小。
      • Inner Radius：将字段设为所需内径大小。该值不得大于外径大小。该数值将直接发送到 Spatial Audio AK:SpatialAudio::SetGameObjectRadius() 调用而不进行任何转换。在选中 Actor 时，将围绕该游戏对象所在位置绘制黄色球体框线，以此直观地反映所输入的数值大小。
    • Reflect
      • Early Reflection Aux Bus：为当前游戏对象设置早期反射辅助总线。该组件会依据所选辅助总线调用 AK::SpatialAudio::SetEarlyReflectionsAuxSend()。辅助总线参数将被应用到未在设计工具中指定早期反射辅助总线的游戏对象声音。针对各个声音指定的早期反射辅助总线参数在优先级上高于此处传递的值。
      • Early Reflection Aux Bus Name：为当前游戏对象设置早期反射辅助总线。该组件会依据所选辅助总线调用 AK::SpatialAudio::SetEarlyReflectionsAuxSend()。辅助总线参数将被应用到未在设计工具中指定早期反射辅助总线的游戏对象声音。针对各个声音指定的早期反射辅助总线参数在优先级上高于此处传递的值。
      • Early Reflection Bus Send Gain：为当前游戏对象设置早期反射发送音量。它可以用来控制早期反射发送的音量。该组件会依据所输入的音量值调用 AK:SpatialAudio::SetEarlyReflectionsVolume()。该值将连同设计工具中指定的早期反射音量一并应用到游戏对象播放的所有声音。有效值为 [0, 1]。若将音量设为 0，则针对此游戏对象禁用所有反射处理。
    • Reflect（已弃用）
      • Early Reflection Order：（已弃用）自 2019.2 版本起，需要在 Project Settings 内的 Spatial Audio Initialization Settings 中设置 Early Reflection Order。
      • Early Reflection Max Path Length：（已弃用）自 2019.2 版本起，需要通过设计工具内声音的 Attenuation Max distance 值设置 Early Reflection Max Path Length。
    • Room（已弃用）
      • Room Reverb Aux Bus Gain：（已弃用）自 2019.2 版本起，需要通过设计工具内 Sound Property Editor 中的 Game-Defined Auxiliary Sends Volume 设置 Room Reverb Aux Bus Gain。
    • Geometric Diffraction（已弃用）
      • Diffraction Order：（已弃用）自 2019.2 版本起，需要在设计工具内的 Sound Property Editor 中启用 Diffraction。
      • Diffraction Max Paths：（已弃用）自 2019.2 版本起，需要在设计工具内的 Sound Property Editor 中启用 Diffraction。
      • Diffraction Max Path Length：（已弃用）自 2019.2 版本起，需要在设计工具内的 Sound Property Editor 中启用 Diffraction。
    • Debug Draw options：允许以视觉形式呈现 Spatial Audio 引擎所执行的射线投射以及投射射线所碰到的三角形，以便轻松排除 Spatial Audio 引擎存在的问题。每次仅可针对一个组件执行此操作。
  • AkEvent
    • Ak Audio Event：在指示开始播放 AkAmbientSound 对象时发送的 AkAudioEvent 。若要使用 Spatial Audio 功能，则 Event 的音效需启用游戏定义的辅助发送。

  参见

  • features_blueprintcomponent
  • 通过 C++ 创建 AkComponent.

AkAudioInputComponent

AkAudioInputComponent 由 AkComponent 派生，代表音频输入实例。

• Blueprint 函数
  • Post Associated Audio Input Event：开始播放指定的 Event，并注册对应的回调。