Wwise Unity Integration Documentation

Prerequisites

Before you proceed with this tutorial, do the following:

Install the latest Wwise Demo Scene, as described in Wwise 演示场景.
Install the Wwise Unity Addressables Package, as described in 安装 Wwise Unity Addressables Package.

安装 Addressables Demo Scene

An Addressables Demo Scene is available on GitHub.

To install the Addressables Demo Scene:

In a browser, open https://github.com/audiokinetic/WwiseUnityAddressablesDemoScene.
Clone the repository to your computer.
In the Unity Editor, open the WwiseDemoScene.
Select Window > Package Manager.
Click + and select Add package from disk.

警告： Do not select Add package from git URL. If you install the package that way, you cannot open the sample scenes.
Open the package.json file in the WwiseUnityAddressablesDemoScene repository.

快速入门

我们专门为此教程在 Wwise 工程中创建了两个音效、两个 Event 和一个 SoundBank。

我们使用 AkBank 和 AkEvent 组件创建了两个 GameObject Prefab：DlcAssetHighImpact 和 DlcAssetLowImpact。这两个 Prefab 会加载 “DLC” SoundBank，并在实例化时播放对应的音效。

除此之外，我们还创建了两个场景：AddressablesDemoScene 和 AddressablesSubScene。 AddressablesDemoScene 是个简单的 Unity 场景，里面包含了一些互动按钮，方便测试 Addressables 素材的加载和卸载。 AddressablesSubScene 则是个仅包含 “DlcAssetLowImpact” Prefab 的场景。我们可使用其来对“通过 Addressables 加载包含 Wwise 对象的场景”进行测试。

备注：

AddressablesDemoScene 还包含一个有关如何借助 Wwise Addressables Package 使用本地化语音并更改语言的示例。

所有这些素材以及下节所述脚本均存放在 WwiseUnityAddressablesDemoScene 数据包中。

您可以通过在对应 Inspector 中启用 Addressable 复选框来将以下三项标记为 Addressables 素材：

AddressablesSubScene.unity
Prefabs/DlcAssetHighImpact.prefab
Prefabs/DlcAssetLowImpact.prefab

注意： 若从工程中移除 Unity Addressables Package，则将从所有素材移除 Addressable 字段。在重新安装该数据包时，并不会保留该复选框的状态。

在 Addressables Groups 窗口内，可看到 Default Local Group 中默认替换了这些 Addressables 素材。

如需创建新的分组，可右键单击 Addressables Groups 窗口并选择 Create New Group，或从菜单中依次选择 New > Packed Assets。为 DLC 素材创建两个新的分组：

DLC_Assets – 用于 Prefab 和子场景。
DLC_WwiseData_Windows – 用于平台专用 Soundbank 素材。

备注：

在本例中，我们只为 Windows 平台创建了一个附加 SoundBank 分组。不过，一般来说每个所要部署到的平台都要创建一个。

将 DlcAssetHighImpact、DlcAssetLowImpact 和 AddressablesSubScene 从 Default Local Group 移到 DLC_Assets 分组。
将平台专用 “DLC” SoundBank 素材从 WwiseData_Windows 移到 DLC_WwiseData_Windows 分组。

备注：

我们确保了会在平台专用分组名称中包含字符串 WwiseData 和平台名称 Windows，以便在构建 Addressables 时由 BuildWwiseData 脚本正确地进行处理。
若要保存对分组的修改，请启用 Use Sample Metadata Preserver 设置，并运行一次 Assets > Wwise > Addressables > Serialize addressable asset metadata 操作。

在 Addressables Groups 窗口中，将 Play Mode Script 设为 Use Existing Build，并通过 Wwise Build Script 构建新的 Addressables 数据包（如构建工程章节所述）。

现在，打开 AddressablesDemoScene。

通过 Addressables 加载素材

在此场景中，有两个按钮：

左侧按钮用于通过 Addressables 加载 “DlcAssetHighImpact” Prefab 并将其实例化。
右侧按钮用于加载 AddressableSubScene 并将其实例化。
此场景包含 DlcAssetLowImpact 素材。

