Spatial Audioオブジェクト
WAAPI Widgets
Event-Based Packagingで使うクラス

AkAudioEvent

Wwise イベントを表す Unreal オブジェクト。 アセットの同期 を使うと、アセットがSound Dataフォルダ内に自動的に作成されます。Automatic Asset Synchronizationを使わない場合は、AkAudioEventsをWwise Pickerから ドラッグ＆ドロップ して作成するか、Unreal Content Browserで右クリックして作成します。その名前は、Wwise プロジェクト内のイベント名と一致している必要があります。

• プロパティ
  
  • Required Bank（必要なバンク）：このイベントを、その構造およびメディアとともに格納するSoundBankを指定。
• Unreal Content Browserコンテキストメニューオプション
  • Play Event （イベント再生）：イベントをポストします。
  • Stop Event（イベント停止）：すべての再生中イベントを停止します。

AkAuxBus

Wwise AUXバス を表す Unreal オブジェクト。 アセットの同期 を使うと、アセットがSound Dataフォルダ内に自動的に作成されます。Automatic Asset Synchronizationを使わない場合は、AkAuxBussesをWwise Pickerから ドラッグ＆ドロップ して作成するか、Unreal Content Browserで右クリックして作成します。その名前は、Wwise プロジェクト内のAUXバス名と一致している必要があります。そうすることで、Unreal Editor内からSoundBankにプラグインメディアを追加できます。

• プロパティ
  
  • Required Bank（必要なバンク）：このAuxiliary Busと、それに関連するプラグインメディアを格納するSoundBankを指定。

AkAudioBank

Wwise SoundBank を表す Unreal オブジェクト。Unreal Content Browser 内での右クリックにより作成可能。Event-Basedワークフローを使うときは、メディアのないEventグループのようなはたらきをします。Event-Basedワークフローを使わないときは、これがSoundBankを作成する唯一の方法です。

• プロパティ
  
  • Auto Load: 有効にすると、SoundBankと、それを参照するEventやAuxiliary Busを、自動的にロード・アンロードします。注: このフラグは、Event-Basedワークフローを使わないときに限り、使用されます。
• Unreal Content Browserコンテキストメニューオプション
  • Generate Selected SoundBank(s)...（SoundBanks を生成する...）： SoundBanks リストへの SoundBank 生成操作が実行できるダイアログウインドウを起動します。
  • Refresh All Banks （すべてのバンクをリフレッシュする）: すべてのサウンドを停止し、ロード中の全 SoundBanks をいったんアンロードしてからリロードします。

AkAmbientSound

AkAmbientSound は AActor クラスであり、Unreal Audioシステムでデフォルトで提供される AAmbientSound オブジェクトと同様に使われます。再生を制御するには、それ自体のオブジェクトブループリント関数を使うか、グローバルヘルパー関数のStart All Ambient SoundsやStop All Ambient Soundsを使います。AkAmbientSoundに、 AkComponent も含まれ、それ自体にもプロパティがあります。

• プロパティ
  
  • Stop When Owner Is Destroyed （オーナー破棄時に停止）: 有効になっていると、AkAmbientSound が破棄された時にイベントが自動的に停止します。
  • Auto Post: BeginPlayで、関連する AkAudioEvent を自動的に送信します。
• ブループリント関数
  • Start All Ambient Sound: すべてのアンビエントサウンドのプレイバックを開始します。
  • Start Ambient Sound: 選択したアンビエントサウンドのプレイバックを開始します。
  • Stop All Ambient Sound:すべてのアンビエントサウンドのプレイバックを停止します。
  • Stop Ambient Sound: 選択したアンビエントサウンドのプレイバックを停止します。

AkReverbVolume

AkReverbVolume は AVolume クラスであり、Unreal Audioシステムでデフォルトで提供される AReverbVolume オブジェクトと同様に使われます。これはEditorのどの Brush でも、スポーンできます。AkLateReverbComponent 経由で、リバーブエフェクトが実現します。

AkLateReverbComponent

このコンポーネントは、どの UPrimitiveComponent にも追加でき、 そのPrimitive Componentからリバーブゾーンを作成するために使います。あるボリュームにWwise AUXバスをアサインして、このボリュームに入るすべての AkComponents を、関連付けたWwise AUXバスにルーティングすることで、リバーブエフェクトが実現します。 ボリュームの重複がある場合は、ターゲットの AkComponent をどのAUXバスにルーティングするかが、 Priority プロパティによって決まります。 AkReverbVolume に出入りする時は、AUXバスレベルにテンポラルフェードイン・フェードアウトエフェクトが適用されます。
なお、Ak Late Reverb Componentがあるアクターに対しアクティブ状態になったときに、そのアクターに、 AkRoomComponent もある場合は、Late Reverb Componentが無効になり、リバーブは AkRoomComponent に処理され、エフェクトのレンダリングにSpatial Audioエンジンが使われます。

