|
Wwise SDK 2021.1.14
|
Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。
既存のMusic Segmentに、Custom Cueを追加する
既存のMusic Segmentの中に、指定した名前と、ミリ秒単位の時間の、Custom Cueを作成します。
inclusionリストにオブジェクトを追加する
SoundBankのinclusionリストに、オブジェクトを追加します。'media'フィルタは省略します。
Switch Containerの子を、Stateにアサインする
Switch Groupの子を、Assigned ObjectsビューのリストにあるStateに、ドラッグすることに相当します。
undoグループを開始する
undoグループを開始します。
接続中のWwise、を最前面に表示する
接続中のWwiseを、最前面に表示します
undoグループを取り消す
undoグループを取り消します。
プロパティが有効かどうかを確認する
プロパティが有効かどうかを確認します。
inclusionリストをクリアする
SoundBankのinclusionリストは、'replace'操作と、空の'inclusions'リストを使い、クリアできます。
現在のプロジェクトを閉じる
現在のプロジェクトを閉じます。
Cubeに接続する
同じコンピュータ上にある、Cubeという名前のゲームに接続します。
特定の親にオブジェクトをコピーする
"object" IDで指定したオブジェクトをコピーし、そのコピーを"parent"の子にします。"parent"に、同名の子がすでに入っている場合は、オブジェクトの名前を変えます。
サウンドのPlay Eventを作成する
バーチャルフォルダ'WAAPI'の下に、SFXサウンドオブジェクトに対するPlayアクションのある'Play_SFX'というイベントを作成します。
2つのSoundオブジェクトのあるRandom Containerを作成する
指定した親の下に、'A'と'B'の2つのSoundオブジェクトがある、'Boom'というRandom Containerを作成します。
Soundオブジェクトを作成する
指定した親の下に、'Boom'という新しいSoundオブジェクトを作成します。
Virtual Folderを作成する
デフォルトのワークユニットの下に、'Guns'という新しいバーチャルフォルダを作成します。同名のフォルダがすでにある場合は、固有の名前を自動的に見つけます。
トランスポートオブジェクトを作成する
特定のWwiseオブジェクト用に、トランスポートオブジェクトを作成します。
オブジェクトの減衰カーブを定義する
"object"の、"curveType"の減衰カーブを、複数の"points"を設定して定義します。
GUIDでオブジェクトを削除する
GUIDで指定したオブジェクトを、削除します。
パスでオブジェクトを削除する
指定したパスのMyToneオブジェクトを、削除します。
トランスポートオブジェクトを破棄する
与えられたトランスポートオブジェクトを、破棄します。
プロファイラデータを無効にする
"Voices Data"を無効にします
ゲームとの接続を切断する
接続中のゲームまたはプロセスとの接続を、切断します。
ak.wwise.core.profiler.getVoiceContributions に必要なプロファイラデータを有効にする
"Voices Data"と"Voice Inspector Data"を、enableプロパティのデフォルト値（true）を使い、有効にします。
プロファイラデータを有効にする
"Voices Data"を有効にします
undoグループを終了する
undoグループを終了します。
オブジェクトのパラメータを必要としないコマンドを実行する
"ResetAllMutes"コマンドを実行します。
オブジェクトのパラメータを必要とするコマンドを実行する
"objects"のGUIDで定義したオブジェクトで、"ConvertCurrentPlatform"を実行します。
Project Explorerでオブジェクトを見つけて選択する
指定のオブジェクトをProject Explorerビュー（sync group 1）で見つけ、それらを選択します。
新しいSoundBankを、inclusionを指定して生成する
新しいSoundBankをインポートしてから生成するサンプルコールで、このSoundBankは、プロジェクトに保存されません。SoundBankデータを取得する方法を知るには、 ak.wwise.core.soundbank.generated を参照してください。
新しいSoundBankを、inclusionを指定してディスクに生成する
新しいSoundBankをインポートし、それを生成してから、ディスクのSoundBank生成フォルダに書き込みます。
既存の複数のSoundBankを、ディスクに書き込まずに生成する
プロジェクトに既にあるSoundBankを生成し、そのバンクデータを、WAAPI経由でストリーミングします。SoundBankデータを取得する方法を知るには、 ak.wwise.core.soundbank.generated を参照してください。
トランスポートオブジェクトのStateを取得する
特定のトランスポートオブジェクトのStateを取得します。
サウンドオブジェクトを含む、全てのオブジェクトを取得する
1つ以上の子がサウンドオブジェクトであるオブジェクトの、IDを取得します。重複は、"distinct"変換を使い除外します。
全てのプラットフォームを取得する
プラットフォームのIDと名前を取得します。
オブジェクトの減衰カーブを取得する
"object"で指定したオブジェクトの、"curve"を取得します。
オブジェクトの名前を取得する
オブジェクトの名前のプロパティを返します。
使用可能なコンソールを取得する
接続中のサウンドエンジン用の、使用可能なコンソールを取得します。
Wwiseの情報を取得する
接続中のWwiseの情報を取得します。
複数のチャンネルにわたりピークを取得する
オーディオソースオブジェクトのピークを取得します。
複数のチャンネルにわたりピークを取得する
オーディオソースオブジェクトのピークを（トリムした範囲内で）取得します。
チャンネルごとのピークを取得する
オーディオソースオブジェクトのピークを取得します。
チャンネルごとのピークを取得する
オーディオソースオブジェクトのピークを（トリムした範囲内で）取得します。
Switch Containerのアサインメントを取得する
Switch Containerのアサインメントのリストを取得します。
接続ステータスを取得する
現在の接続ステータスを取得します。この例では、WwiseはIntegration Demoに接続しています。
フィルタに適合する、子孫オブジェクトを取得する
Actor-Mixer Hierarchyの全ての子孫の中から、名前が'My'で始まるオブジェクトを返します。これには、正規表現の'^My'を使います。
全てのオブジェクトタイプのリストを取得する
全てのオブジェクトタイプのリストを取得します。
使用する出力バスを取得する
継承した出力バスを返します。オーバーライドのソースを判断するために、override parent値を使います。
プロジェクト名、パス、ダーティ状態を取得する
プロジェクト名、ファイルパス、そしてダーティ状態を取得します。なお、プロジェクト名はWPROJ MXLで定義され、ファイル名と合致しないことがあります。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
オブジェクトのプロパティ、リファレンスを取得する
オブジェクトのボイスボリュームと出力バスを、返します。
選択したオブジェクトを取得する
選択したオブジェクトGUIDを取得する
オブジェクトのボリュームを取得する
Master Audio Busのボリュームを返します。
新しいSFXをインポートし、プロパティに値を設定する
"objectPath"の下に新しいSFXを作成し、ボリューム属性を1に設定します。
オーディオファイルのインポート
タブ区切りテキストファイルからオーディオファイルをインポートします
SFXのWwiseObjectにオーディオファイルをインポートする
"audioFile"で指定したファイルを、"objectPath"にインポートします
Eventに対して停止Actionを起動する
あるEventに対し、Stopアクションを、5秒のlog1 Curveのフェードアウトで実行します。
オブジェクトを新しい親に移動する
オブジェクトの"id"を移動し、それを"parent"の子にします。"parent"に、すでに同名の子が入っている場合は、このオブジェクトは失敗します。
オブジェクトを、同名の子が入っている親に移動する
オブジェクトの"id"を移動し、それを"parent"の子にします。"parent"に、同名の子がすでに入っている場合は、オブジェクトの名前を変えます。
プロジェクトを開く
パスで指定した .wproj project を開きます。
トランスポートオブジェクトを再生する
特定のトランスポートオブジェクトを再生します。
GUIDでTriggerをポストする
"gameObject"に適用する指定の"trigger"を、GUIDでポストします。
名前でTriggerをポストする
"gameObject"に適用する指定の"trigger"を、名前でポストします。
Short IDでEventをポストする
EventのShort IDを使い、Eventをサウンドエンジンにポストします。
Event名でEventをポストする
Event名を使い、Eventをサウンドエンジンにポストします。
オブジェクトGUIDでEventをポストする
EventのGUIDを使い、Eventをサウンドエンジンにポストします。
ある時点のRTPCのIDと値を、クエリする
現在のキャプチャセッションで、30秒（30,000ミリ秒）におけるアクティブなRTPCを、クエリします。
ある時点のバス名をクエリする
現在のキャプチャセッションで、30秒（30,000ミリ秒）におけるバスを、クエリします。
Audio Objectのゲームオブジェクトプロパティを、Capture Time Cursorからクエリする
Capture Time Cursorを、コールを処理したときに、キャプチャセッションの最後の時間において、Audio Objectをクエリする時間として指定します。
ボイスのゲームオブジェクトのプロパティを、Capture Time Cursorからクエリする
Capture Time Cursorを、コールを処理したときに、キャプチャセッションの最後の時間において、ボイスをクエリする時間として指定します。
instigatorのID（パイプラインID）を、ある時点のAudio Objectのためにクエリする
現在のキャプチャセッションで、30秒（30,000ミリ秒）におけるAudio Objectのinstigator ID（パイプラインID）を、クエリします。
ある時点のサウンド名をクエリする
現在のキャプチャセッションで、30秒（30,000ミリ秒）におけるボイスを、クエリします。
Visual Studio Codeで編集するコマンドを登録する
新しいExtraメニューに表示されるコマンドを登録します。
Wavosaurで編集するコマンドを登録する
コンテキストメニューたけに表示されるコマンドを登録します。
プログラムなしのコマンドを登録する
プログラムのないコマンドを登録します。通常は、Waapiでコールバックとして使います。最もシンプルな例。
ゲームオブジェクトを登録する
"MyGameObjectName"ゲームオブジェクトを登録します。
Switch Containerから、アサインメントを削除する
これは、Assigned ObjectsビューのStateにアサインされた子を、選択して削除することに相当します。
WwiseObjectの名前を変更する
"object"で指定したオブジェクトの名前を、"value"に変更します。
RTPCのGUIDを使い、RTPC値をリセットする
"rtpc"のGUIDを使い、"rtpc"の値を"gameObject"のデフォルトにリセットします。
RTPCの名前を使い、RTPC値をリセットする
"rtpc"の名前を使い、"rtpc"の値を"gameObject"のデフォルトにリセットします。
SoundBankのinclusionリストを取得する
SoundBankのinclusionリストを取得します。
オブジェクトのプロパティに関する情報を取得する
オブジェクトのプロパティに関する情報を取得します。
SoundBankログを取得する
最新のSoundBank生成ログを取得するには、チャンネル'soundbankGenerate'を使います。
オブジェクトのプロパティとリファレンス名のリストを取得する
オブジェクトのプロパティとリファレンス名のリストを取得します。
トランスポートオブジェクトのリストを取得する
トランスポートオブジェクトのリストを取得します。
在のプロジェクトを保存する
現在のプロジェクトを保存します。
テキストでオブジェクトをサーチする
名前に'gun'を含むオブジェクトをサーチします。
特定カテゴリのオブジェクトをサーチする
テキストプロパティに、"Tone"があるオブジェクトのIDと名前を取得し、その結果にフィルタを適用し、カテゴリ"Actor-Mixer Hierarchy"の中にあるものだけを取得します。
特定のタイプのオブジェクトをサーチする
テキストプロパティに、"Tone"があるオブジェクトのIDと名前とnotesを取得し、その結果にフィルタを適用し、タイプが"Sound"のものだけを取得します。使用可能なタイプについては、 Wwiseオブジェクトリファレンス を参照してください。
全体の長さの35に対してシークする
"event"のPlay Actionが全体の長さの35の時点で参照する"gameObject"に対し、シークします。
1秒のポジションに対してシークする
"event"のPlay Actionが1秒の時点で参照する"gameObject"に対し、シークします。
プロファイラにメッセージを送信する
Profilerに、"メッセージ"を送信します。
ゲームオブジェクトに、リスナーの一覧を設定する
"gameObject"のアクティブなリスナーの一覧として、"listeners"を設定します。
RTPCのGUIDを使い、RTPC値を設定する
"rtpc"のGUIDを使い、"rtpc"の値を"gameObject"の"value"に設定します。
RTPCの名前を使い、RTPC値を設定する
"rtpc"の名前を使い、"rtpc"の値を"gameObject"の"value"に設定します。
オブジェクトのリファレンスを設定する
指定したオブジェクトに、Output Busを設定します。
ゲームオブジェクトに複数のポジションを設定する
"gameObject"に"positions"で定義した複数のポジションを設定し、1つのサウンドで複数のソースをシミュレーションします。
ゲームオブジェクトのAuxiliary Busを設定する
"emitter"のAuxiliary Busを、"listener"別に、バス名と値を指定して設定します。
Short IDを使い、State GroupをほかのStateに設定する
"stateGroup"を、"state"に設定します。
名前を使い、State GroupをほかのStateに設定する
"stateGroup"を、"state"に設定します。
Short IDを使い、Switch GroupをほかのStateに設定する
"gameObject"の"switchGroup"を、"switchState"に設定します。
名前を使い、Switch GroupをほかのStateに設定する
"gameObject"の"switchGroup"を、"switchState"に設定します。
Soundオブジェクトの、Volumeのランダマイザー値を設定する
"object"で定義したオブジェクトの、"Volume"プロパティに対応すランダマイザ属性を設定します。
リスナー用に、エミッターのアウトプットバスのボリュームを設定する
乗数コントロール値を使い、リスナー用にエミッターのアウトプットバスのボリュームを増幅させます。
デフォルトのリスナーのリストを設定する
"listeners"を、デフォルトのリスナーのリストに設定します。
リスナーのスペーシャリゼーションを設定する
"listener"のスペーシャリゼーションを、"volumeOffsets"で左にパンニングして設定します。
オブジェクトのnotes（備考）を設定する
"object"で定義したオブジェクトのnotes（備考）を設定します。
ゲームオブジェクトのオブストラクションとオクルージョンのレベルを設定する
"emitter"の、"listener"にとっての"obstructionLevel"と"occlusionLevel"を設定します。
ゲームオブジェクトのポジションを設定する
"gameObject"のポジションを、提供された向きの"position/position"に設定します。
ゲームオブジェクトの拡大縮小の倍率を設定する
"gameObject"の拡大縮小の倍率を、"attenuationScalingFactor" (200%)に設定します。
指定のプラットフォームの、指定のプロパティ値を設定する
"object"で定義したオブジェクトの"Volume"プロパティを、"Value"に設定します。
ボリュームを設定する
"object"で定義したオブジェクトの"Volume"プロパティを、"Value"に設定します。
再生中のコンテンツを停止する
"playingId"で指定したコンテンツを、Linear Curveの"transitionDuration"を使い、停止します。
再生中のコンテンツを停止する
"gameObject"に関連する全てのコンテンツの再生を、停止します。
トランスポートオブジェクトを停止する
全てのトランスポートオブジェクトを、停止します。
トランスポートオブジェクトの再生をトグルする（一時停止・再開）
特定のトランスポートオブジェクトで、再生をトグルします（一時停止・再開）。
トランスポートオブジェクトの再生をトグルする（再生・停止）
特定のトランスポートオブジェクトで、再生をトグルします（再生・停止）。
ゲームオブジェクトの登録を解除する
"gameObject"の登録を解除します。
コマンドリストの登録を解除する
ak.wwise.ui.commands.register の例の、全ての登録を解除します。