版本
menu_open

定义生成 SoundBank 前/后所要执行的自定义用户步骤

根据工作流程,在生成 SoundBank 之前或之后您可能需要立即执行特定步骤或任务。例如,在生成特定 SoundBank 文件前想从版本控制系统中 check out 它们;或者在生成后想立即将流播放文件复制到 SoundBanks 目录中。虽然这些信息通常在工程级别定义,但有时候您可能不需要沿用这些信息,而需要创建您自己的自定义设置。

在 Wwise 中,这些任务类型是通过创建命令行来定义的。Wwise 中有一个专门的命令行编辑器,方便您构建数目不限的命令行。为了进一步简化过程,编辑器中包含命令行中可使用的所有 Wwise 专用环境变量和其它 Windows 环境变量的列表。

[备注] 备注

如果外部工具返回错误或者找不到该外部工具,则构建过程可能会被中断。通过在日志设置中将相应日志严重性级别设为 Fatal Error 来完成这一点。要了解详细信息,请参阅更改日志中的消息的严重性
当自定义 Global opening step 失效时,整个构建进程将被中断,并且不会创建 SoundBank。不过当针对特定平台的自定义步骤失效时,则将只跳过该平台。然而,由于进程运行不完全成功,因此将跳过 Global closing step。外部进程必须返回非零值才会被视为失效。

可用于编写自定义命令行的专用 Wwise 变量如下:

命令行变量

描述

$(AllowExceedMaximum)

指定当 SoundBanks 超过指定最大大小时是否生成该 SoundBanks。

当选择了 Allow SoundBanks to exceed maximum(允许 SoundBanks 超过最大大小)选项时,此变量设为 True。

$(ContentFileFormat)

指定生成的 SoundBank 内容文件的文件类型。可能的值为:

  • ANSI

  • Unicode

$(GenerateContentFile)

指定是否创建文件来列出各个 SoundBank 的内容。内容文件包括有关 Event、Buss、State 和 Switch 的信息,以及流播放音频文件和内存音频文件的完整列表。

当选择了 Generate SoundBank content files(生成 SoundBank 内容文件)选项时,此变量设为 True。

$(GenerateHeaderFile)

指定是否生成将 Event、状态、切换开关和游戏参数名称映射到 ID 的头文件。

当选择了 Generate Header File(生成头文件)选项时,此变量设为 True。

$(GenerateMaxAttenuationInfo)

指定是否为 Event 生成最大衰减距离信息。

当选择了 Metadata Options: Max attenuation选项时,此变量设为 True。

$(GenerateEstimatedDuration)

指定是否为 Event 生成预计最大和最小时长以及时长类型信息。

当选择了 Metadata Options: Estimated Duration 选项时,此变量设为 True。

$(HeaderFileFullFilePath)

头文件的完整路径,即 $(HeaderFilePath)\Wwise_IDs.h。

$(HeaderFilePath)

保存头文件的路径或位置。

此路径来自 Header file path(头文件路径)文本框。

$(InfoFilePath)

当前平台的信息文件的完整文件名。

$(IsRunningFromCmdLine)

指定 Wwise 启动的命令行中是否带有“-generatesoundbanks” 选项。

$(LanguageList)

传送到命令行的语言的列表或者 SoundBank Manager 中的选定语言的列表。

[备注] 备注

列表采用空格隔开。

$(Platform)

当前平台的名称。

$(SoundBankList)

传送到命令行的 SoundBank 的列表或者 SoundBank Manager 中的选定 SoundBank 的列表。

[备注] 备注

列表采用空格隔开。并用双引号括起整个参数中的列表。

$(SoundBankPath)

保存当前平台的 SoundBanks 的路径或位置。

$(UseSoundBankNames)

指定选用 SoundBank 名称(设为 true 时)或 ID(设为 false 时)来用于命名生成的 SoundBank BNK 文件,以及在 SoundBanks 中用于引用其它 SoundBank 中的媒体。

当选择了 Use SoundBank names(使用声音包名称)选项时,此变量设为 True。

$(WwiseExeDriveLetter)

Wwise 可执行程序(Wwise.exe)所在的电脑盘符。

$(WwiseExePath)

Wwise 可执行程序(Wwise.exe)的路径或位置。

$(WwiseExeProcessID)

Wwise 可执行程序(Wwise.exe)的进程 ID (数字形式)。

$(WwiseProjectDriveLetter)

Wwise 工程所在的电脑盘符。

$(WwiseProjectName)

当前工程的名称。

$(WwiseProjectPath)

Wwise 工程的路径或位置。

$(WaapiWampPort)

WAAPI 为 WAMP 协议使用的端口。

$(WaapiHttpPort)

WAAPI 为 HTTP 协议使用的端口。

[备注] 备注

环境变量自动进行映射,例如 $(WWISESDK)。

为了尽可能提高灵活性,Wwise 支持为以下类型的步骤指定命令行:

  • Global opening step -- 全局初始步骤。适用于所有平台并且在任何其它步骤前执行的命令行。

  • Platform-specific pre-generation step -- 针对平台的生成前步骤。适用于特定平台并且在生成 SoundBanks 前执行的命令行。

  • Platform-specific post-generation step -- 针对平台的生成后步骤。适用于特定平台并且在生成 SoundBanks 后执行的命令行。

  • Global closing step -- 全局结束步骤。适用于所有平台并且在所有其它步之后执行的命令行。

