バージョン
menu_open
Wwise SDK 2023.1.3
ak.wwise.core.object.get

クエリの結果にある各オブジェクトに対して、オプションで指定した通りにクエリを実行し、データを返します。クエリに、'waql'引数、または'from'引数を指定し、オプションとして'transform'引数も指定できます。詳細は、 Wwise Authoring Query Language (WAQL) を使用する または Wwise Project のクエリ を参照してください。オプションについて詳しく知るには、 Returnオプション を参照してください。

Arguments

Name タイプ 概要
waql string WAQL言語のクエリを指定します。詳細は、 Wwise Authoring Query Language (WAQL) を使用する を参照してください。
from one of: クエリ開始ポイント。注：これは非推奨です。代わりにWAQL引数を使うべきです
object idフィールドでオブジェクトを指定します。
object searchフィールドでオブジェクトを指定します。
object nameフィールドでオブジェクトを指定します。
object pathフィールドでオブジェクトを指定します。
object ofTypeフィールドでオブジェクトを指定します。
object queryフィールドでオブジェクトを指定します。
from.id * array GUID、またはShort ID (uint32)の、オブジェクトIDのアレイ。
from.id [...] one of: GUID、またはShort ID (uint32)。
string オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
object WwiseオブジェクトのShort IDと、関連するタイプ。
from.id[...].shortId * integer オブジェクトのShort ID。
符号なし整数32-bit。範囲: [0,4294967295]
from.id[...].type * integer This syntax is deprecated and we recommend the use of WAQL. Short IDのオブジェクトのタイプ。The type ​​can be 10 (Event), 12 (SwitchGroup), 14 (StateGroup), 17 (EffectPlugin), 18 (SoundBank), 19 (Bus), 20 (AuxBus), 22 (GameParameter), 41 (Trigger) or 68 (AudioDevicePlugin) Range: [1,*]
from.search * array プロジェクトのサーチに使う、テキストのトークンのアレイ。
from.search [...] string サーチトークン。
from.name * array 固有のオブジェクトqualified nameのアレイ。
from.name [...] string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
from.path * array オブジェクトパスのアレイ。
from.path [...] string Wwiseオブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。例えば: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
from.ofType * array オブジェクトタイプのアレイ。
from.ofType [...] string オブジェクトのタイプ。タイプの一覧については、 Wwiseオブジェクトリファレンス を参照してください。
from.query * array クエリオブジェクトIDのアレイ。
from.query [...] string オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
transform array "from"によって返されたオブジェクトリストにチェインされた、連続する変換のアレイ。
transform [...] one of: オブジェクトの変換。
object select変換。
string 固有のオブジェクトインスタンスを返すので、重複したオブジェクトが返されることはありません。可能な値:
  • distinct
object rangeフィールドでオブジェクトを指定します。
object whereフィールドでオブジェクトを指定します。
transform[...].select * array 1つのセレクタだけのアレイ。
transform[...].select [...] string セレクタ。結果のオブジェクトは、指定したセレクタによって異なります。可能な値:
  • parent
  • children
  • descendants
  • ancestors
  • referencesTo
transform[...].range * array バウンダリーインデックスを指定する、2つの数値のアレイ。結果の一部だけを入れる場合は、これを使います。例えば、これを次のように使い、検索結果の最初の100項目を取得することができます: [0,100]。
transform[...].range [...] number 範囲を制限する2つの数値のうちの1つ。
transform[...].where * array 結果をフィルタリングするための、2つのトークンのアレイ。1つ目のトークンは、フィルタ述語です。可能な述語のリストについては、 Wwise Project のクエリ を参照してください。1つ目のトークンは、述語に対するパラメータです。
transform[...].where [...] any of: where文。
string 文字列のトークン。アレイの1番目のトークンは、常に'where'述語名の文字列です。2つ目のトークンは、パラメータです。
array 文字列のアレイ。詳細は、 Wwise Project のクエリ を参照してください。
transform[...].where[...] [...] string 'where'述語のパラメータ。詳細は、 Wwise Project のクエリ を参照してください。

引数スキーマ

Options

