Version
menu_open
Wwise SDK 2024.1.0
ak.wwise.core.getProjectInfo

Retrieve information about the current project opened, including platforms, languages and project directories.

Result

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

(Required *)

Result Schema

See Also

Examples

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