• プロパティ
  
  • Enable Late Reverb: このコンポーネントを有効・無効にします。
  • Send Level: Wwise AUXバスに関連付けられたMaximum Send Levelです。
  • Fade Rate:現在のLate Reverb Component を出入りする時のSendLevelのフェードイン・フェードアウトの速さを、毎秒で示したものです（0.2では、フェードタイム5秒となります）。
  • Priority: Late Reverb Component がに適用される順位で。複数のボリュームが交差する場合、最も高いプライオリティのボリュームのみが選択されます。(同時使用可能な Late Reverb Components の数はUnrealエディタープロジェクト内、 Plugins > Wwise以下で設定可能です)。同じプライオリティ設定を持つLate Reverb Component が複数交差している場合には、どのLate Reverb Component が選択されるかは予測不可能になります。
  • Auto Assign Aux Bus: 有効にすると、このリバーブコンポーネントのAuxバスが自動的にアサインされます。これは、ボリュームや表面積に基づいて親Primitiveコンポーネントの出すリバーブのディケイ時間を推定することで行います。このディケイ値を使って、Integration Settingsの Aux Bus Assignment Map からAuxバスを選択します。デフォルトで有効になっています。
  • Aux Bus: このボリュームにアサインされている、 AkAuxBus 。Wwiseプロジェクトで、このAuxバスがGame-defined auxiliary sendsを有効にしてくれます。Late Reverbを AkRoomComponent や AkPortalComponent に使う場合は、Positioningで Listener Relative Routing を有効にし、3D Spatializationをアサインしておく必要があります。
  • Environment Decay Estimate: リバーブの環境における推定T60（音圧レベルが60dB下がるのにかかる時間）で、レイトリバーブがアタッチされたPrimitiveコンポーネントに基づいて推定されます。このT60値は、Integration Settingsの Aux Bus Assignment Map を使ってAuxバスを自動アサインするときに使ったり、Integration Settingsの Global Reverb RTPC に基づいてDecay Estimate RTPCを決めるために使ったりします。
  • HFDamping: 環境によって生じるHigh-Frequency Damping（高周波のダンピング）の推定値で、関連付けられている AkGeometryComponent （主体となるアクターがボリュームであれば、 AkSurfaceReflectorSetComponent ）に基づいています。HFダンピングを推定するには、このリバーブコンポーネントに、ジオメトリコンポーネントをAssociateAkTextureSetComponent関数で関連付ける必要があります。このレイトリバーブコンポーネントの兄弟にジオメトリコンポーネント（またはサーフェスリフレクタセットコンポーネント）がある場合は、互いに自動的に関連付けられるので、AssociateAkTextureSetComponentをコールする必要はありません。AssociateAkTextureSetComponentを使う場合にHFDamping値が正確なのは、プレイ中に限られます。値が0.0であれば、全周波数にわたり一定したダンピングであることを示します。値が0.0より大きければ、ダンピングが低周波よりも高周波で多いことを示します。値が0.0未満であれば、ダンピングが高周波よりも低周波で多いことを示します。Integration Settingsの Global Reverb RTPC に基づいて、この値をHFDamping RTPCを決めるために使えます。
  • Time to First Reflection: 1次反射がリスナーに到達するのにかかる推定時間で、レイトリバーブがアタッチされたPrimitiveコンポーネントに基づいて推定されます。推定値は、エミッターとリスナーが、親Primitiveコンポーネントの中央にあることを前提としています。Integration Settingsの Global Reverb RTPC に基づいて、この値をTime To First Reflection RTPCを決めるために使えます。
• ブループリント関数
  • Associate Ak Texture Set Component: HFDampingを推定するために使うコンポーネント（ AkGeometryComponent または AkSurfaceReflectorSetComponent ）を設定します。例えば、 AkGeometryComponent 子コンポーネントをもつスタティックメッシュコンポーネントのあるブループリントでは、この関数をBeginPlayでコールすれば、その AkGeometryComponent を、このリバーブコンポーネントと関連付けることができます。このレイトリバーブコンポーネントの兄弟に AkGeometryComponent （または AkSurfaceReflectorSetComponent ）がある場合は、互いに自動的に関連付けられるので、この関数をコールする必要はありません。

AkComponent

AkComponent は 、 USceneComponent から派生するもので、アクティブなWwiseイベントを表します。

