版本

menu_open
Wwise SDK 2024.1.4
ak.wwise.cli.generateSoundbank 选项架构

架构

{
"properties": {
"verbose": {
"type": "boolean",
"description": "启用额外的主机文本输出。",
"synopsis": [
"--verbose"
]
},
"quiet": {
"type": "boolean",
"description": "禁用所有非错误主机文本输出。",
"synopsis": [
"--quiet"
]
},
"license": {
"type": "string",
"description": "设置所要使用的授权。该授权不会保存到工程中。",
"synopsis": [
"--license LICENSE"
]
},
"save": {
"type": "boolean",
"description": "在生成 SoundBank 前保存工程。If a tab-delimited import file was provided, the imported content is saved as well. Saving also migrates the project first, if required. This option does not save the project for other instances of Wwise that are currently running.",
"synopsis": [
"--save"
]
},
"platform": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "指定要针对哪些平台生成 SoundBank。该选项之后必须附加平台标识符。",
"synopsis": [
"--platform PLATFORM",
"--platform PLATFORM1 PLATFORM2 ...",
"--platform PLATFORM1 --platform PLATFORM2 ..."
]
},
"abort-on-load-issues": {
"type": "boolean",
"description": "若检测到工程加载问题,则放弃执行该操作。所有被记录的工程加载问题都会打印到屏幕上。",
"synopsis": [
"--abort-on-load-issues"
]
},
"bank": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "指定要生成哪些 SoundBank。此选项后面必须紧跟将要生成的 SoundBank 的名称。可以指定多个 SoundBank。若未指定任何 SoundBank,则生成所有 SoundBank。除此之外,也可指定包含 SoundBank 名称列表的文本文件。为此,可指定该文本文件的完整路径(包括 .txt 扩展名)。",
"synopsis": [
"--bank SOUNDBANK",
"--bank SOUNDBANK1 SOUNDBANK2 ...",
"--bank FILE"
]
},
"cache": {
"type": "string",
"description": "Overrides the project's cache directory path and instead uses the (relative) path specified in the command.",
"synopsis": [
"--cache PATH"
]
},
"clear-audio-file-cache": {
"type": "boolean",
"description": "Deletes the content of the Wwise audio file cache directory prior to converting source files and generating SoundBanks, which ensures that all source files are reconverted. 注意,无论采用怎样的 --platform 选项,都会将所有平台的缓存全部清除。",
"synopsis": [
"--clear-audio-file-cache"
]
},
"continue-on-error": {
"type": "boolean",
"description": "若无论是否出现错误都要继续执行,请使用此选项。",
"synopsis": [
"--continue-on-error"
]
},
"custom-global-closing-cmd": {
"type": "string",
"description": "不沿用 Wwise 中定义的全局结束步骤。此选项后面必须紧跟新的命令行(如果命令中有空格,则要用引号括起来)。An empty string (\"\") specified for the command-line means no global closing step is executed.",
"synopsis": [
"--custom-global-closing-cmd CMD"
]
},
"custom-global-opening-cmd": {
"type": "string",
"description": "不沿用 Wwise 中定义的全局开始步骤。此选项后面必须紧跟新的命令行(如果命令中有空格,则要用引号括起来)。An empty string (\"\") specified for the command-line means no global opening step is executed.",
"synopsis": [
"--custom-global-opening-cmd CMD"
]
},
"custom-post-gen-cmd": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "不沿用 Wwise 中为此平台定义的自定义生成后步骤命令行。此选项后面必须紧跟平台标识符(见上文列表),后面再紧跟新的命令行(如果命令中有空格,则要用引号括起来)。要想不沿用另一平台的自定义生成后步骤命令行,可重复添加 --custom-post-gen-cmd 选项,并在其之后附加该平台的标识符及新的命令行。若为命令行指定了空白字符串 (\"\"),则不执行任何生成后步骤。",
"synopsis": [
"--custom-post-gen-cmd PLATFORM CMD",
"--custom-post-gen-cmd PLATFORM1 CMD1 --custom-post-gen-cmd PLATFORM2 CMD2 ..."
]
},
"custom-pre-gen-cmd": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "不沿用 Wwise 中为此平台定义的自定义生成前步骤命令行。此选项后面必须紧跟平台标识符(见上文列表),后面再紧跟新的命令行(如果命令中有空格,则要用引号括起来)。要想不沿用另一平台的自定义生成前步骤命令行,可重复添加 --custom-pre-gen-cmd 选项,并在其之后附加该平台的标识符及新的命令行。An empty string (\"\") specified for the command-line means no pre-generation step is executed.",
"synopsis": [
"--custom-pre-gen-cmd PLATFORM CMD",
"--custom-pre-gen-cmd PLATFORM1 CMD1 --custom-pre-gen-cmd PLATFORM2 CMD2 ..."
]
},
"header-file": {
"type": "boolean",
"description": "即便没有在工程设置中指定此选项,也会生成 Wwise_IDs.h 头文件。",
"synopsis": [
"--header-file"
]
},
"header-file-path": {
"type": "string",
"description": "(DEPRECATED) Use root-output-path instead. 不沿用工程设置中指定的头文件路径。此选项后面必须紧跟将写入头文件(Wwise_IDs.h)的路径(绝对或相对路径)。只有需要创建头文件时,此选项才有用。",
"synopsis": [
"--header-file-path"
]
},
"root-output-path": {
"type": "string",
"description": "Overrides the root output path specified in the SoundBank settings. 此选项后必须紧跟工程层级的路径(绝对或相对)。将写入跨平台文件。Examples of such files are Wwise_IDs.h and ProjectInfo.(xml|json).",
"synopsis": [
"--root-output-path"
]
},
"readable-soundbanks": {
"type": "boolean",
"description": "即便没有在工程设置中指定此选项,也会生成可读 SoundBank (.rbnk)。",
"synopsis": [
"--readable-soundbanks"
]
},
"import-definition-file": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "导入 SoundBank 定义文件。此选项后面必须紧跟将要导入的 SoundBank Definition File 的完整路径。可指定多个文件。若未指定 --save 选项,则不会长久保存导入定义文件后对工程所作的更改。",
"synopsis": [
"--import-definition-file FILE",
"--import-definition-file FILE1 FILE2 ...",
"--import-definition-file FILE1 --import-definition-file FILE2 ..."
]
},
"language": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "指定要针对哪些语言生成 SoundBank。该选项后面必须加上工程中定义的语言标识符。所有指定的语言之前都要附加此选项。",
"synopsis": [
"--language LANGUAGE",
"--language LANGUAGE1 --language LANGUAGE2 ..."
]
},
"skip-languages": {
"type": "boolean",
"description": "不在工程中生成任何本地化 SoundBank。",
"synopsis": [
"--skip-languages"
]
},
"use-stable-guid": {
"type": "boolean",
"description": "Give the SoundBank a stable GUID across multiple builds if you don't want to save the project.",
"synopsis": [
"--use-stable-guid"
]
},
"no-decode": {
"type": "boolean",
"description": "Avoids generating DECODED files in the .cache directory, which saves CPU and disk space for your Wwise project. 同时,缩短 SoundBank 的生成时间。警告:若不生成 DECODED 文件,则在 Wwise 设计工具中播放这些声音可能会导致播放过期内容或根本无法播放。建议在使用此选项后清空文件缓存。",
"synopsis": [
"--no-decode"
]
},
"no-source-control": {
"type": "boolean",
"description": "Skip the Source Control operations, even it is was enabled in the SoundBank Project Settings.",
"synopsis": [
"--no-source-control"
]
},
"use-user-overrides": {
"type": "boolean",
"description": "Use user overrides for Project Settings and SoundBank Settings.",
"synopsis": [
"--use-user-overrides"
]
},
"soundbank-path": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "不沿用为此平台指定的 SoundBank 路径。此选项后面必须紧跟平台标识符(见上文列表),再紧跟新路径(绝对或相对路径,如果路径中有空格,则要用引号括起来)。要想不沿用另一平台的路径,可重复添加 --soundbank-path 选项,并在其之后附加该平台的标识符及新的命令行。",
"synopsis": [
"--soundbank-path PLATFORM PATH",
"--soundbank-path PLATFORM1 PATH1 --soundbank-path PLATFORM2 PATH2 ..."
]
},
"audio-source-from-original": {
"type": "boolean",
"description": "在执行 Tab Delimited Import 时,工程内可能已经包含一些与所导入文件同名的音频源文件。在这种情况下,将使用已经存在的文件而非替换为制表符分隔文件描述的文件。",
"synopsis": [
"--audio-source-from-original"
]
},
"import-language": {
"type": "string",
"description": "允许通过 Tab Delimited Import 操作导入语音。此选项用于指定所导入语音的语言。此选项之后须附加 --language 选项所列语言标识符之一。Note that only audio files are added for this operation; any attempt to concurrently perform other operations, such as volume adjustments, is ignored.",
"synopsis": [
"--import-language LANGUAGE"
]
},
"tab-delimited-operation": {
"type": "string",
"enum": [
"createNew",
"useExisting",
"replaceExisting"
],
"description": "决定如何在导入时创建各个对象。createNew:创建新的对象;在可能的情况下赋予对象以所需名称,否则使用新的不重名的名称。useExisting:使用现有对象(如有),并更新指定的属性;否则,创建新的对象。该项为默认值。\"replaceExisting\":创建新的对象;若存在同名的现有对象,则将现有对象销毁。",
"synopsis": [
"--tab-delimited-operation createNew",
"--tab-delimited-operation useExisting",
"--tab-delimited-operation replaceExisting"
]
},
"tab-delimited-import-file": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "所要导入的制表符分隔文件。可在此选项之后指定多个所要导入的文件。",
"synopsis": [
"--tab-delimited-import-file FILE",
"--tab-delimited-import-file FILE1 FILE2 ...",
"--tab-delimited-import-file FILE1 --tab-delimited-import-file FILE2 ..."
]
},
"source-file": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies the WSOURCES files to use for external source conversion. 这些 WSOURCES 文件将用于所有平台。",
"synopsis": [
"--source-file FILE",
"--source-file FILE1 FILE2 ..."
]
},
"source-by-platform": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "Specifies the WSOURCES files to use by platform for external source conversion. 在针对特定平台进行指定时,会覆盖工程设置设定用于该平台的 WSOURCES 文件。对于未作相应指定的平台,将沿用工程设置所作设定。Specify the platform first, then the WSOURCES files to use for this platform. 可针对每个平台和 WSOURCES 文件重复该项操作。",
"synopsis": [
"--source-by-platform PLATFORM FILE",
"--source-by-platform PLATFORM1 FILE1 --source-by-platform PLATFORM2 FILE2 ..."
]
},
"output": {
"oneOf": [
{
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
]
},
{
"type": "string"
}
],
"description": "允许在此选项之后附加平台和输出路径,以此来覆盖该平台的输出路径,进而实施 External Source 转码。可针对其他平台重复添加此选项。If only a directory is specified, sources for all platforms are generated in that directory.",
"synopsis": [
"--output PLATFORM PATH",
"--output PLATFORM1 PATH1 --output PLATFORM2 PATH2 ...",
"--output PATH"
]
}
}
}

此页面对您是否有帮助?

需要技术支持?

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

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

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

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

开始 Wwise 之旅