stingray.Wwise ネームスペース リファレンス

説明

Wwise オブジェクトは、Stingray ゲーム コードと Wwise エンジン API に対するインタフェースを提供するシングルトンです。

関連サンプル コード

Appkit: /camera_wrapper.lua Appkit: /simple_project.lua 基本テンプレート: /player.lua キャラクタ テンプレート: /player.lua 車両テンプレート: /vehicle_unit_controller.lua Oculus VR テンプレート: /player.lua Oculus VR テンプレート: /project.lua

その他の関連リファレンス項目

Wwise サウンド

この参照ページは、次の概要トピックと関連付けられています

	「オーディオを操作する > Wwise オーディオの基本 > ランタイムでサウンド バンクをロードする」
	「オーディオを操作する > Wwise オーサリング ツール」
	「オーディオを操作する > Wwise Lua 関数」
	「コンテンツとリソースを管理する > ゲームのローカライズ > オーディオをローカライズする」

関数

duration_type ( event_name ) : number 指定されたイベントの持続時間タイプを取得します。

パラメータ

event_name :

string

値を参照するイベント名です。

戻り値

number

Wwise.WWISE_DURATION_* Lua 変数のいずれか 1 つと一致するイベント サウンドの持続時間タイプです。

一部の Wwise イベント タイプ(Wwise Silence、Tone Generator のような手続き型 SFX)は、持続時間の検査をサポートしておらず、WWISE_DURATION_UNSUPPORTED を返します。

has_event ( event_name ) : boolean エクスポートされたバンク内に指定のイベントが存在しているかどうかを示します。

パラメータ

event_name :

string

イベントの名前です。

戻り値

boolean

エクスポートされたバンク内に指定のイベントが存在する場合は true を返し、存在しない場合は false を返します。

load_bank ( resource_name ) 指定されたサウンド バンクを Wwise エンジンにロードします。

パラメータ

resource_name :

string

ロードするサウンド バンク リソースの名前です。

戻り値

この関数は値を返しません。

関連サンプル コード

基本テンプレート: /player.lua 車両テンプレート: /vehicle_unit_controller.lua Oculus VR テンプレート: /player.lua

その他の関連リファレンス項目

stingray.Wwise.set_language()

max_attenuation ( event_name ) : number 指定されたイベントの最大減衰距離を取得します。

パラメータ

event_name :

string

値を参照するイベント名です。

戻り値

number

最大減衰距離です。

max_duration ( event_name ) : number 指定されたイベントの最大持続時間の長さを取得します。

パラメータ

event_name :

string

値を参照するイベント名です。

戻り値

number

イベント サウンドの最大持続時間(秒単位)です。

一部の Wwise イベント タイプ(Wwise Silence、Tone Generator のような手続き型 SFX)は、持続時間の検査をサポートしていません。

min_duration ( event_name ) : number 指定されたイベントの最小持続時間の長さを取得します。

パラメータ

event_name :

string

値を参照するイベント名です。

戻り値

number

イベント サウンドの最小持続時間(秒単位)です。

一部の Wwise イベント タイプ(Wwise Silence、Tone Generator のような手続き型 SFX)は、持続時間の検査をサポートしていません。

position_type ( event_name ) : number 指定されたイベントの位置タイプを取得します。

パラメータ

event_name :

string

値を参照するイベント名です。

戻り値

number

WWISE_3D_SOUND、WWISE_2D_SOUND、WWISE_INVALID_SOUND のいずれか 1 つです。

set_language ( language_dir ) 指定された言語フォルダ名に現在の Wwise エンジン言語フォルダを設定します。

パラメータ

language_dir :

string

新しいバンク サウンドをロードする際に使用する言語です。

戻り値

この関数は値を返しません。

名前は Wwise 書き出しフォルダ内の言語フォルダ名のいずれかと一致している必要があります。言語は load_bank() の将来の呼び出しに影響します。現在ロードされているバンク サウンドは、以前に設定された言語のままになります。

set_panning_rule ( rule, type, output_id ) パン操作のルールを設定するために指定された設定にメッセージを送信します。

パラメータ

rule :	integer	get_module_number と PANNING_RULE_* パラメータを介して取得されたパン操作のルールです。
type :	integer	* _ get_module_number と OUTPUT_* パラメータを介して取得したオーディオ出力タイプです。
output_id :	integer?	デバイス固有の識別子です。メインの場合、既定値の 0 になります。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

この関数は値を返しません。

set_state ( group, state ) スイッチ グループ Wwise オブジェクトの状態を設定します。

パラメータ

group :	string	状態グループです。Wwise プロジェクトの状態設定と一致している必要があります。
state :	string	現在の状態です。Wwise プロジェクトの状態設定と一致している必要があります。

戻り値

この関数は値を返しません。

unload_bank ( resource_name ) 指定されたサウンド バンクを Wwise エンジンからロード解除します。

パラメータ

resource_name :

string

ロード解除するサウンド バンク リソースの名前です。

戻り値

この関数は値を返しません。

wwise_world ( world ) : stingray.WwiseWorld 指定された Stingray ゲーム ワールド に対応する、WwiseWorld オブジェクトへのポインタを返します。

パラメータ

world :

stingray.World

取得する Stingray ゲーム ワールドの Wwise インタフェースです。

戻り値

stingray.WwiseWorld

指定されたゲーム ワールドの WwiseWorld インタフェースです。

関連サンプル コード

Appkit: /camera_wrapper.lua Appkit: /simple_project.lua 基本テンプレート: /player.lua 車両テンプレート: /vehicle_unit_controller.lua Oculus VR テンプレート: /player.lua Oculus VR テンプレート: /project.lua