menu
search
language
English
Français
日本語
한국어
中文
Wwise
arrow_drop_down
Strata
arrow_drop_down
Solutions
arrow_drop_down
Learning
arrow_drop_down
Community
arrow_drop_down
Documentation
arrow_drop_down
Help
arrow_drop_down
Sign In
Download
 
Version
2018.1.11.6987
arrow_drop_down

2024.1.5.8803

2023.1.13.8732

2022.1.19.8584

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624

menu
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

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