若检视 “Loading DLC Assets Demo” GameObject，会看到我们创建了一个 AssetLoader 对象，并且其包含 AddressablePrefabLoader 组件。

using UnityEngine;
using UnityEngine.AddressableAssets;
using UnityEngine.ResourceManagement.AsyncOperations;
 
public class AddressablePrefabLoader : MonoBehaviour
{
    public AssetReference reference;
 
    public void Load()
    {
        Addressables.LoadAssetAsync<GameObject>(reference).Completed += asyncOp =>
        {
            if (asyncOp.Status == AsyncOperationStatus.Succeeded)
            {
                Instantiate(asyncOp.Result,this.transform);
            }
        };
    }
}

此组件包含 AssetReference。我们已在对应 Inspector 中将其设为 “DlcAssetHighImpact” Prefab。

在运行游戏并按下左侧按钮时，将调用 AddressablePrefabLoader 上的设定 Load 方式：从 DLC_Assets 加载，并将 “DlcAssetHighImpact” Prefab 实例化。一旦实例化，AkBank 组件便会从 DLC_WwiseData_Windows 素材包加载 SoundBank。

通过 Addressables 加载场景

若检视 “Loading DLC Scene Demo” GameObject，会看到我们创建了一个 SceneLoader 对象，并且其包含 AddressableSceneLoader 组件。

using UnityEngine;
 
using UnityEngine.AddressableAssets;
using UnityEngine.ResourceManagement.AsyncOperations;
using UnityEngine.ResourceManagement.ResourceProviders;
using UnityEngine.SceneManagement;
 
public class AddressableSceneLoader : MonoBehaviour
{
 
    public AssetReference scene;
    private AsyncOperationHandle<SceneInstance> sceneHandle;
 
    public void Awake()
    {
        DontDestroyOnLoad(gameObject);
    }
 
    public void LoadScene()
    {
        if (!sceneHandle.IsValid() )
        {
            scene.LoadSceneAsync( LoadSceneMode.Additive).Completed += SceneLoadComplete;
        }
        else
        {
            UnloadScene();
        }
    }
 
    public void UnloadScene()
    {
        Addressables.UnloadSceneAsync(sceneHandle).Completed += op =>
        {
            if (op.Status == AsyncOperationStatus.Succeeded)
            {
                Debug.Log("Successfully unloaded scene");
            }
        };
    }
 
    private void SceneLoadComplete(AsyncOperationHandle<SceneInstance> obj)
    {
        sceneHandle = obj;
        if (obj.Status == AsyncOperationStatus.Succeeded)
        {
            Debug.Log(obj.Result.Scene.name + " successfully loaded");
        }
    }
}

此组件使用 AssetReference 保存对 AddressablesSubScene 的引用。在第一次按下按钮时，会调用 LoadSceneMethod，进而采用 LoadSceneAsync 方式加载场景，并将其添加到当前场景中。在第二次按下按钮时，将卸载场景。

AddressablesSubScene 仅包含 “DlcAssetLowImpact” Prefab，其在实例化时会加载 “DLC” Soundbank 并播放对应的 Event。

更改语言

在此场景中的第三个示例中，可在 English 和 French 之间切换语言，并播放本地化声音样本。此示例使用 AkWwiseSetLocalization 脚本。在按下绿色或蓝色按钮时，会调用 AkAddressableBankManager.SetLanguageAndReloadLocalizedBanks 函数，并将语言更改为 English 或 French。

此函数执行以下操作：

卸载所有本地化 SoundBank
卸载 Init SoundBank
使用 AkUnitySoundEngine.SetCurrentLanguage 设置语言
重新加载 Init SoundBank
重新加载本地化 SoundBank

using UnityEngine;
 
public class AkWwiseSetLocalization : MonoBehaviour
{
    public string LanguageString;
 
    public void SetLanguage()
    {
        Debug.Log($"Setting language to {LanguageString}");
        AK.Wwise.Unity.WwiseAddressables.AkAddressableBankManager.Instance.SetLanguageAndReloadLocalizedBanks(LanguageString);
    }
}