Wwise 2022.1 Unrealインテグレーションについて

このバージョンはWwise Unrealインテグレーションの大きな節目となります。Unreal Engine 5がエンジンを新たな領域へと導いたように、AudiokineticのWwise Unrealインテグレーションはこれら2つのツールの連携による可能性をさらに広げます。 変更の内容は1年以上にわたる懸命な開発作業と、WwiseとUnrealの組み合わせの限界を超えようとするデベロッパーたちを交えた多くの議論を元に発展しました。長年の最適化の積み重ねや機能要求を通して多くの教訓を得てきました。例えば、当初はすべてのワークフローに対応したいと考えていましたが、ゲームにはそれぞれ前提条件があり、カスタマイズせずにすべての素晴らしい使い方を実現するのは夢のまた夢です。わたしたちはWwiseを使う上での喜びや困難、不満などを教えてくださったユーザのみなさまに大変感謝しております。このようにして最終的に優先順位を決定することができました。

クイックスタート

Wwise 2022.1に移行する

移行プロセスをはじめる前に、WwiseやUnrealのプロジェクトで変更する必要のあるファイルを、すべて変更できることを確認します。

以下のファイルを、バージョンコントロールからチェックアウトする必要があります:

• Wwiseプロジェクトディレクトリ全体
• すべてのUnreal Wwiseアセット（イベント、サウンドバンク、AUXバス等）
• Unrealプロジェクトの以下の設定ファイル:
  • DefaultGame.ini
  • DefaultUser.ini

AkAudioBankアセットを参照しているマップやブループリントは、移行処理中に削除されるため、これらもチェックアウトする必要があるかもしれません。

通常通り、マイグレーションはAudiokinetic LauncherのUnreal Engineページから、Wwise Unrealインテグレーションをアップグレードすることからはじめます。

アップグレード完了後にWwise Projectを開き、"Project Migration"ダイアログを表示させます。

Update ボタンをクリックして続けます。

Wwiseプロジェクトを更新して保存した後に、Unrealプロジェクトを開きます。プロジェクトを開くとWwise Integration Migrationダイアログが表示されます。このダイアログ内で、実行する移行操作を選択できます。すべての移行操作をすぐに実行することを推奨しますが、必要に応じて移行処理を延期させることや、操作を個別に実行することが可能です。移行操作を個別に実行する場合は、プロジェクトの移行前に 部分的な移行、プロジェクト移行状況 セクションをお読みになることをおすすめします。複数の移行操作を選択した場合は、Migrationウィンドウに表示された順序で実行されます。移行ダイアログはすべての移行操作が完了するまで Audiokinetic Migration > Finish Project Migration の下のBuild Menuからアクセスすることができます。

主な移行の操作は以下の4つです:

• サウンドバンクの移行
• Delete deprecated assets
• Migrate Wwise Assets
• Update Project Settings

サウンドバンクの移行

サウンドバンク管理がWwise Authoringに再度戻されるため、AkAudioBankアセットは不要となり削除する必要があります。これまでのワークフローではサウンドバンクは手動で作成されたAkAudioBankとしてUnreal Projectで表されていました。イベントやAUXバスのアセットは手動でこれらのサウンドバンクにまとめられました。これはLegacyワークフローでは必要でしたが、Event Based Packagingでは不要でした。

UnrealプロジェクトにAkAudioBankアセットが含まれているかによって、以下のセクションがダイアログに表示されます。Wwise 2022.1では、この移行操作で既存サウンドバンクをUnrealプロジェクトからWwiseプロジェクトへ戻し、非推奨となったAkAudioBankアセットをクリーンアップすることができます。

転送方式

Wwiseにサウンドバンクを転送するためにはSoundBank Definition Fileを作成するか、WAAPIを使用します。

Create SoundBank Definition File でサウンドバンクの名前とコンテンツのリストを含むテキストファイルが作成されるため、これをWwiseにインポートすることができます。このオプションを選択した場合は、生成されたファイルの保存先を選択するフィールドが表示されます。このファイルをWwiseプロジェクトにインポートする具体的な方法については 公式ドキュメントを参照してください。

WAAPI はUnreal EditorとWwise Authoringの間に確立されたWAAPI接続を利用し、サウンドバンクを含むようにWwise Projectを更新します。サウンドバンクの転送後に必ずWwiseプロジェクトを保存してください。

これを利用するためにはWwise Authoringが開いている必要があります。WAAPI接続を確立できない場合はWwise User Settingsの“Auto Connect to WAAPI”プロジェクト設定が無効である可能性があります。

サウンドバンクの転送失敗

