build_object_info_query
Construct a WAAPI object query with filters for path, type, fields, traversal, and name/type constraints. Use this to build queries for retrieving Wwise objects before executing them.
Instructions
Builds a WAAPI ak.wwise.core.object.get query dict from structured parameters. Use this to construct a query before calling execute_waapi_query.
Args: from_path: Root paths to query from. e.g. ["\Containers"] or ["\Events"] from_type: Object types to query from. e.g. ["Sound", "Event", "RandomSequenceContainer"] return_fields: Fields to return per object. Common: "id", "name", "type", "path", "shortId", "parent" select_transform: Traversal direction. One of: "descendants", "ancestors", "children", "parent" where_name_contains: Filter results to objects whose name contains this string. where_type_is: Filter results to specific object types. e.g. ["Sound", "BlendContainer"]
Examples: All descendants of Containers: from_path=["\Containers"], select_transform="descendants"
All Events containing "footstep":
from_path=["\Events"], select_transform="descendants",
where_name_contains="footstep", where_type_is=["Event"]
All busses:
from_path=["\Busses"], select_transform="descendants",
where_type_is=["Bus", "AuxBus"]
Children of a specific container:
from_path=["\Containers\Default Work Unit\SFX"],
select_transform="children"IMPORTANT — Inherited properties: Properties like @OutputBus return the LOCAL value, not the effective (inherited) value. If @OverrideOutput is false, the object inherits its output bus from an ancestor. To find the actual routing, query the object's ancestors (select_transform="ancestors") and return @OutputBus and @OverrideOutput to find the nearest ancestor that sets the effective bus.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from_path | No | ||
| from_type | No | ||
| return_fields | No | ||
| select_transform | No | ||
| where_name_contains | No | ||
| where_type_is | No |