目录

Wwise SDK 2018.1.11
ak.wwise.core.getInfo


Retrieve global Wwise information.

Supported by

Graphical User Interface, Command-Line Interface.

Result

Name Type Description
apiVersion number Version of the Wwise Authoring API.
displayName string Display Name of Wwise.
branch string Branch built.
copyright string Copyright information.
version object  
configuration string Indicate a release or debug build.
Possible values : "release", "debug"
platform string Indicate the platform on which Wwise was built.
Possible values : "x64", "win32"
isCommandLine boolean Indicate if Wwise is running in command line.
processId integer The process identifier of Wwise.
processPath string The process path of Wwise.
directories object  

Result Details


apiVersion

type : number
minimum : 1
description : Version of the Wwise Authoring API.

displayName

type : string
pattern : Wwise
description : Display Name of Wwise.

branch

type : string
minLength : 1
description : Branch built.

copyright

type : string
minLength : 1
description : Copyright information.

version

type : object

Name Type Description
displayName string Wwise version name.
year integer Year of version.
major integer Major number of version.
minor integer Minor number of version.
build integer Build number.
nickname string Special name given to a version.
schema integer Schema version for the Wwise Project and Work Units.


configuration

type : string
Possible values : "release", "debug"
description : Indicate a release or debug build.

platform

type : string
Possible values : "x64", "win32"
description : Indicate the platform on which Wwise was built.

isCommandLine

type : boolean
description : Indicate if Wwise is running in command line.

processId

type : integer
description : The process identifier of Wwise.

processPath

type : string
description : The process path of Wwise.

directories

type : object

Name Type Description
install string The root directory of Wwise. This is the installation directory.
authoring string The Wwise Authoring root directory
bin string The bin directory, where Wwise.exe is located.
log string The log directory.
help string The help directory.
user string The Wwise user data directory root.

description :


Examples :

Getting information about Wwise

Gets information about the currently connected Wwise.

Arguments:

{}

Result:

{
"displayName": "Wwise",
"platform": "x64",
"directories": {
"log": "C:\\Projects\\Wwise\\Authoring\\source\\App\\",
"help": "C: \\Projects\\Wwise\\Authoring\\Help\\",
"user": "%APPDATA%\\Audiokinetic\\Wwise\\",
"install": "C: \\Projects\\Wwise\\",
"authoring": "C:\\Projects\\Wwise\\Authoring\\",
"bin": "C: \\Projects\\Wwise\\Authoring\\source\\App\\"
},
"branch": "v2016.2/wwise_main",
"configuration": "debug",
"version": {
"displayName": "v2017.1.0",
"nickname": "",
"build": 83,
"minor": 0,
"year": 2017,
"major": 1
},
"copyright": "\u00a9 2006-2017. Audiokinetic Inc. All rights reserved.",
"apiVersion": 1
}


Detailed JSON Schema


Arguments :

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


Options :

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


Response :

{
"type": "object",
"properties": {
"apiVersion": {
"type": "number",
"minimum": 1,
"description": "Version of the Wwise Authoring API."
},
"displayName": {
"type": "string",
"pattern": "Wwise",
"description": "Display Name of Wwise."
},
"branch": {
"type": "string",
"minLength": 1,
"description": "Branch built."
},
"copyright": {
"type": "string",
"minLength": 1,
"description": "Copyright information."
},
"version": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"minLength": 1,
"description": "Wwise version name."
},
"year": {
"type": "integer",
"minimum": 2000,
"maximum": 2100,
"description": "Year of version."
},
"major": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Major number of version."
},
"minor": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Minor number of version."
},
"build": {
"type": "integer",
"minimum": 1,
"description": "Build number."
},
"nickname": {
"type": "string",
"description": "Special name given to a version."
},
"schema": {
"type": "integer",
"minimum": 1,
"description": "Schema version for the Wwise Project and Work Units."
}
}
},
"configuration": {
"type": "string",
"enum": [
"release",
"debug"
],
"description": "Indicate a release or debug build."
},
"platform": {
"type": "string",
"enum": [
"x64",
"win32"
],
"description": "Indicate the platform on which Wwise was built."
},
"isCommandLine": {
"type": "boolean",
"description": "Indicate if Wwise is running in command line."
},
"processId": {
"type": "integer",
"description": "The process identifier of Wwise."
},
"processPath": {
"type": "string",
"description": "The process path of Wwise."
},
"directories": {
"type": "object",
"properties": {
"install": {
"type": "string",
"minLength": 1,
"description": "The root directory of Wwise. This is the installation directory."
},
"authoring": {
"type": "string",
"minLength": 1,
"description": "The Wwise Authoring root directory"
},
"bin": {
"type": "string",
"minLength": 1,
"description": "The bin directory, where Wwise.exe is located."
},
"log": {
"type": "string",
"minLength": 1,
"description": "The log directory."
},
"help": {
"type": "string",
"minLength": 1,
"description": "The help directory."
},
"user": {
"type": "string",
"minLength": 1,
"description": "The Wwise user data directory root."
}
},
"description": ""
}
}
}

Document version : 1