バージョン
menu_open
Wwise SDK 2024.1.5
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. This option must be followed by the path (absolute or relative) in which the project level, platform agnostic files will be written. 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定義ファイルをインポートします。このオプションには、インポートされるバンク定義ファイルのフルパスが続けられる必要があります。複数ファイルの指定が可能です。オプション--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 Authoringで再生したときに、古い再生内容であったり、再生されなかったりする可能性があります。このオプション利用後、キャッシュをクリアすることを推奨します。",
"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": "タブ区切りインポートを行うときに、インポートしたオーディオソースファイルと同名のものが、プロジェクトに既に一部入っていることがあります。このオプションを追加することで、この操作で、タブ区切りファイルに記載されたものに置き換えないで、既にあるファイルを使います。",
"synopsis": [
"--audio-source-from-original"
]
},
"import-language": {
"type": "string",
"description": "タブ区切りインポート操作では、音声のインポートが可能です。このオプションは、インポートした音声のランゲージを指定するのに使います。このオプションのあとに、--languageオプションで指定したランゲージ識別子のうちの1つを続ける必要があります。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": "このオプションのあとに、プラットフォームと出力パスを続けることで、このプラットフォームの出力パスを、外部ソースコンバージョン用にオーバーライドすることができます。ほかのプラットフォームでも、このオプションを繰り返します。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からはじめよう