• プロパティ
  

  • Attenuation Scaling Factor: Ambient Sound にWwiseの減衰を使う場合、このプロパティでアンビエントサウンドの減衰計算を調整し、より広い、またはより狭い範囲に影響するような音のシミュレーションができます。
  • Use Reverb Volumes:コンポーネントが AAkReverbVolumes に左右されるかどうかを設定します。
  • Occlusion
    • Occlusion Refresh Interval: オクルージョン・オブストラクションのチェック（リスナーと、このゲームオブジェクトの間の、直接のラインオブサイト）の間隔を設定します。このコンポーネントでオクルージョン・オブストラクションを無効にするには、0に設定します。完全なSpatial Audioディフラクションを利用したい場合は、これを無効にすることを推奨します。
  • Spatial Audio
    • Enable Spot Reflectors: このAkComponentで、 AkSpotReflector のリフレクションを有効にします。
    • Radial Emitter
      • Outer Radius: 希望する外半径をこのフィールドに設定します。設定した数値は変更されず、そのまま直接Spatial Audioの AK:SpatialAudio::SetGameObjectRadius() コールに送られます。アクターを選択すると、ゲームオブジェクトのポジションの周りに球体の黄色アウトラインが表示され、入力した大きさが可視化されます。
      • Inner Radius: 希望する内半径をこのフィールドに設定します。内半径は、必ず外半径より小さくします。設定した数値は変更されず、そのまま直接Spatial Audioの AK:SpatialAudio::SetGameObjectRadius() コールに送られます。アクターを選択すると、ゲームオブジェクトのポジションの周りに球体の黄色アウトラインが表示され、入力した大きさが可視化されます。
    • Reflect
      • Early Reflection Aux Bus: 現在のゲームオブジェクトに、アーリーリフレクションのAuxバスを設定します。このコンポーネントは、選択されたAuxバスで、 AK::SpatialAudio::SetEarlyReflectionsAuxSend() をコールします。Auxバスのパラメータは、ゲームオブジェクトで再生中のサウンドのうち、オーサリングツールでアーリーリフレクションのAuxバスを指定していないサウンドに適用されます。サウンドに個別に指定したアーリーリフレクションのAuxバスのパラメータが、ここでパスされる値よりも優先されます。
      • Early Reflection Aux Bus Name: 現在のゲームオブジェクトに、アーリーリフレクションのAuxバスを設定します。このコンポーネントは、選択されたAuxバスで、 AK::SpatialAudio::SetEarlyReflectionsAuxSend() をコールします。Auxバスのパラメータは、ゲームオブジェクトで再生中のサウンドのうち、オーサリングツールでアーリーリフレクションのAuxバスを指定していないサウンドに適用されます。サウンドに個別に指定したアーリーリフレクションのAuxバスのパラメータが、ここでパスされる値よりも優先されます。
      • Early Reflection Bus Send Gain: 現在のゲームオブジェクト用に、アーリーリフレクションのセンドボリュームを設定します。これは、アーリーリフレクションのセンドのボリュームを制御するために使います。このコンポーネントは、入力したボリューム値で AK:SpatialAudio::SetEarlyReflectionsVolume() をコールします。この値とオーサリングツールで指定したアーリーリフレクションのボリュームを合算し、ゲームオブジェクトで再生中の全てのサウンドに適用します。有効値は、[0, 1]です。ボリュームを0に設定すると、このゲームオブジェクトのリフレクション処理が、すべて無効になります。
    • Reflect（非推奨）
      • Early Reflection Order: (非推奨) 2019.2以降は、Early Reflection OrderをProject SettingsのSpatial Audio Initializaion Settingsで設定する必要があります。
      • Early Reflection Max Path Length: (非推奨) 2019.2以降は、Early Reflection Max Path Lengthは、Authoringの、このサウンドのAttenuation Max distance値で設定されます。
    • Room（非推奨）
      • Room Reverb Aux Bus Gain: (非推奨) 2019.2以降、Room Reverb Aux Bus Gainは、AuthoringのSound Property Editorの、Game-Defined Auxiliary Sends Volumeで設定されます。
    • Geometric Diffraction（非推奨）
      • Diffraction Order: (非推奨) 2019.2以降、DiffractionはAuthoringのSound Property Editorで有効にする必要があります。
      • Diffraction Max Paths: (非推奨) 2019.2以降、DiffractionはAuthoringのSound Property Editorで有効にする必要があります。
      • Diffraction Max Path Length: (非推奨) 2019.2以降、DiffractionはAuthoringのSound Property Editorで有効にする必要があります。
    • Debug Draw オプション: Spatial Audio Engineが実行するレイキャストをイメージ化して、さらにそのレイキャストに当たった三角もイメージ化できるので、Spatial Audio Engine内で起きていることを簡単にデバグすることが可能。これは、一度に1つのコンポーネントに限り、使える。
  • AkEvent
    • Ak Audio Event（Akオーディオイベント）: AkAmbientSound オブジェクトの再生開始の指示に合わせてポストされる AkAudioEvent 。Spatial Audio機能を使う場合は、イベントのサウンドエフェクトGame-defined auxiliary sendsを有効にしておきます。

  参照

  • features_blueprintcomponent
  • AkComponentをC++から作成する.

AkAudioInputComponent

AkAudioInputComponent は AkComponent から派生し、オーディオ入力インスタンスを表します。

• ブループリント関数
  • Post Associated Audio Input Event: 指定したEventの再生を開始し、適切なコールバックを登録します。