Name タイプ 概要
return array オブジェクトごとに、何が返されるのかを指定します。使用可能なプロパティやリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
return式のアレイで、Wwiseオブジェクトのどのエレメントを返すのかを定義します。例えば、名前やIDなどの内蔵アクセサや、VolumeやPitchなどのオブジェクトプロパティが含まれます。
return [...] any of: return式。
string Wwiseオブジェクト用の内蔵アクセサを、1つまたは複数、指定します。可能な値:
  • id
  • name
  • notes
  • type
  • pluginName
  • shortId
  • classId
  • category
  • filePath
  • workunit
  • parent
  • owner
  • path
  • isPlayable
  • childrenCount
  • totalSize
  • mediaSize
  • objectSize
  • structureSize
  • sound:convertedWemFilePath
  • sound:originalWavFilePath
  • soundbank:bnkFilePath
  • music:transitionRoot
  • music:playlistRoot
  • audioSource:playbackDuration
  • audioSource:maxDurationSource
  • audioSource:trimValues
  • audioSource:maxRadiusAttenuation
  • audioSource:language
  • workunit:isDefault
  • workunit:type
  • workunit:isDirty
  • switchContainerChild:context
  • convertedWemFilePath
  • originalFilePath
  • originalRelativeFilePath
  • convertedFilePath
  • originalWavFilePath
  • soundbankBnkFilePath
  • musicTransitionRoot
  • musicPlaylistRoot
  • playbackDuration
  • duration
  • maxDurationSource
  • audioSourceTrimValues
  • maxRadiusAttenuation
  • audioSourceLanguage
  • workunitIsDefault
  • workunitType
  • workunitIsDirty
  • switchContainerChildContext
  • isExplicitMute
  • isExplicitSolo
  • isImplicitMute
  • isImplicitSolo
  • isIncluded
  • points
  • stateProperties
  • stateGroups
string クエリを構成し、値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを、1つまたは複数、指定します。1つの@マークを指定すると、関連するオブジェクトのプロパティ値を返します。2つの@マークを指定すると、オーバーライドのソースのプロパティ値を返します。 Wwiseオブジェクトリファレンス を参照してください。
platform any of: プラットフォームのID (GUID)または名前。これは任意の引数です。指定がなければ、現在のプラットフォームを使います。
string プラットフォームの名前。
string プラットフォームのID。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
language any of: ランゲージのID (GUID)または名前。
string ランゲージの名前。
string ランゲージのID。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。

オプションスキーマ

Result

Name タイプ 概要
return array オプションで提供されたものと、プロパティが合致したオブジェクトのアレイ。
return [...] object Wwiseオブジェクト
Wwiseオブジェクト。必須のプロパティを指定するには、returnオプションを使います。
return[...].id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].name string オブジェクト名。
return[...].notes string オブジェクトのnotes。
return[...].type string オブジェクトのタイプ。使用可能なタイプの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
return[...].pluginName string Source、Effect、Mixer、Device、Metadataプラグインの、プラグイン名。
return[...].path string プロジェクトルートからオブジェクトへのパス。例: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
return[...].parent object 階層におけるオブジェクトの親。
return[...].parent.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].parent.name string オブジェクト名。
return[...].owner object オブジェクトのオーナー。カスタムエフェクトやカスタム減衰など、ほかのオブジェクトにローカルで所有されているオブジェクトが、該当します。
return[...].owner.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].owner.name string オブジェクト名。
return[...].isPlayable boolean オブジェクトをTransportで再生できる場合は、trueです。
return[...].shortId integer オブジェクトのShort ID。
return[...].classId integer オブジェクトのクラスID。
符号なし整数32-bit。範囲: [0,4294967295]
return[...].category string オブジェクトのカテゴリ。例: 'Actor-Mixer Hierarchy'
return[...].filePath string オブジェクトを含むファイルへのパス。パスは、Work Unitファイルまたはプロジェクトファイルとします。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].workunit object オブジェクトを含む、親Work Unit。'id'と'name'を返します。
return[...].workunit.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].workunit.name string オブジェクト名。
return[...].childrenCount number このオブジェクトの子の数。注：これは非推奨です。The same result can be obtained with children.count().
return[...].totalSize integer このオブジェクトと、その全ての子が、SoundBankに占めるスペース（単位byte）。objectSizeは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
return[...].mediaSize integer このオブジェクトとその全ての子のメディアファイルの、変換後の合計サイズ（単位bytes）。なお、正確な値を得るには、SoundBankを生成する必要があります。
return[...].objectSize integer このオブジェクトのメタデータがSoundBankに占めるスペース（単位byte）。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
return[...].structureSize integer このオブジェクトとその全ての子のメタデータが、SoundBankに占めるスペース（単位byte）。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
return[...].musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. 注：これは非推奨です。The TransitionRoot reference should be used instead.
return[...].musicTransitionRoot.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. これが適用されるのは、Music Playlist Containerだけです。注：これは非推奨です。The PlaylistRoot reference should be used instead.
return[...].musicPlaylistRoot.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].originalWavFilePath string (DEPRECATED) Absolute path to the original wav file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].originalFilePath string Absolute path to the original file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].activeSource object The active source of the sound object.
return[...].activeSource.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].activeSource.name string オブジェクト名。
return[...].convertedWemFilePath string (DEPRECATED) Absolute path to the converted wem file. 選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].convertedFilePath string Absolute path to the converted file. 選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].soundbankBnkFilePath string SoundBankオブジェクトに関連する、生成後のSoundBankファイルへの絶対パス。これは、SoundBankオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
return[...].playbackDuration object 最小と最大のdurationと、durationタイプを含む、durationルート。注：これは非推奨です。The duration should be used instead. これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
return[...].playbackDuration.playbackDurationMin number 再生にかかる最短時間。
return[...].playbackDuration.playbackDurationMax number 再生にかかる最長時間。
return[...].playbackDuration.playbackDurationType string durationタイプ。
return[...].duration object 最小と最大のdurationと、durationタイプを含む、durationルート。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
return[...].duration.min number 再生にかかる最短時間。
return[...].duration.max number 再生にかかる最長時間。
return[...].duration.type string durationタイプ。
return[...].maxDurationSource object 最長のdurationのオーディオソース。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
return[...].maxDurationSource.id string 最長の長さのオーディオソースオブジェクトの、ID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].maxDurationSource.trimmedDuration number トリムした最長のソースの、durationを秒単位で示します。
return[...].audioSourceTrimValues object オーディオソースをトリムした時間の範囲。
return[...].audioSourceTrimValues.trimBegin number トリム開始の時間値を、秒単位で示します。
return[...].audioSourceTrimValues.trimEnd number トリム終了の時間値を、秒単位で示します。
return[...].maxRadiusAttenuation object 半径が最大の減衰。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
return[...].maxRadiusAttenuation.id string 半径が最大の減衰オブジェクトの、ID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].maxRadiusAttenuation.radius number 減衰オブジェクトの半径。
return[...].audioSourceLanguage object オーディオソースに関連付けられたランゲージ。これは、Audio Sourceオブジェクトに、直接適用されるだけです。
return[...].audioSourceLanguage.id string Audio Sourceオブジェクトに関連するLanguageオブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].audioSourceLanguage.name string Audio Sourcオブジェクトか関連付けられているLanguageオブジェクトの名前。
return[...].workunitIsDefault boolean ワークユニットがデフォルトであれば、true。
return[...].workunitType string Work Unitのタイプ。なお、Work Unitsと同様に、物理フォルダにも"WorkUnit"というタイプがあります。物理フォルダには、workunitType "folder"があります。可能な値:
  • folder
  • rootFile
  • nestedFile
