Version

menu_open
Wwise SDK 2024.1.0
ak.wwise.cli.waapiServer Options Schema

Schema

{
"properties": {
"verbose": {
"type": "boolean",
"description": "Enables extra console text output.",
"synopsis": [
"--verbose"
]
},
"quiet": {
"type": "boolean",
"description": "Disables all non-error console text output.",
"synopsis": [
"--quiet"
]
},
"allowed-addr": {
"type": "string",
"description": "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\".",
"synopsis": [
"--allowed-addr ADDRESS",
"--allowed-addr ADDRESS1,ADDRESS2,..."
]
},
"allowed-origin": {
"type": "string",
"description": "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.",
"synopsis": [
"--allowed-origin HOST",
"--allowed-origin HOST1,HOST2,..."
]
},
"http-port": {
"type": "number",
"description": "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.",
"synopsis": [
"--http-port PORT"
],
"minimum": 0,
"maximum": 65535
},
"wamp-port": {
"type": "number",
"description": "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.",
"synopsis": [
"--wamp-port PORT"
],
"minimum": 0,
"maximum": 65535
},
"http-max-clients": {
"type": "number",
"description": "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.",
"synopsis": [
"--http-max-clients NUM"
],
"minimum": 0,
"maximum": 100
},
"wamp-max-clients": {
"type": "number",
"description": "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.",
"synopsis": [
"--wamp-max-clients NUM"
],
"minimum": 0,
"maximum": 100
},
"allow-migration": {
"type": "boolean",
"description": "Allow migration and save of the Wwise project before executing the operation.",
"synopsis": [
"--allow-migration"
]
},
"no-source-control": {
"type": "boolean",
"description": "Skip automatic checkout (if supported by project's source control plugin) of migrated files from source control.",
"synopsis": [
"--no-source-control"
]
},
"watchdog-timeout": {
"type": "integer",
"minimum": 0,
"description": "Time in seconds to set as a watchdog threshold. The watchdog is signaled every time a WAAPI function call is made. By default, the value is 0 and the watchdog is disabled.",
"synopsis": [
"--watchdog-timeout 30"
]
}
}
}

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