Table of Contents

Wwise SDK 2018.1.11
ak.wwise.waapi.getSchema


Retrieve the JSON schema of a Waapi URI.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
uri * string Waapi URI (see ak.wwise.waapi.getTopics, ak.wwise.waapi.getFunctions).

(Required *)

Arguments Details


uri

type : string
description : Waapi URI (see ak.wwise.waapi.getTopics, ak.wwise.waapi.getFunctions).


Result

Name Type Description
argsSchema object  
optionsSchema object  
resultSchema object  
publishSchema object  

Result Details


argsSchema

type : object

Name Type Description


optionsSchema

type : object

Name Type Description


resultSchema

type : object

Name Type Description


publishSchema

type : object

Name Type Description


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Waapi URI (see ak.wwise.waapi.getTopics, ak.wwise.waapi.getFunctions)."
}
},
"required": [
"uri"
],
"additionalProperties": false
}


Options :

{
"type": "object",
"properties": {},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {
"argsSchema": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"optionsSchema": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"resultSchema": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"publishSchema": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"additionalProperties": false
}

Document version : 1