版本
menu_open
Wwise Unreal Integration Documentation
GenerateSoundBanks Commandlet

Wwise Unreal 插件提供相应的 Commandlet,方便通过命令行生成 SoundBank 并提交到版本控制系统。Commandlet 用法:

<UE4Editor-cmd.exe> <path_to_uproject> -run=GenerateSoundBanks [-platforms=listOfPlatforms] [-languages=listOfLanguages] [-wwiseConsolePath=pathToWwiseConsole] [-rebuild][-migrate]
注記: 若使用 Unreal Engine 5,则 Editor 可执行文件的名称为 UnrealEditor-cmd.exe

参数:

  • platforms:(可选)Wwise 工程中指定要生成 SoundBank 的平台列表(以逗号形式分隔)。若未指定,则将针对所有平台生成 SoundBank。
  • languages:(可选)Wwise 工程中指定要生成 SoundBank 的语言列表(以逗号形式分隔)。若未指定,则将针对所有语言生成 SoundBank。
  • banks:(可选)所要生成的 SoundBank 列表(以逗号形式分隔)。Bank 名称必须与工程中的 UAkAudioBank 资源一致。若未指定,则将生成工程中的所有 SoundBank。
  • wwiseConsolePath:(可选)用于生成 SoundBank 的 Wwise 命令行应用的完整路径。若未指定,则将使用 Wwise 设置中的路径。
  • rebuild:(可选)强制清理并重新构建所有 Wwise Sound Data。
  • migrate:(可选)执行工程的首次迁移。
  • fixupRedirectors:(可选)在完成迁移后,修正因移动素材而生成的重定向程序。
  • autosubmit:(可选)将生成的 Wwise 素材自动提交到版本控制系统。
  • clnum:(可选)要添加到自动提交消息末尾的更改列表编号。
  • forceAssetSync:(可选)强制与 Wwise 进行素材同步。这会添加新的素材,并移除删除的素材。
  • help:(可选)输出此帮助消息。此项会马上终止 Commandlet。

使用示例:

C:\UE_4.23\Engine\Binaries\Win64\UE4Editor-Cmd.exe C:\MyProjects\Demo\WwiseDemoGame.uproject -run=GenerateSoundBanks -platforms=Windows,Mac
注記: 若遇到 Development Editor 无法构建或不可用问题,则可将环境变量 SKIP_PLUGIN_ACTIVATION 设为 true,来跳过插件激活流程。

如何使用 Commandlet 执行首次迁移

Commandlet 设有专门的选项,允许在编译机上以离线方式将工程迁移到 Event-Based Packaging 工作流程。对于较大工程,强烈建议使用该选项,因为这一流程可能会相当耗时。Commandlet 会创建新的素材,重新构建 Sound Data,并将其提交到版本控制系统。对此,强烈建议使用 Wwise Console 应用程序的路径。

使用示例:

C:\UE_4.23\Engine\Binaries\Win64\UE4Editor-Cmd.exe C:\MyProjects\Demo\WwiseDemoGame.uproject -run=GenerateSoundBanks -wwiseConsolePath=C:\Wwise\Authoring\x64\Release\Bin\WwiseConsole.exe -migrate

配置提交消息

在启用版本控制系统时,Commandlet 会提交其对工程带来的更改。在 Wwise Integration Settings 中,可通过编辑 Commandlet Commit Message 字段来自定义提交消息。


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