在默认情况下,各个工程都包含平台专有的生成后步骤(post-generation step)命令行,该命令行将流播放文件复制到 SoundBank 目录下。然而,您可以通过执行一个不同的命令行将任何类型的任务自动化。 Wwise 还自带另一个出厂命令行,它使用 File Packager 来生成包含 SoundBank 中所有数据和媒体的文件包。有关 File Packager 的详细信息,请参阅第 36 章 管理 File Package有关加载出厂命令行的详细信息,请参阅加载出厂设定/自定义命令行

您还可以将您创建的命令行保存到文件(WCMDLINE)中,以便今后在同一工程中使用,跨工程使用,或者与其它用户共享。有关保存命令的详细信息,请参阅将自定义命令行保存至文件

定义生成 SoundBank 前执行的用户任务的方法如下:

  1. 在 SoundBank Manager 中,点击 User Settings(用户设置)。

    此时将打开 SoundBank User Settings 对话框。

  2. 选择 Override Project Pre-Generation Step(不沿用工程预生成步骤)选项。

  3. 要添加或修改在 Project Settings 对话框中定义的全局起始预生成步骤,则点击相应的 Edit 按钮(...)。

    Pre-Generation Step Editor(生成前步骤编辑器)打开。

  4. Description 文本框中,输入名称,名称要能清晰描述将要执行的步骤或任务。

  5. Commands 文本框中,根据需要编写新的命令行或者编辑现有的命令行。

    [备注] 备注

    Commands 文本框和与大多数其他文本编辑器一样,允许您按 Enter 键添加新的文本行,选择文本并按 Delete 键删除文本,等等。

  6. 如果要在命令中插入内置宏和环境变量,则请执行以下操作:

    Macros(宏)分组框中,选择以下其中一个选项:

    • Built-in Macros -- 内置宏。显示可用于 Wwise 命令行中的一列 Wwise 专用变量。

    • Environment Variables -- 环境变量。显示可用于 Wwise 命令行中的一列 Windows 专用环境变量。

    要添加变量到命令行中的话,要执行以下操作中的一项:

    • 双击列表中的变量。

    • 从列表中选择变量,然后点击 Insert(插入)。

    根据需要,继续添加变量到命令行。

  7. 如果需要添加另一个预生成步骤,则只需转至第一行的末尾,按 Enter,然后开始创建新的命令行即可。

  8. 点击 OK 保存命令行并关闭 Pre-Generation Step Editor。

    [备注] 备注

    如果需要将命令行保存为文件,则在编辑器中点击 Save As(另存为)按钮。有关保存自定义命令行的详细信息,请参阅将自定义命令行保存至文件

  9. 要添加或修改现有平台专用的预生成步骤,则对各个平台重复执行步骤 3 至 8。

    [备注] 备注

    您还可以通过点击 Load 按钮将出厂设定和先前保存的自定义命令行加载到 Editor 中。有关加载出厂设定/自定义命令的详细信息,请参阅加载出厂设定/自定义命令行

定义生成 SoundBank 后执行的用户任务的方法如下:

  1. 在 SoundBank Manager 中,点击 User Settings(用户设置)。

    此时将打开 SoundBank User Settings 对话框。

  2. 选择 Override Project Post-Generation Step 选项。

  3. 要添加或修改在 Project Setting 对话框中定义的现有后生成步骤,则点击 Edit 按钮(...)之一。

    此时将打开 Post-Generation Step Editor。

  4. Description 文本框中,输入名称,名称要能清晰描述将要执行的步骤或任务。

  5. Command 文本框中,根据需要编写新的命令行或编辑当前命令行。

    [备注] 备注

    Commands 文本框和与大多数其他文本编辑器一样,允许您按 Enter 键添加新的文本行,选择文本并按 Delete 键删除文本,等等。

  6. 如果要在命令中插入内置宏和环境变量,则请执行以下操作:

    Macros(宏)分组框中,选择以下其中一个选项:

    • Built-in Macros -- 内置宏。显示可用于 Wwise 命令行中的一列 Wwise 专用变量。

    • Environment Variables -- 环境变量。显示可用于 Wwise 命令行中的一列 Windows 专用环境变量。

    要添加变量到命令行中的话,要执行以下操作中的一项:

    • 双击列表中的变量。

    • 从列表中选择变量,然后点击 Insert(插入)。

    根据需要,继续添加变量到命令行。

  7. 如果需要添加另一个预生成步骤,则只需转至第一行的末尾,按 Enter,然后开始创建新的命令行即可。

  8. 点击 OK 以保存命令行并关闭 Post-Generation Step Editor。

    [备注] 备注

    如果需要将命令行保存为文件,则在编辑器中点击 Save As(另存为)按钮。有关保存自定义命令行的详细信息,请参阅将自定义命令行保存至文件

  9. 对于全局结束步骤或其它各个平台,重复执行步骤 3 至 8。

    [备注] 备注

    您还可以通过点击 Load 按钮将出厂设定和先前保存的自定义命令行加载到 Editor 中。有关加载出厂设定/自定义命令的详细信息,请参阅加载出厂设定/自定义命令行


此页面对您是否有帮助?

需要技术支持?

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

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

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

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

开始 Wwise 之旅