WAAPIでサウンドバンクをWwiseへ転送することが一部失敗した場合や、サウンドバンクの定義ファイルへの書き込みが失敗した場合は、エラー一覧を示すダイアログが表示されます。このダイアログで移行をキャンセルすることや、エラーを無視して次にすすむことができます。エラーは許容できるものや予想されるものもあります。例えば、Wwiseプロジェクトから削除したイベントがUnrealプロジェクトにアセットとして残っている場合は、それらのイベントに関係するWAAPIコールが失敗します。

Delete deprecated assets

前のインテグレーションバージョンで使用されていたWwiseアセットタイプの一部が非推奨となったため、プロジェクトから削除する必要があります。 Delete Deprecated Assets オプションを選択することでアセットタイプがAkMediaAsset、AkFolder、またはAkPlatformAssetDataであるアセットはすべて削除されます。

Migrate Wwise Assets

Wwiseアセットプロパティが変更されたためサウンドバンクやメディアバイナリデータのシリアライズが行われなくなりました。Wwiseアセットにシリアライズされる情報は、アセットをロードまたはクックする時に使用されるGUID、ShortID、Name、およびタイプ固有のメタデータプロパティのみとなりました。リソースをロードするために必要な情報が、ゲームにパッケージされるアセットに対しクック中にシリアライズされます。

Migrate Wwise assets を選択することでプロジェクト内のすべてのWwiseアセットがダーティとしてマークされ、保存されます。以前にEBPを使用してSplit Switch Container Mediaを有効にしてあった場合は、すべてのイベントで保存前にEventInfo.SwitchContainerLoadingフラグがLoadOnReferenceに設定されます。

Update Project Settings

Update Project Settings を選択することで、Event-Based Packagingを使用していたのか、あるいはLegacyワークフローを使用していたのかに基づき、プロジェクト設定が更新されます。変更が行われた後は必ずプロジェクトを保存してください。

Event-Based Packaging:

• Wwiseでは以下の通りとなります:
  • Enable Auto Defined Soundbanks が有効になります。
  • Create Sub-Folders for Generated Files は、 Split Media Per Folder が有効であった場合は有効になります。
• Unrealでは以下の通りとなります:
  • Wwise Sound Data Folder が Directories To Always Cook から削除されます。

Legacy: Wwiseプロジェクトで変更される設定はありません。

• Unrealでは以下の通りとなります:
  • Wwise Sound Data Folder が Directories To Always Stage As UFS から削除されます。
  • Wwise Sound Data Folder 内に生成された.bnkファイルと.wemファイルが削除されます。

どちらのケースでも以下の通りとなります:

• GeneratedSoundBanks folder location フィールドに設定するパスが、UnrealプロジェクトのWwise Settingsの Generated Sound Banks Folder 設定に適用されます。このフィールドのデフォルトは、Unrealプロジェクトで設定した現在の GeneratedSoundBanks Folder パスです。あなたのプロジェクトで特別な要件がない限り、標準の <Wwise Project\/GeneratedSoundBanks パスを使用することを推奨します。

プロジェクトに外部ソースを使用しない限り、移行ダイアログのすべての操作を完了した時点でプロジェクトの準備が完了し、外部ソースを使用する場合は追加の移行ステップが必要です。

プロジェクト移行のコマンドレット

このインテグレーションは前セクションに記載された移行操作をコマンドラインから実行するためのコマンドレット（ Using the Project Migration Commandlet ）も提供しています。

手動で更新する必要のある設定

Wwise Installation Path （Unrealで） あなたのマシンにWwiseをインストールしてあり、WAAPIを使用せずにUnreal上でサウンドバンクを生成したい場合は、Wwise User SettingsのWwise Mac/Windows Installation Pathを設定する必要があります。

SoundBanks Root Output Path （Wwiseで） WwiseオーサリングのSoundBanks Settingsの Root Output Path が、Unreal Wwise Settingsの Generated Sound Banks Folder で設定したパスと対応していることを確認することを推奨します。

移行したレガシープロジェクトでは、プラットフォームごとのサウンドバンクフォルダ設定がUnrealプロジェクトの Content フォルダ内の場所を指していないことを確認してください。

外部ソースの移行

2022.1において、外部ソースに対するサポートの実装が大幅に変更されました。上級ユーザは外部ソースの設定とトラッキングのために独自システムを実装することが可能となりました。WwiseSimpleExternalSourceManagerを通した基本的なサポートも提供され、これは外部ソースメディアのトラッキングをUnreal Data Tableを使用して行い、外部ソースIDにメディアを割り当てるためのAPIやブループリント関数を提供します。

