バージョン

menu_open
Wwise Unreal Integration Documentation
ブループリント関数

Several Wwise-specific global functions are exposed to scripting, many of which convert and pass their arguments to their corresponding Wwise API. The following functions are available in the Audiokinetic category.

Add Output

Adds an output to the sound engine. Use this to add controller-attached headphones, controller speakers, motion devices, and so on. For more information, refer to AddOutput.

Cancel Event Callback

PostEvent に提供されたコールバックイベントを、キャンセルします。The Blueprint Event is no longer called after this node is executed.

Get Ak Audio Type User Data

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

(Deprecated) Get Ak Component

指定コンポーネントに添付して追わせる AkComponent を取得します。Refer to AkComponent Blueprint機能 for more information about the methods available on AkComponent.

Get or Create Ak Component (replaces Get Ak Component)

指定コンポーネントに添付して追わせる AkComponent を取得します。Refer to AkComponent Blueprint機能 for more information about the methods available on AkComponent.

Get Ak Media Asset User Data

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

Get RTPC Value

Gets the value of a Game Parameter and, optionally, targets the root component of a specified actor.

Get Speaker Angles

指定されたデバイスのスピーカー角度を取得します。For more information, refer to GetSpeakerAngles.

Is Editor

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

Is Game

Returns true if a world can be obtained from the WorldContextObject argument and its WorldType is a Game, GamePreview, or Play-In-Editor. それ以外であればfalseを返します。

Post Event At Location

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

Post Event At Location Async

指定した位置でWwiseイベントをポストします。The async version waits until the media is loaded and then posts the event. これは一回だけのサウンドであり、一時的なWwiseゲームオブジェクトに対して作成されるので、対応する AkComponent はありません。

Remove Output

Removes one output added through AK::SoundEngine::AddOutput. If a listener was associated with the device, we recommend that you unregister the listener before you call RemoveOutput so that Game Object/Listener routing is properly updated according to your game scenario. For more information, refer to RemoveOutput.

Reset RTPC Value

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

Set Bus Config

指定したバスのチャンネルコンフィギュレーションを強制的に設定します。For more information, refer to SetBusConfig.

Set Multiple Channel Emitter Positions

1つのゲームオブジェクトに、複数のポジションを設定し、インプットチャンネルを柔軟にアサインします。

パラメータ:

  • GameObjectAkComponent: The AkComponent of the game object on which to set positions.
  • ChannelMasks: Array of channel masks to apply for each position.
  • Positions: Array of transforms to apply.
  • MultiPositionType: Position type.

Set Multiple Positions

Sets multiple positions for a single game object, which simulates multiple emission sources but only uses the resources of a single voice. You can use this function to simulate wall openings, area sounds, or multiple objects emitting the same sound in the same area. Calling SetMultiplePositions() with only one position is the same as calling SetPosition().

パラメータ:

  • GameObjectAkComponent: The AkComponent of the game object on which to set positions.
  • Positions: Array of transforms to apply.
  • MultiPositionType is the Position type. For more information on the different position types, refer to MultiPositionType.

Set Multiple Speaker Emitter Positions

1つのゲームオブジェクトに、複数のポジションを設定して、インプットスピーカーを柔軟にアサインできます。

パラメータ:

  • GameObjectAkComponent: The AkComponent of the game object on which to set positions.
  • SpeakerMasks: Array of speaker masks to apply for each position.
  • Positions: Array of transforms to apply.
  • MultiPositionType: Position type.

Set Panning Rule

指定したアウトプットのパンニングルールを設定します。You can change it any time after the sound engine is initialized. For more information, refer to SetPanningRule.

Set RTPC Value

Sets the value of a Game Parameter, and optionally targets the root component of a specified actor. アクタが指定されていない場合や、Nullである場合は、グローバルGame Parameter値が設定されます。

Set Speaker Angles

指定されたデバイスのスピーカー角度を設定します。For more information, refer to SetSpeakerAngles.

Set State

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

Spawn Ak Component at Location

指定位置で新規AkComponentを生成します。 By default, the component is automatically destroyed after the Event finishes playing.

パラメータ:

  • Auto Post: Controls whether to post the event immediately upon the component's creation. The default value is false.
  • Auto Destroy: Controls whether to destroy the component when the first Event posted on this component is done. The default value is true.

You can use this Blueprint node to set a Switch on a fire-and-forget sound. To do so, disable Auto Post, set a Switch on the spawned Ak Component, and then post the Event, as shown in the following image:

Stop All

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

Set Current Audio Culture

Refer to Localizing Audio Assets for more information.

Set Current Audio Culture Async

Refer to Localizing Audio Assets for more information.

Other Blueprint Functions

その他に、以下の関数がサブカテゴリにあります:


このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう