Wwise SDK 2018.1.11

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.

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
path *	string	The path to the project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
onUpgrade	string	The action to be done when opening a project that needs to be upgraded. Possible values : "migrate", "fail"
bypassSave	boolean	Indicate if the user should not be prompted to save the currently opened project.

(Required *)

Arguments Details

path

type : string
pattern : .wproj$
description : The path to the project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

onUpgrade

type : string
Possible values : "migrate", "fail"
description : The action to be done when opening a project that needs to be upgraded.

bypassSave

type : boolean
description : Indicate if the user should not be prompted to save the currently opened project.

Examples :

Open a project

Opens the .wproj project specified in by path.

Arguments:

{
    "path": "C:\\projects\\myWwiseProject.wproj", 
    "bypassSave": false
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "path": {
            "type": "string", 
            "pattern": "\\.wproj$", 
            "description": "The path to the project file."
        }, 
        "onUpgrade": {
            "type": "string", 
            "enum": [
                "migrate", 
                "fail"
            ], 
            "description": "The action to be done when opening a project that needs to be upgraded."
        }, 
        "bypassSave": {
            "type": "boolean", 
            "description": "Indicate if the user should not be prompted to save the currently opened project."
        }
    }, 
    "required": [
        "path"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Response :

{
    "type": "object", 
    "properties": {}, 
    "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.

Get started with Wwise