return[...].workunitIsDirty boolean Work UnitまたはProject（wprojファイル）がダーティである場合、つまり変更したあとに保存していない場合は、true。
return[...].switchContainerChildContext object Switch Containerの子に関連付けられた、コンテキストオブジェクト。子に関連する、Switch Containerのコンテキストに依存するプロパティを、このオブジェクトが保持します（例えば、'1st only'チェックボックスのプロパティなど）。
return[...].switchContainerChildContext.id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].isExplicitMute boolean Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects.
return[...].isExplicitSolo boolean Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one.
return[...].isImplicitMute boolean Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects.
return[...].isImplicitSolo boolean Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one.
return[...].isIncluded boolean Whether or not the object is Included. 選択肢からプラットフォームを指定。This takes into consideration the Inclusion status of the object's ancestors.
return[...].points array This only applies to Curve objects.
An array of points defining a curve.
return[...].points [...] object カーブ上の点。
return[...].points[...].x * number カーブの点の、X座標。
return[...].points[...].y * number カーブの点の、Y座標。
return[...].points[...].shape * string この点から、次の点までの、カーブセグメントの形状。可能な値:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
return[...].stateProperties array An array of state properties to set.
return[...].stateProperties [...] string The name of the property to set.
return[...].stateGroups array The State Group objects associated with this object.
return[...].stateGroups [...] object A State Group object.
return[...].stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
return[...].stateGroups[...].name string The name of the State Group object.
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) any of: クエリを構成し、プロパティ値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを指定します。1つの@マークは、関連するオブジェクトのプロパティ値を示します。2つの@マークは、ソースがオーバーライドするプロパティ値を示します。使用可能なすべてのタイプの、プロパティやリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
string 文字列値。
array An array of string values.
number 数値。
array An array of numeric values.
boolean ブール値。
array An array of boolean values.
object オブジェクトのリファレンス値。
array オブジェクトリストのリファレンス値。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string 文字列値。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number 数値。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean ブール値。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string オブジェクト名。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object オブジェクトのリファレンス値。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id string オブジェクトのID（GUID）。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
return[...].regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string オブジェクト名。

結果スキーマ

例

Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。

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

サポートは必要ですか？

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

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

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

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

Wwiseからはじめよう