Version

menu_open
Wwise SDK 2019.1.11
ak.wwise.core.object.get Arguments Schema

Schema

{
"additionalProperties": false,
"required": [
"from"
],
"type": "object",
"properties": {
"from": {
"oneOf": [
{
"additionalProperties": false,
"required": [
"id"
],
"type": "object",
"description": "Specify an object with an id field.",
"properties": {
"id": {
"items": {
"oneOf": [
{
"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}\\}$",
"type": "string",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"additionalProperties": false,
"required": [
"shortId",
"type"
],
"type": "object",
"description": "A Wwise object short ID with its associated type.",
"properties": {
"shortId": {
"minimum": 0,
"type": "integer",
"description": "The short ID of the object.\\n Unsigned Integer 32-bit.",
"maximum": 4294967295
},
"type": {
"minimum": 1,
"type": "integer",
"description": "The type of object for the short ID. Refer to \\ref wobjects_index for object types."
}
}
}
],
"description": "A GUID or short ID (uint32)."
},
"type": "array",
"description": "An array of object IDs, either GUID or short ID (uint32)."
}
}
},
{
"additionalProperties": false,
"required": [
"search"
],
"type": "object",
"description": "Specify an object with a search field.",
"properties": {
"search": {
"minItems": 1,
"items": {
"type": "string",
"description": "A search token."
},
"type": "array",
"description": "An array of text tokens used for searching the project.",
"maxItems": 1
}
}
},
{
"additionalProperties": false,
"required": [
"name"
],
"type": "object",
"description": "Specify an object with a name field.",
"properties": {
"name": {
"items": {
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$",
"type": "string",
"description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01"
},
"type": "array",
"description": "An array of object unique qualified names."
}
}
},
{
"additionalProperties": false,
"required": [
"path"
],
"type": "object",
"description": "Specify an object with a path field.",
"properties": {
"path": {
"items": {
"pattern": "^\\\\",
"type": "string",
"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."
},
"type": "array",
"description": "An array of object paths."
}
}
},
{
"additionalProperties": false,
"required": [
"ofType"
],
"type": "object",
"description": "Specify an object with an ofType field.",
"properties": {
"ofType": {
"items": {
"type": "string",
"description": "An object type. Refer to \\ref wobjects_index for a list of types."
},
"type": "array",
"description": "An array of object types."
}
}
},
{
"additionalProperties": false,
"required": [
"query"
],
"type": "object",
"description": "Specify an object with a query field.",
"properties": {
"query": {
"minItems": 1,
"items": {
"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}\\}$",
"type": "string",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"type": "array",
"description": "An array of query object ID.",
"maxItems": 1
}
}
}
],
"description": "The query starting point."
},
"transform": {
"items": {
"oneOf": [
{
"additionalProperties": false,
"required": [
"select"
],
"type": "object",
"description": "An select transformation.",
"properties": {
"select": {
"minItems": 1,
"items": {
"enum": [
"parent",
"children",
"descendants",
"ancestors",
"referencesTo"
],
"type": "string",
"description": "A selector. The resulting objects depend on the selector specified."
},
"type": "array",
"description": "An array of only 1 selector.",
"maxItems": 1
}
}
},
{
"enum": [
"distinct"
],
"type": "string",
"description": "Unique object instances are returned, i.e. no duplicate object is returned."
},
{
"additionalProperties": false,
"required": [
"range"
],
"type": "object",
"description": "Specify an object with a range field.",
"properties": {
"range": {
"minItems": 2,
"items": {
"type": "number",
"description": "One of the two range limit numbers."
},
"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].",
"maxItems": 2
}
}
},
{
"additionalProperties": false,
"required": [
"where"
],
"type": "object",
"description": "Specify an object with an where field.",
"properties": {
"where": {
"minItems": 1,
"items": {
"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."
},
{
"items": {
"type": "string",
"description": "The parameter for the where predicate. Refer \\ref waapi_query for more information."
},
"type": "array",
"description": "An array of strings. Refer \\ref waapi_query for more information."
}
],
"description": "A where statement."
},
"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. Example: \\ref ak_wwise_core_object_get_example_get_the_descendant_objects_matching_a_filter ."
}
}
}
],
"description": "An object transformation."
},
"type": "array",
"description": "Array of sequential transformations chained on the object list returned by \"from\"."
}
}
}

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise