バージョン
menu_open
|
Wwise SDK 2019.1.11
|
コマンドラインを使う
SoundBank バンク生成を含め Wwise オペレーションの多くは、コマンドラインインターフェースから利用可能です。これは、オーディオアセットを使用したデイリーゲームのビルドなど、Wwise を自動化されたプロセスの一部として統合する場合などに便利です。
Wwise コマンドライン
Windows または Macのどちらを実行しているかによって、Wwise コマンドライン 実行可能ライン、WwiseCLI.exeを呼び出すには2つの方法があります。
- On Windows
- コマンドライン Wwise 実行可能ファイルは、WwiseCLI.exe という名前で、 "%WWISEROOT%\Authoring\x64\Release\bin" の下。コマンドラインパラメータは、
projectとoperationが必須であるこの構造に従う必要があります：
-
WwiseCLI.exe project.wproj -operation [-option1 [parameters]] [-option2 [parameters]] ...
- Mac
- Macでは、WwiseCLI.shシェルスクリプトを介して間接的にWwiseCLI.exeが呼び出されます。Macで WwiseCLI.sh シェルスクリプトを無事に実行できるようにするには、WwiseCLI.sh シェルスクリプトを実行したい各ユーザーはそれぞれ次のことを行います:
- Wwise.app を起動して、MS VC++ redistributableをインストールします。
- Wwise.appを終了します。
- これで、ターミナルに、UnixまたはWindows形式のパスを使った、Windows同等のコマンドライン引数を引き渡して、WwiseCLI.sh シェルスクリプトを起動することができます。
- Unix のパスの例: Windows のパスの例:MAC:~ username$ /Path/to/Authoring/Wwise.app/Contents/Tools/WwiseCLI.sh "/Volumes/Drive/Path/to/project.wproj" -operation [-option1 [parameters]] [-option2 [parameters]]MAC:~ username$ /Path/to/Authoring/Wwise.app/Contents/Tools/WwiseCLI.sh "Z:\Volumes\Drive\Path\to\project.wproj" -operation [-option1 [parameters]] [-option2 [parameters]]
スペースを含む文字列パラメータは、この 例 で示されているように引用符でラップされる必要があります。 すべてのパスパラメータは、バックスラッシュのみを使用して指定される必要があります。ただし、末尾のバックスラッシュは使用しません。
オペレーション
これらのオペレーションのうち1つをコマンドライン上で指定する必要があります。
| Operation | Description | Applicable Options | ||
|---|---|---|---|---|
| -ConvertExternalSources | External Sources（外部ソース）の変換。External Source は、 -GenerateSoundBanks でもトリガーされますが、Wwise Project に含まれていないソースを処理するために -ConvertExternalSources を使用することができます。このオペレーションには、オプションのパラメータが2つあります： プラットフォームと wsources ファイルへのパス。プラットフォームを提供すると、そのプラットフォームのみを生成します。wsources ファイルを提供すると、特定のプラットフォーム（またはプラットフォームが指定されていない場合はすべてのプラットフォーム）の Project Settings 内の External Source Input ファイルパスをオーバーライドします。この操作は、 -Save オプションと互換性がありません。例：
|
|||
| -CreateNewProject | 新規プロジェクトを作成。このプロジェクトは既に存在していてはなりません。このフォルダは、wprojファイルと同じ名前である必要があります。フォルダーが存在しない場合には、作成されます。-必ずPlatformを使い、プロジェクトに使うプラットフォームを1つ以上定義します。複数のプラットフォームを定義することができます。 |
|||
| -LoadProject | プロジェクトをロードします。その他の動作は一切実行せず、プロジェクトをロードしたあとは、単純にエグジットするだけです。 -Save と合わせて使い、移行やプロジェクト保存ができます。 |
|||
| -GenerateSoundBanks | SoundBank 生成。SoundBank 生成は、プロジェクトに保存された設定に従って実行されます；SoundBank 生成がコマンドラインから起動された場合には、カスタムユーザー設定は無視されます。ただし、これらの設定の一部はコマンドラインからオーバーライド可能です。
|
|||
| -SoundFrameServer | Sound Frameライブラリを使うクライアントアプリケーションが接続できる、コマンドラインのSoundFrameサーバーをスタートさせます。このオプションへのパラメータとして任意の数字による Process ID を指定し、このサーバーが特定のプロセスとの接続のみを受け入れるようにすることができます。サーバーは、CTRL-C 信号を受信するまで実行されます。 | |||
| -TabDelimitedImport | タブ区切りファイルをインポートして、さまざまなオブジェクト階層を作成および変更します。オプション -Save が指定されていない場合には、タブ区切りファイルインポートの結果としてプロジェクトに加えられた変更は永続化されません。 |
|||
| -Waapi | Wwise Authoring APIを使うクライアントアプリケーションが接続できる、コマンドラインのWwise Authoring APIサーバーをスタートさせます。
|
オプション
どのオプションも、適用できる オペレーション が制限されています。無効オプションは無視されます。
-
-AbortOnLoadIssues:たとえば、プロジェクトの読み込みに問題がある場合、
-GenerateSoundBanksなどの元のコマンドをアボートさせます。ログをとったプロジェクトの読み込みの問題は、すべて画面に表示されます。 - -AudioSourceFromOriginal：プロジェクトには、インポートされたものと同じ名前の audio source files が既に含まれている可能性があります。この場合、このフラグを追加することで、タブで区切られたファイルで記述されたものと置き換える代わりに、それらを使用します。
- -Bank:どのSoundBanksが生成されるかを指定します。 このオプションは、生成するSoundBankの名前に従ってください。複数SoundBankの指定が可能です。SoundBankを指定しないと、すべてのSoundBankが生成されます。または、SoundBank名のリストが入ったテキストファイルを指定するには、拡張子.txtを含むテキストファイルのフルパスを使用することもできる。
- -Cache:プロジェクトのキャッシュフォルダをオーバーライドして、代わりにこのコマンドで指定したパスを使用します。
-
-Cache:プロジェクトのキャッシュフォルダをオーバーライドして、代わりにこのコマンドで指定したパスを使用します。このオプションは、
-GenerateSoundBanksフラグが指定されていないと無視されます。-Platform引数に関わらず、すべてのプラットフォームでキャッシュ全体がクリアされることに注意してください。 -
-ContinueOnError:定義ファイルのインポート中にエラーが発生してもエラー時継続をする場合はこのフラグを使用してください。
- -CustomGlobalClosingCmd:Wwise で定義されたグローバルクロージングステップをオーバーライド。このオプションには、新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。コマンドラインに指定された空の文字列("")は、グローバルクロージングステップが実行されないことを意味します。
- -CustomGlobalOpeningCmd:Wwise で定義されたグローバルオープニングステップをオーバーライドします。このオプションには、新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。コマンドラインに指定された空の文字列("")は、グローバルオープニングステップが実行されないことを意味します。
- -CustomPostGenCmd:Wwise で該当プラットフォーム向けに定義されたカスタムポスト生成ステップコマンドラインをオーバーライド。このオプションには、（上記の）プラットフォーム識別子が続けられる必要があり、その後に新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。別のプラットフォームのカスタムポスト生成ステップコマンドラインをオーバーライドする場合は、 -CustomPostGenCmd フラグを繰り返し、その後に別のプラットフォーム識別子とそれの新しいコマンドラインを続けます。コマンドラインに指定された空の文字列("")は、ポスト生成ステップが実行されないことを意味します。
- -CustomPreGenCmd:Wwise で該当プラットフォーム向けに定義されたカスタムプレ生成ステップコマンドラインをオーバーライド。このオプションには、（上記の）プラットフォーム識別子が続けられる必要があり、その後に新しいコマンドラインが続けられる必要があります（スペースがある場合は引用符を使用）。別のプラットフォームのカスタムプレ生成ステップコマンドラインをオーバーライドする場合は、 -CustomPreGenCmdフラグを繰り返し、その後に別のプラットフォーム識別子とそれの新しいコマンドラインを続けます。コマンドラインに指定された空の文字列("")は、ポスト生成ステップが実行されないことを意味します。
-
-ExternalSourcesOutput:変換された外部ソースファイルに対して Project Settings で設定された出力パスをオーバーライド。このオプションには、プラットフォーム（任意）とパス（必ず相対パスとする）の2つのパラメータがあります。このオプションは、
-ConvertExternalSourcesとの組み合わせでのみ有効です。
-
-HeaderFile:Project Settings でこのオプションが指定されていない場合でもヘッダファイル Wwise_IDs.h を生成。このオプションは、
-GenerateSoundBanksフラグが指定されていないと無視されます。 - -HeaderFilePath:Project Settings で指定されているヘッダファイルパスをオーバーライド。このオプションには、ヘッダファイル（Wwise_IDs.h）が記述される（絶対または相対）パスが続けられる必要があります。これは、ヘッダファイルの作成が必要な場合にのみ有効です。
-
-ImportDefinitionFile:定義ファイルをインポート。このオプションには、インポートされるバンク定義ファイルのフルパスが続けられる必要があります。複数ファイルの指定が可能です。オプション
-Saveが指定されていない場合には、定義ファイルインポートの結果としてプロジェクトに加えられた変更は永続化されません。 -
-ImportLanguage：タブ区切りのインポート操作では、音声インポートを行うことができます。このフラグは、インポートされたボイスの言語を指定するために使用します。このオプションの後には
-Languageフラグにリストされた言語識別子のいずれかを続ける必要があります。なお、このオペレーションでオーディオファイルが追加されるだけで、同時にボリューム調整などほかのオペレーションを実行しようとしても、無視されます。
警告: -ImportLanguageフラグを省略すると、インポート操作ではすべての audio source files が音声ではなくSFXとして扱われます。 -
-Language:どの言語向けに SoundBank が生成されるかを指定します。このオプションの後には、プロジェクトで定義された言語識別子が必要です。指定の各言語には、このフラグが先頭に付けられていなければなりません。このオプションは、
-GenerateSoundBanksフラグが指定されていないと無視されます。 -
-NoDecode:.cache フォルダに DECODED ファイルを生成するのを避けてください。このフォルダはWwiseプロジェクトのためのCPUとディスクスペースを節約します。これはまた、SoundBank の生成時間を短縮します。
警告: DECODED ファイルを生成しない場合、これらのサウンドをWwise Authoring で生成すると再生しないか、最新の再生でない結果となることに注意してください。このオプション利用後、キャッシュをクリアすることを推奨します。 -
-NoWwiseDat:オーディオファイル変換時の 'wwise.dat' 隠しファイルの使用を無効化。これは、Wwise の複数のインスタンスが競合することなく同時に同じディレクトリへ変換されることを可能にするため、ファイル依存関係を処理するビルドツールから WwiseCLI を呼び出す時に
-ConvertExternalSourcesと組みあせて使用すると便利です。
-
-Platform:どのプラットフォーム向けに SoundBank が生成されるかを指定。このオプションの後には、プラットフォーム識別子を続ける必要があります（以下に掲載）。指定の各プラットフォームには、このフラグが先頭に付けられていなければなりません。
- Android
- iOS
- Mac
- PS4
- Windows
- XboxOne
- -Quiet:すべての non-error コンソールテキスト出力を無効にします。
-
-Save:Wwise プロジェクトの保存を有効化。
-ImportDefinitionFileまたは-TabDelimitedImportと一緒に使用すると、バンクインポートのプロセスより生じたプロジェクトへの変更がワークユニットへ保存されます。保存を有効にすると、コマンドラインからの展開のためのプロジェクト移行が可能になります。ユーザーはプロジェクトを保存する時にプロジェクトのファイルが "read only（読み取り専用）" ではないことを確認、つまり、コマンドラインリクエストの実行前に、ソース管理からの任意の "check-out" を実行する責任があることに注意してください。 -
-SoundBankPath:該当プラットフォーム用に指定された SoundBank パスをオーバーライド。このオプションには、（上記の）プラットフォーム識別子が続けられる必要があり、その後に新しいパスが続けられる必要があります（絶対または相対、スペースがある場合は引用符を使用）。別のプラットフォームのパスをオーバーライドする場合は、
-SoundBankPathフラグを繰り返し、その後に別のプラットフォーム識別子とそれの新しいパスを続けます。 -
-TabDelimitedOperation：インポートオブジェクトの作成方法を指定します。作成された各オブジェクトについて：
-
CreateNew新しいオブジェクトを作成します。 可能であれば、オブジェクトには希望の名前が与えられます。そうでない場合は、新しい固有の名前が使用されます。 -
UseExistingオブジェクトが存在する場合はそれを使用し、指定されたプロパティを更新します。 それ以外の場合は、新しいオブジェクトが作成されます。 -
ReplaceExistingオブジェクトが存在する場合はそれを使用し、指定されたプロパティを更新します。 それ以外の場合は、新しいオブジェクトが作成されます。
注釈: -TabDelimitedOperationフラグが省略されると、インポート操作はデフォルトでUseExistingになります。.
-
- -Verbose:追加コンソールのテキストアウトプットを可能にする。
-
-WaapiAllowedAddr:WAAPIへの接続が許可されるIP（IPv4またはIPv6）アドレスを指定します。このオプションの後には、カンマで区切ったリスト（たとえば、127.0.0.1,::1）が必要です。どのホストでも接続していい場合は、*を使用します。
注意: *を使用するとセキュリティ・リスクが発生する可能性があります。 安全にWAAPIを使用する方法の詳細については、ネットワーク・セキュリティ を参照してください。 -
-WaapiAllowedOrigin：WAAPIへの接続が許可されているホストを指定します。このオプションの後には、カンマで区切ったリスト（たとえば、www.myhost.com,www.myhost2.com）が必要です。 検証はHTTPヘッダーOriginで実行されます。Originヘッダーのない接続や、ファイルベースの接続（例えば file://）は、常に許可します。どのホストでも接続していい場合は、*を使用します。
注意: *を使用するとセキュリティ・リスクが発生する可能性があります。 安全にWAAPIを使用する方法の詳細については、ネットワーク・セキュリティ を参照してください。 - -WaapiHttpPort：HTTP POSTを使用する際にWwise Authoring APIが使用するポート番号を指定します。このオプションの後には、0と65,535の間のポート番号が必要です。０を使用すると、サーバーが実行されなくなります。
- -WaapiWampPort：WAMPを使用する際にWwise Authoring APIが使用するポート番号を指定します。This option, which takes precedence over the User Preferences, must be followed by a port number between 0 and 65,535.
このオプションは、User Preferencesよりも優先され、ポート番号は0〜65,535の間でなければなりません。
０を使用すると、サーバーが実行されなくなります。
例
コマンドラインからの SoundBank 生成例を以下に示します。例では、英語（米国）と フランス語（カナダ）の Windows プラットフォーム用 SoundBank が生成されます。また、特定のポスト生成コマンドも定義されており、これによりプロジェクト設定とユーザー設定で定義されているポスト生成ステップがオーバーライドされます。
"%WWISEROOT%\Authoring\x64\Release\bin\WwiseCLI.exe" "C:\Project name.wproj" -GenerateSoundBanks -Language English(US) -Language French(Canada) -Platform Windows
-Bank BankLevel1 -Bank BankLevel2 -ImportDefinitionFile "C:\BankDefinitionFile\MyProjectDefinition.txt"
-CustomPostGenCmd Windows "\"$(WwiseExePath)\tools\FilePackager.Console.exe\" -generate -info \"$(InfoFilePath)\" -output \"$(SoundBankPath)\$(WwiseProjectName).pck\" -blocksize 16 -hideprogressui true"
外部ソース変換例
以下、コマンドラインから外部ソースを変換する例です。変換は Xbox One に対してのみ行われます。
"%WWISEROOT%\Authoring\x64\Release\bin\WwiseCLI.exe" "C:\Project name.wproj" -ConvertExternalSources XboxOne
新規プロジェクト作成例
以下は、WindowsやMacのプラットフォームで、新規Wwiseプロジェクトをコマンドラインから作成する例です。なお、既にWwiseプロジェクトフォルダが存在していてはいけません。
プロジェクト移行の例
以下は、Wwiseプロジェクトをコマンドラインから移行する例です。
"%WWISEROOT%\Authoring\x64\Release\bin\WwiseCLI.exe" "C:\ProjectName\ProjectName.wproj" -LoadProject -Save
タブ区切りのインポートの例
これは、アメリカ英語の声を含むオブジェクト階層を記述するタブ区切りのファイルをインポートする例です。すでに存在するオブジェクトを置き換えますが、元のオーディオソースファイルを使用します。
"%WWISEROOT%\Authoring\x64\Release\bin\WwiseCLI.exe" "C:\Project name.wproj" -TabDelimitedImport "C:\tab delimited file.txt" -TabDelimitedOperation ReplaceExisting -ImportLanguage English(US) -AudioSourceFromOriginal
エラーコード
コマンドラインから操作すると、WwiseCLI.exe は以下の戻りコードのいずれかを返します：
- WWISE_ERROR_CODE_SUCCESS 0
- WWISE_ERROR_CODE_ERROR 1 （Fatal Error（致命的なエラー） または Error （エラー）が発生した場合）
- WWISE_ERROR_CODE_WARNING 2 （Warnings （警告）が発生した場合）
警告が発生してもSoundBankは適切に生成される可能性がありますが、これらの警告をエラーとして考慮することを強くお勧めします。たとえば、ソースファイルが欠落していると、WwiseCLI.exe はエラーコードを返します。欠落ソースファイルはSoundBankの生成を妨げませんが、生成される SoundBank が不完全である可能性があります。
Wwise の Project Settings > Logs で、Soundbank 生成中に発生するほとんどのメッセージの重大度を変更することができます。メッセージの重大度を変更すると、戻りコードに影響が与えられます。
エラー追跡
コマンドラインアプリケーションから作業する場合、すべてのエラーは stdout を使用してレポートされます。
コマンドラインから Wwise Authoring ツール
Wwiseコマンドラインインターフェース（WwiseCLI.exe）のほかに、ユーザーは、Wwise.exeを使いコマンドラインからWwise Authoringツールを呼び出すことができます。これには、3つのオプションがあります:
- -AutomationMode: WwiseのAutomationモードを有効にします。メッセージボックスやダイアログに起因する、中断の可能性を減らします。例えば、Automationモードを有効にすると、プロジェクトマイグレーション、プロジェクトロードログ、EULAアクセプタンス、プロジェクトライセンス表示、そして一般的なメッセージボックスを、そのまま受け入れます。
- -SetTitleBarText:メインWwise Authoringウィンドウのタイトルバーに追加するテキストのラインを指定します。このオプションは追加するテキストを続ける必要があります。テキストにスペースがある場合、引用符で囲む必要があります。
- -ShowNewProject：Wwise Authoringツールを起動すると、New Projectウィンドウが開きます。