Wwise Unreal Integration Documentation

スクリプト用に公開されているWwise固有のグローバル関数がいくつかあり、その多くは、引数を単純に変換し、該当するWwise APIに渡すだけです。以下の関数が、Audiokineticカテゴリにあります:

Cancel Event Callback

PostEvent に提供されたコールバックイベントを、キャンセルします。このノードを実行すると、Blueprintイベントはコールされなくなります。

Get Ak Audio Type User Data

提示されたアセットから、指定されたタイプのユーザーデータを返します。

Get Ak Component

指定コンポーネントに添付して追わせる AkComponent を取得します。AkComponent から直接利用できるメソッドがいくつかあるので、 AkComponent ブループリント関数を参照してください。

Get Ak Media Asset User Data

提示されたメディアアセットから、指定されたタイプのユーザーデータを返します。

Get Occlusion Scaling Factor

オクルージョンのスケールファクターを取得します。

Get RTPC Value

ゲームパラメータ値を取得しますが、オプションとして指定アクタのルートコンポーネントをターゲットとすることもできます。

Get Speaker Angles

指定されたデバイスのスピーカー角度を取得します。詳しくは、 GetSpeakerAngles を参照してください。

Is Editor

稼働中のアプリケーションがEditorであればtrueを返し、それ以外であればfalseを返します。

Is Game

ワールドをWorldContextObject引数で取得することが可能で、そのWorldTypeがGame、または GamePreview、またはPlay-In-Editorであれば、trueを返します。それ以外であればfalseを返します。

Post Event At Location

指定した位置でWwiseイベントをポストします。これは一回だけのサウンドであり、一時的なWwiseゲームオブジェクトに対して作成されるので、対応する AkComponent はありません。

Post Event At Location Async

指定した位置でWwiseイベントをポストします。asyncバージョンは、メディアがロードされるのを待ってから、イベントをポストします。これは一回だけのサウンドであり、一時的なWwiseゲームオブジェクトに対して作成されるので、対応する AkComponent はありません。

Reset RTPC Value

Game Parameter値を、Wwiseプロジェクトで指定したデフォルト値に、グローバルスコープまたはゲームオブジェクトスコープでリセットしますが、オプションとして指定したアクタのルートコンポーネントをターゲットとすることもできます。アクタが指定されていない場合や、Nullである場合は、グローバルGame Parameter値が設定されます。RTPCValue が提供されていない場合は、RTPCパラメータを使用します。それ以外の場合は無視します。

Set Bus Config

指定したバスのチャンネルコンフィギュレーションを強制的に設定します。詳しくは、 SetBusConfig を参照してください。

Set Multiple Channel Emitter Positions

1つのゲームオブジェクトに、複数のポジションを設定し、インプットチャンネルを柔軟にアサインします。パラメーターのGameObjectAkComponentは、ポジションを設定するゲームオブジェクトのAkComponentです。ChannelMasksは、ポジションごとに適用するチャンネルマスクのアレイです。Positionsは、適用するトランスフォームのアレイです。MultiPositionTypeは、ポジションタイプです。なお、この関数はSpatial Audioと互換性がありません。

Set Multiple Positions

1つのゲームオブジェクトに、複数のポジションを設定します。複数のポジションを1つのゲームオブジェクトに対して設定すると、1つのボイス分のリソースだけで、複数のエミッターソースをシミュレーションできます。例えば、壁の開口部分、エリアサウンド、同じエリアで同じ音を出す複数のオブジェクトなどをシミュレーションするのに使えます。注: 1つのポジションしかないSetMultiplePositions() をコールするのは、SetPosition() をコールするのと同じです。パラメーターのGameObjectAkComponentは、ポジションを設定するゲームオブジェクトのAkComponentです。Positionsは、適用するトランスフォームのアレイです。MultiPositionTypeは、ポジションタイプです。なお、この関数はSpatial Audioと互換性がありません。ポジションタイプに関する情報は: MultiPositionTypeを参照してください。

Set Multiple Speaker Emitter Positions

1つのゲームオブジェクトに、複数のポジションを設定して、インプットスピーカーを柔軟にアサインできます。パラメーターのGameObjectAkComponentは、ポジションを設定するゲームオブジェクトのAkComponentです。SpeakerMasksは、ポジションごとに適用するスピーカーマスクのアレイです。Positionsは、適用するトランスフォームのアレイです。MultiPositionTypeは、ポジションタイプです。なお、この関数はSpatial Audioと互換性がありません。

Set Occlusion Scaling Factor

オクルージョンのスケールファクターを設定します。

Set Panning Rule

指定したアウトプットのパンニングルールを設定します。サウンドエンジンを初期化すれば、これをいつでも変更できます。詳しくは、 SetPanningRule を参照してください。

Set RTPC Value

ゲームパラメータ値を設定しますが、オプションとして指定アクタのルートコンポーネントをターゲットとすることもできます。アクタが指定されていない場合や、Nullである場合は、グローバルGame Parameter値が設定されます。

Set Speaker Angles

指定されたデバイスのスピーカー角度を設定します。詳しくは、 SetSpeakerAngles を参照してください。

Set State

あるステートグループのアクティブステートを設定します。

Spawn Ak Component at Location

指定位置で新規AkComponentを生成します。デフォルトで、このComponentはそれを再生するイベントが実行完了した際に、破棄されます。Auto PostパラメータはComponentの生成直後にイベントをポストするかを制御します。（デフォルト値はfalse。) またAdvanced parameter Auto Destroy は当該コンポーネントに対して最初のポストされたイベントが完了した際に、そのコンポーネントを破棄するかを制御します。（デフォルト値はtrue）

このBlueprintノードは、"fire-and-forget" （呼ぶだけ呼んで後は放置）的なサウンドにスイッチを設定する場合に特に有用です。この振る舞いはAuto Postをディスエーブルし、スポーンされたAk Componentにスイッチを設定し、そのイベントをポストすることで実現可能です。

Stop All

すべての再生中のサウンドを停止します。

Set Current Audio Culture

詳細はオーディオアセットのローカリゼーションを参照

Set Current Audio Culture Async