Version

menu_open
Wwise SDK 2024.1.0
ak.wwise.waapi.getSchema

Retrieves the JSON schema of a Waapi URI.

Arguments

Name Type Description
uri * string Waapi URI (see ak.wwise.waapi.getTopics, ak.wwise.waapi.getFunctions).
includeExamples boolean Include the examples provided in the schema. Default value is false.

(Required *)

Arguments Schema

Result

Name Type Description
argsSchema object The argument schema. Only possible for functions.
optionsSchema object The option schema.
resultSchema object The result schema. Only possible for functions.
publishSchema object The publish schema. Only possible for topics.
examples array The examples provided in the schema.
examples [...] object The example.

Result Schema

See Also

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


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