Version
menu_open
Wwise SDK 2022.1.12
ak.wwise.core.object.get Arguments Schema

Schema

{
"type": "object",
"properties": {
"waql": {
"type": "string",
"description": "Specifies a query in the WAQL language. Refer to \\ref waql_introduction for more information."
},
"from": {
"description": "The query starting point. Note, this is deprecated. The WAQL argument should be used instead.",
"oneOf": [
{
"type": "object",
"description": "Specify an object with an id field.",
"properties": {
"id": {
"type": "array",
"description": "An array of object IDs, either GUID or Short ID (uint32).",
"items": {
"description": "A GUID or Short ID (uint32).",
"oneOf": [
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "object",
"description": "A Wwise object Short ID with its associated type.",
"properties": {
"shortId": {
"type": "integer",
"description": "The Short ID of the object.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
},
"type": {
"type": "integer",
"minimum": 1,
"description": "This syntax is deprecated and we recommend the use of WAQL. The type of object for the Short ID. The type \u00e2\u20ac\u2039\u00e2\u20ac\u2039can be 10 (Event), 12 (SwitchGroup), 14 (StateGroup), 17 (EffectPlugin), 18 (SoundBank), 19 (Bus), 20 (AuxBus), 22 (GameParameter), 41 (Trigger) or 68 (AudioDevicePlugin)"
}
},
"required": [
"shortId",
"type"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Specifies an object with a search field.",
"properties": {
"search": {
"type": "array",
"description": "An array of text tokens used for searching the project.",
"items": {
"description": "A search token.",
"type": "string"
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"search"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Specifies an object with a name field.",
"properties": {
"name": {
"type": "array",
"description": "An array of unique object qualified names.",
"items": {
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "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"
}
}
},
"required": [
"name"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Specifies an object with a path field.",
"properties": {
"path": {
"type": "array",
"description": "An array of object paths.",
"items": {
"type": "string",
"pattern": "^\\\\",
"description": "A project path to a Wwise object, including the category and the work-unit. For example: \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\New Sound SFX."
}
}
},
"required": [
"path"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Specify an object with an ofType field.",
"properties": {
"ofType": {
"type": "array",
"description": "An array of object types.",
"items": {
"description": "An object type. Refer to \\ref wobjects_index for a list of types.",
"type": "string"
}
}
},
"required": [
"ofType"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Specifies an object with a query field.",
"properties": {
"query": {
"type": "array",
"description": "An array of query object ID.",
"items": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"query"
],
"additionalProperties": false
}
]
},
"transform": {
"type": "array",
"description": "Array of sequential transformations chained on the object list returned by \"from\".",
"items": {
"description": "An object transformation.",
"oneOf": [
{
"type": "object",
"description": "An select transformation.",
"properties": {
"select": {
"type": "array",
"description": "An array of only 1 selector.",
"items": {
"type": "string",
"description": "A selector. The resulting objects depend on the selector specified.",
"enum": [
"parent",
"children",
"descendants",
"ancestors",
"referencesTo"
]
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"select"
],
"additionalProperties": false
},
{
"type": "string",
"description": "Unique object instances are returned, i.e. no duplicate object is returned.",
"enum": [
"distinct"
]
},
{
"type": "object",
"description": "Specifies an object with a range field.",
"properties": {
"range": {
"type": "array",
"description": "An array of two numbers specifying the boundary indexes. Use this to only include a portion of the results. For example, this could be used to obtain the 100 first items of a search result: [0,100].",
"items": {
"description": "One of the two range limit numbers.",
"type": "number"
},
"minItems": 2,
"maxItems": 2
}
},
"required": [
"range"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Specifies an object with an where field.",
"properties": {
"where": {
"type": "array",
"description": "An array of two tokens to filter results. The first token is the filter predicate. Refer \\ref waapi_query for the list of possible predicates. The second token is the parameter to the predicate.",
"items": {
"description": "A where statement.",
"anyOf": [
{
"type": "string",
"description": "A string token. The first token in the array is always the 'where' predicate name string. The second token is the parameter."
},
{
"type": "array",
"description": "An array of strings. Refer \\ref waapi_query for more information.",
"items": {
"type": "string",
"description": "The parameter for the 'where' predicate. Refer \\ref waapi_query for more information."
}
}
]
},
"minItems": 1
}
},
"required": [
"where"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise