Wwise Authoring APIは、Wwiseプロジェクトの最も重要な要素を取得するための包括的なクエリシステムを提供します。具体的には、プロジェクト内の任意のオブジェクトを取得できます。
クエリシステムは ak.wwise.core.object.get 関数に組み込まれています。詳細については、参照ドキュメントを参照してください。
クエリは2つの部分で構成されています：
さらに、クエリには次のようなオプションがあります：
from 文は、クエリを開始するためのいくつかのポイントを提供します。
\Actor-Mixer Hierarchy\Default Work Unit\MySound
transform 文には、選択中のオブジェクトを変換するために使用できるいくつかの変換関数が用意されています。最初の変換は、 from 文によって選択されたオブジェクトに適用されます。他の変換は、前の変換の結果に適用されます。
複数の変換を順番に追加できます。
return 文（式）は、すべての変換の最後に１回実行されます。変換が指定されていない場合は、 from 文から直接実行されます。 return 式は、返すWwiseオブジェクトの要素を指定します。任意の数の要素を返すことができます。
return 式には、冒頭に「@」を付けると、プロパティとレファレンスを含めることができます。例えば、'@Volume' や '@OutputBus'を含む可能性があります。冒頭に二重の'@@'を付けると、オーバーライドのソースがリターンに使われ、それは階層内のoverride parent'の様々な値によって決まります。
return 式の項目が互換性がないか、返されたオブジェクトに存在しない場合、結果の一部にはなりません。
初期化についてはプロジェクトコード を参照してください。
オブジェクトのリストのID、名前、音声ボリュームをリターンします。
var query = {
from: { id: [
'{A076AA65-B71A-45BB-8841-5A20C52CE727}',
'{2028C899-8300-4667-ADD0-ED10467BD91E}',
'{24979032-B170-43E3-A2E4-469E0193E2C3}'
] }
};
var options = {
return: ['id', 'name', '@Volume']
};
session.call('ak.wwise.core.object.get', [], query, options).then(
function (res) {
// Print the name and volume
var objects = res.kwargs.return;
for(let i = 0; i < objects.length;++i ){
console.log(`${objects[i].name}: ${objects[i]['@Volume']}`);
}
},
function (error) {
console.log(`error: ${error}`);
}
);
'My' で始まるActor-Mixer Hierarchy のすべてのオブジェクトのIDと名前を正規表現で返します。
var query = {
from:{path:['\\Actor-Mixer Hierarchy']},
transform:[
{select:['descendants']},
{where:['name:matches','^My']}
]
};
var options = {
return: ['id', 'name']
};
session.call('ak.wwise.core.object.get', [], query, options).then(
function (res) {
// Print the name
var objects = res.kwargs.return;
for(let i = 0; i < objects.length;++i ){
console.log(`${objects[i].name}`);
}
},
function (error) {
console.log(`error: ${error}`);
}
);