Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.getProjectInfo Result Schema

Schema

{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The Project name. Note that the Project name can differ from the WPROJ file name, if the file was renamed after Project creation."
},
"displayTitle": {
"type": "string",
"description": "The complete text from the Wwise titlebar."
},
"path": {
"type": "string",
"description": "The absolute path to the WPROJ file."
},
"id": {
"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": "Project id.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"isDirty": {
"type": "boolean",
"description": "True if the Project or any of the Work Units have unsaved changes."
},
"currentLanguageId": {
"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": "The current Language set in the user interface.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"referenceLanguageId": {
"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": "The reference Language set in the Language settings.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"currentPlatformId": {
"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": "The current Platform set in the user interface.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"languages": {
"type": "array",
"description": "Array of the Languages defined in the project.",
"items": {
"type": "object",
"description": "Language defined in the project.",
"properties": {
"id": {
"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": "Language unique id.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "Language name."
},
"shortId": {
"type": "integer",
"description": "The short ID (32-bit) of the language.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"id",
"name",
"shortId"
],
"additionalProperties": false
}
},
"platforms": {
"type": "array",
"description": "Array of the Platforms defined in the project.",
"items": {
"type": "object",
"description": "Platform defined in the project.",
"properties": {
"id": {
"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": "Platform unique id.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "Platform name defined in the Project."
},
"baseName": {
"type": "string",
"description": "The name of the deployment platform used in file system."
},
"baseDisplayName": {
"type": "string",
"description": "The official name of the deployment platform. The name could contain special characters."
},
"soundBankPath": {
"type": "string",
"description": "The path on which the SoundBank files are generated for this Platform."
},
"copiedMediaPath": {
"type": "string",
"description": "The path on which the SoundBank media files are copied for this Platform."
}
},
"required": [
"id",
"name",
"baseName",
"baseDisplayName",
"soundBankPath",
"copiedMediaPath"
],
"additionalProperties": false
}
},
"defaultConversion": {
"type": "object",
"description": "The default Conversion Settings object used in the Project.",
"properties": {
"id": {
"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": "Conversion Settings unique id.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "Conversion Settings object name."
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"directories": {
"type": "object",
"description": "Collection of directories used by Wwise.",
"properties": {
"root": {
"type": "string",
"description": "The root directory of the project, where is located the wproj file."
},
"cache": {
"type": "string",
"description": "The .cache directory of the project, as specified in the Project Settings. The .cache directory contains converted media files (WEM files)."
},
"originals": {
"type": "string",
"description": "The Originals directory of the project, as specified in the Project Settings. The Originals directory contains the project's WAV files, separated by languages."
},
"soundBankOutputRoot": {
"type": "string",
"description": "The SoundBank output root directory of the project, as specified in the Project Settings. This directory contains the Project's SoundBank C++ header, XML and JSON files. Refer to the 'platforms' section for Platform specific directories."
},
"commands": {
"type": "string",
"description": "The Commands directory of the project. Refer to \\ref defining_custom_commands for more information."
},
"properties": {
"type": "string",
"description": "The root directory of the project. Refer to \\ref defining_custom_properties for more information."
}
},
"required": [
"root",
"cache",
"originals",
"soundBankOutputRoot",
"commands",
"properties"
],
"additionalProperties": false
}
},
"required": [
"name",
"displayTitle",
"path",
"id",
"isDirty",
"currentLanguageId",
"referenceLanguageId",
"languages",
"currentPlatformId",
"platforms",
"defaultConversion",
"directories"
],
"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