Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8
ak.wwise.ui.project.open

Opens a project, specified by path. Please refer to ak.wwise.core.project.loaded for further explanations on how to be notified when the operation has completed.

Arguments

Name Type Description
path * string The path to the project WPROJ file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
onUpgrade string (DEPRECATED) The action to be executed when opening a project that needs to be upgraded. Note, this is deprecated. Please use onMigrationRequired instead. Possible values:
  • migrate
  • fail
onMigrationRequired string The action to be executed when opening a project that needs to be migrated. Possible values:
  • migrate
  • fail
bypassSave boolean Indicates if the user should not be prompted to save the current project. Defaults to true.
autoCheckOutToSourceControl boolean Determines if Wwise automatically performs a Checkout source control operation for affected work units and for the project. Defaults to true.

(Required *)

Arguments 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