|
Wwise SDK 2023.1.7
|
SoundBankの生成。SoundBank生成を、プロジェクトに保存された設定に従い実行します。User SoundBanks Settings are normally ignored when SoundBank generation is launched from the command line. However, when using the Source Control for generated SoundBanks, the User Project Settings are loaded for the Source Control settings. Also, some of these settings can be overridden from the command line.
WwiseConsole generate-soundbank "C:\MyProject\MyProject.wproj" --platform "Windows" "Linux" --language "English(US)"
WindowsとLinuxのプラットフォーム向けに、MyProject.wprojの全SoundBankを、ランゲージにEnglish(US) を使い、生成します。
PROJECT
プロジェクトファイル（.wproj）へのパス。
--abort-on-load-issues
プロジェクトをロードする際に問題を検知すると、操作を中断します。プロジェクトで記録されたロード問題は、すべて画面に表示されます。
--audio-source-from-original
タブ区切りインポートを行うときに、インポートしたオーディオソースファイルと同名のものが、プロジェクトに既に一部入っていることがあります。このオプションを追加することで、この操作で、タブ区切りファイルに記載されたものに置き換えないで、既にあるファイルを使います。
--bank SOUNDBANK
--bank SOUNDBANK1 SOUNDBANK2 ...
--bank FILE
生成するSoundBankを指定します。必ずこのオプションのあとに、生成するSoundBankの名前を入れます。複数SoundBankの指定が可能です。SoundBankを指定しない場合は、全SoundBankが生成されます。なお、複数のSoundBank名を一覧にしたテキストファイルを指定するには、テキストファイルの拡張子'.txt'を含むこのテキストファイルのフルパスを指定します。
--cache PATH
Overrides the project's cache directory path and instead uses the (relative) path specified in the command.
--clear-audio-file-cache
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オプションの設定に関わらず、全プラットフォームのキャッシュ全体が削除されるので、注意してください。
--continue-on-error
エラーが発生しても継続する場合は、このオプションを使います。
--custom-global-closing-cmd CMD
Wwise で定義されたグローバルクロージングステップをオーバーライド。このオプションには、新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。コマンドラインに空の文字列（""）を指定すると、グローバルクロージングステップを実行しません。
--custom-global-opening-cmd CMD
Wwiseで定義したグローバルオープニングステップをオーバーライドします。このオプションには、新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。コマンドラインに空の文字列（""）を指定すると、グローバルオープニングステップが実行されません。
--custom-post-gen-cmd PLATFORM CMD
--custom-post-gen-cmd PLATFORM1 CMD1 --custom-post-gen-cmd PLATFORM2 CMD2 ...
このプラットフォームにWwiseで定義した、カスタム設定のポストジェネレーションステップのコマンドラインを、オーバーライドします。このオプションには、（上記の）プラットフォーム識別子が続けられる必要があり、その後に新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。別のプラットフォームでカスタム設定したポストジェネレーションステップのコマンドラインをオーバーライドするには、オプション–custom-post-gen-cmdを繰り返し、そのあとに別のプラットフォームの識別子と、その新しいコマンドラインを続けます。コマンドラインに空の文字列（""）を指定すると、ポストジェネレーションステップが実行されません。
--custom-pre-gen-cmd PLATFORM CMD
--custom-pre-gen-cmd PLATFORM1 CMD1 --custom-pre-gen-cmd PLATFORM2 CMD2 ...
このプラットフォームにWwiseで定義した、カスタム設定のプリジェネレーションステップのコマンドライドを、オーバーライドします。このオプションには、（上記の）プラットフォーム識別子が続けられる必要があり、その後に新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。別のプラットフォームでカスタム設定したプリジェネレーションステップのコマンドラインをオーバーライドするには、オプション–custom-pre-gen-cmdを繰り返し、そのあとに別のプラットフォームの識別子と、その新しいコマンドラインを続けます。コマンドラインに空の文字列（""）を指定すると、プリジェネレーションステップを実行しません。
--header-file
プロジェクト設定でこのオプションを指定していなくても、ヘッダファイルWwise_IDs.hを生成します。
--header-file-path
(DEPRECATED) Use root-output-path instead. プロジェクト設定で指定したヘッダファイルパスをオーバーライドします。このオプションには、ヘッダファイル（Wwise_IDs.h）が記述される（絶対または相対）パスが続けられる必要があります。これは、ヘッダファイルの作成が要求されている場合に限り有効です。
--import-definition-file FILE
--import-definition-file FILE1 FILE2 ...
--import-definition-file FILE1 --import-definition-file FILE2 ...
SoundBank定義ファイルをインポートします。このオプションには、インポートされるバンク定義ファイルのフルパスが続けられる必要があります。複数ファイルの指定が可能です。オプション–saveを指定しなければ、インポートした定義ファイルによってプロジェクトに加えられた変更点は、永続しません。
--import-language LANGUAGE
タブ区切りインポート操作では、音声のインポートが可能です。このオプションは、インポートした音声のランゲージを指定するのに使います。このオプションのあとに、–languageオプションで指定したランゲージ識別子のうちの1つを続ける必要があります。なお、この操作はオーディオファイルを追加するだけで、ボリューム調整などほかの操作を同時に実行しようとしても、無視されます。
--language LANGUAGE
--language LANGUAGE1 --language LANGUAGE2 ...
どのランゲージのSoundBankを生成するのかを指定します。このオプションの後には、プロジェクトで定義された言語識別子が必要です。必ずこのオプションを、指定するランゲージのプレフィックスにします。
--license LICENSE
使用するライセンスを設定します。ライセンスは、プロジェクトに保存されません。
--no-decode
Avoids generating DECODED files in the .cache directory, which saves CPU and disk space for your Wwise project. また、SoundBankの生成時間も短縮できます。警告: DECODEDファイルを生成しないと、これらのサウンドをWwise Authoringで再生したときに、古い再生内容であったり、再生されなかったりする可能性があります。このオプションを使用したあとは、ファイルキャッシュをクリアすることが推奨されます。
--no-source-control
Skip the Source Control operations, even it is was enabled in the SoundBank Project Settings.
--no-wwise-dat
オーディオファイルの変換時に隠れた 'wwise.dat' ファイルへの書き込みを、無効にします。ファイルの依存関係にすでに対応できるビルドツールからコールするときは、コンフリクトなしで複数のWwiseインスタンスを、同時に同じディレクトリへ変換できるので、便利です。なお、このオプションは、既存の隠れた 'wwise.dat' ファイルの読み込みを防止するものではありません。
--output PLATFORM PATH
--output PLATFORM1 PATH1 --output PLATFORM2 PATH2 ...
--output PATH
このオプションのあとに、プラットフォームと出力パスを続けることで、このプラットフォームの出力パスを、外部ソースコンバージョン用にオーバーライドすることができます。ほかのプラットフォームでも、このオプションを繰り返します。If only a directory is specified, sources for all platforms are generated in that directory.
--platform PLATFORM
--platform PLATFORM1 PLATFORM2 ...
--platform PLATFORM1 --platform PLATFORM2 ...
SoundBankを生成するプラットフォームを指定します。このオプションのあとに、プラットフォーム識別子を続ける必要があります。
--quiet
エラー以外のコンソールテキスト出力を無効にします。
--readable-soundbanks
プロジェクト設定でこれを指定していなくても、読み取り可能なSoundBank（.rbnk）を生成します。
--root-output-path
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).
--save
SoundBank生成前に、プロジェクトを保存します。tab-delimited-import-file（タブ区切りインポートファイル）が提供されていた場合は、インポートした内容も保存されます。プロジェクトを保存するときに、必要であれば、まず暗黙的にプロジェクトが移行されます。
--skip-languages
プロジェクト内に、ローカライズされたSoundBankを生成しません。
--soundbank-path PLATFORM PATH
--soundbank-path PLATFORM1 PATH1 --soundbank-path PLATFORM2 PATH2 ...
このプラットフォームに指定したSoundBankパスをオーバーライドします。このオプションには、（上記の）プラットフォーム識別子が続けられる必要があり、その後に新しいパスが続けられる必要があります（絶対または相対、スペースがある場合は引用符を使用）。別のプラットフォームのパスをオーバーライドするには、オプション–soundbank-pathを繰り返し、そのあとに別のプラットフォームの識別子と、その新しいパスを続けます。
--source-by-platform PLATFORM FILE
--source-by-platform PLATFORM1 FILE1 --source-by-platform PLATFORM2 FILE2 ...
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ファイルで繰り返します。
--source-file FILE
--source-file FILE1 FILE2 ...
Specifies the WSOURCES files to use for external source conversion. このWSOURCESファイルを、全プラットフォームで使用します。
--tab-delimited-import-file FILE
--tab-delimited-import-file FILE1 FILE2 ...
--tab-delimited-import-file FILE1 --tab-delimited-import-file FILE2 ...
インポートするタブ区切りファイル。このオプションのあとに、インポートする複数のファイルを指定できます。
--tab-delimited-operation createNew
--tab-delimited-operation useExisting
--tab-delimited-operation replaceExisting
インポートしたオブジェクトの作成方法を、作成するオブジェクトごとに決めます。"createNew": 新しいオブジェクトを作成し、オブジェクト名は可能であれば希望する名前とし、それ以外の場合は新しい固有名を使います。"useExisting": 既存のオブジェクトがあればそれを使い指定したプロパティを更新し、なければ新しいオブジェクトを作成します。これがデフォルト値です。"replaceExisting": 新しいオブジェクトを作成し、同名の既存オブジェクトがある場合は、既存オブジェクトを破棄します。
可能な値:
--use-stable-guid
Give the SoundBank a stable GUID across multiple builds if you don't want to save the project.
--use-user-overrides
Use user overrides for Project Settings and SoundBank Settings.
--verbose
追加のコンソールテキスト出力を有効にします。
SoundBank生成処理のexit code。Although your SoundBanks might generate properly with warnings, it is strongly recommended that you consider these warnings as errors. 例えばWwiseConsole.exeは、ソースファイルが不足するとエラーコードを返します。Although a missing source file does not prevent your SoundBanks from being generated, the resulting SoundBanks might potentially be incomplete. SoundBank Generationの最中に表示されるほとんどのメッセージは、重大度をWwiseのProject Settings > Logsで変更できます。メッセージの重大度を変更すると、リターンコードに影響します。
WwiseConsole.exeのexit codeの意味は、0は成功、1は1つ以上のエラー発生（警告があることも）、2は警告だけです。
Wwise Consoleの詳細は、 コマンドラインを使う を参照してください。