FAkExternalSourceInfo および FAkSDKExternalSourceArray 構造体は、このモジュールでは使用されなくなりました。ブループリントで作成されるFAkExternalSourceInfoの各インスタンスごとに、WwiseSimpleExternalSourceManager::SetExternalSourceMediaブループリントノードで置き換える必要があります。

その後、これらへのリファレンスをブループリント内からすべて削除できます。FAkSDKExternalSourceArraysにリンクするPostEventノードを含むブループリントの再コンパイルが必要である場合があります。

Wwise 2022.1における外部ソースの使用方法についての詳細は Using the Wwise Simple External Source Manager を参照してください。

部分的な移行、プロジェクト移行状況

すべての移行操作を同時に実行することを推奨します。個々の操作を別々に実行したり、一部の操作を手動で行う場合は、以下の点に注意してください:

• アセットを移行することでイベントやAUXバスアセットに含まれるサウンドバンクのグループ情報が消去されるため、それ以後、UnrealからWwiseへのサウンドバンクの移行は失敗します。AkAudioBankアセットの中でグループにまとめられていたイベントやAUXバスに、それらアセットの"AutoLoad"設定を転送することも不可能となります。
• 非推奨となったアセットやAkAudioBankアセットを削除する時に、削除するアセットを参照する（Wwise以外の）アセットがある場合は、それらも追加でチェックアウトする必要があります。

プロジェクトの移行状況を追跡するためには、主にDefaultGame.iniファイルの以下のフィールドを使用します:

• bSoundBanksTransfered: SoundBank Transfer操作が実行されたかどうかを追跡します。
• bAssetsMigrated: Asset Migration操作を実行したかどうかを追跡します。
• bProjectMigrated: Project Migration操作を実行したかどうかを追跡します。

該当する移行操作が成功したかどうかに基づき、移行処理中にこれらの設定が更新されます。

プロジェクトの移行状況はUnrealプロジェクトのコンテンツによっても変わります。プロジェクト内にAkAudioBankアセットがない場合はサウンドバンクの移行は不要であり、設定が自動的に更新されます。同様に非推奨アセットを削除するオプションが表示されるのは、プロジェクト内に非推奨アセットがある場合だけです。

移行の完了

移行が完了した後にWwiseサウンドバンクを再生成する必要があります。これはUnrealのWwise PickerやBuildメニューから行うか、Wwiseで直接（サウンドバンク管理がWwiseに戻されたため）行います。

サウンドバンク生成が成功した後はWwise Project構造をWwise Pickerで見ることが可能となり、Play In Editorでサウンドを聞くことができるようになるはずです。

Spatial Audio

ポータル

• AkPortalComponent 機能が更新され、OpenPortalやClosePortalへのコールがスタック（stack）しないようになりました。つまり、OpenPortalをコールするとすぐにこのポータルが開き、ClosePortalをコールするとすぐにポータルが閉じます。従来の機能では、ポータルを閉じるために、OpenPortalと同数のClosePortalのコールが必要でした。この機能に依存するコードがある場合は、更新してください。

AkGeometryコンポーネント

• AkGeometryComponent のデフォルトのMesh Typeは、あなたのマップへのコンポーネント追加を最適化するために、Simple Collisionに変更しました。 AkGeometryComponent をStatic Meshに設定していた場合は、Simple Collisionに変更されているため、22.1への更新後に再度設定する必要があります。

PreDelayの単位を秒からミリ秒に変更

• UnrealインテグレーションではこれまでPreDelayリバーブパラメータは秒単位で見積もられていました。しかしこの値がミリ秒単位で計算されるようになりました。ユーザはPreDelay値を受け取るRTPCの範囲がミリ秒単位となるように、RTPCを更新する必要があります。例えばPreDelayにマッピングされているRTPCの範囲がこれまで0.0～1.0（秒）であった場合は、範囲を0.0～1000.0（ミリ秒）に変更する必要があります。

CollisionChannelプロパティ

• AkSpatialAudioVolume と AkAcousticPortal の CollisionChannel プロパティの基本型と、 AkComponent の OcclusionCollisionChannel プロパティが変更されました。プロジェクトのデフォルトコリジョンチャンネルが変更された時に、既存のオブジェクトに何が起きるのかをより明確に示すために変更されました。これらのプロパティをBlueprintまたはC++を通して直接操作するようなコードがある場合は、型を更新して再コンパイルする必要があります。

複数のEventをSoundBankにまとめる

以前は複数のアセットを右クリックして Group into Sound Bank を選択することで、これらのイベントをクループにまとめることができました。これができなくなりましたが、代わりにWwiseオーサリングアプリケーションのUser-Defined SoundBanksを使用して同じ結果を得ることができます。