menu
 
Version
2024.1.6.8842

2024.1.6.8842

2023.1.14.8770

2025.1.0.8897

2022.1.19.8584

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624

menu

Wwise SDK 2024.1.6
ak.wwise.cli.convertExternalSource 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"
]
},
"source-file": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies the WSOURCES files to use. Those WSOURCES files are used for all platforms.",
"synopsis": [
"--source-file FILE",
"--source-file FILE1 FILE2 ..."
]
},
"source-by-platform": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "Specifies the WSOURCES files to use by platform. When specified for a specific platform, it overrides the WSOURCES files from the project settings for this platform. For platforms for which this is not specified, the project settings are used. Specify the platform first, then the WSOURCES files to use for this platform. Repeat the operation for each platform and WSOURCES file.",
"synopsis": [
"--source-by-platform PLATFORM FILE",
"--source-by-platform PLATFORM1 FILE1 --source-by-platform PLATFORM2 FILE2 ..."
]
},
"platform": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies for which platforms the sources are converted using the project settings. This option must be followed by the platform identifiers.",
"synopsis": [
"--platform PLATFORM",
"--platform PLATFORM1 PLATFORM2 ...",
"--platform PLATFORM1 --platform PLATFORM2 ..."
]
},
"output": {
"oneOf": [
{
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
]
},
{
"type": "string"
}
],
"description": "Allows you to follow this option with a platform, and a path to an output directory to override the output directory of this platform. Repeat this option for other platforms. If only an output directory is specified, sources for all platforms are generated in that directory.",
"synopsis": [
"--output PLATFORM PATH",
"--output PLATFORM1 PATH1 --output PLATFORM2 PATH2 ...",
"--output PATH"
]
}
}
}

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