Starts a command-line Wwise Authoring API server, to which client applications, using the Wwise Authoring API, can connect.

Examples

WwiseConsole waapi-server "C:\MyProject\MyProject.wproj" --allow-migration --wamp-port 8085

Loads MyProject.wproj and runs a WAAPI server. Migrates the project first if necessary. Uses WAMP port 8085 and default HTTP port 8090.

Arguments

[PROJECT]

(Optional) When no project is specified, no project is loaded. Refer to ak.wwise.console.project.open for information on how to open a project.
The path to the project file (.wproj).

Arguments Schema

Options

--allow-migration

Allow migration and save of the Wwise project before executing the operation.

--allowed-addr ADDRESS
--allowed-addr ADDRESS1,ADDRESS2,...

Specifies the IP addresses that are allowed to connect to WAAPI. This option must be followed by a comma-separated list, for example: "127.0.0.1". Default value is "127.0.0.1".

--allowed-origin HOST
--allowed-origin HOST1,HOST2,...

Specifies the hosts that are allowed to connect to WAAPI. This option must be followed by a comma-separated list, for example: "www.myhost.com,www.myhost2.com". Validation is performed on the HTTP header Origin. Connections that do not provide the Origin header, as well as file-based connections (for example: file://), are always allowed.

--http-max-clients NUM

Specifies the maximum number of concurrent WAAPI clients that can connect to the server when using HTTP POST. This option must be followed by a number between 0 and 100. Using 0 prevents the server from running. Default value is 2.
Range: [0,100]

--http-port PORT

Specifies the port number used by WAAPI when using HTTP POST. This option must be followed by a port number between 0 and 65,535. Using 0 prevents the server from running. Default value is 8090.
Range: [0,65535]

--no-source-control

Skip automatic checkout (if supported by project's source control plugin) of migrated files from source control.

--quiet

Disables all non-error console text output.

--verbose

Enables extra console text output.

--wamp-max-clients NUM

Specifies the maximum number of concurrent WAAPI clients that can connect to the server when using WAMP. This option must be followed by a number between 0 and 100. Using 0 prevents the server from running. Default value is 5.
Range: [0,100]

--wamp-port PORT

Specifies the port number used by WAAPI when using WAMP. This option, which takes precedence over the User Preferences, must be followed by a port number between 0 and 65,535. Using 0 prevents the server from running. Default value is 8080.
Range: [0,65535]

Options Schema

Result

A WwiseConsole.exe exit code of 0 means success, 1 means at least one error (and potentially warnings) occurred, and 2 means that only warnings occurred.

Result Schema

Refer to Using the Command Line for more information about Wwise Console.