Table of Contents

Wwise SDK 2018.1.11
ak.wwise.core.log.get


Retrieve the latest log for a specific channel. Refer to ak.wwise.core.log.itemAdded to be notified when a item is added to the log.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
channel * string The log channel.
Possible values : "soundbankGenerate", "conversion", "copyPlatformSettings"

(Required *)

Arguments Details


channel

description : The log channel.
type : string
Possible values : "soundbankGenerate", "conversion", "copyPlatformSettings"


Result

Name Type Description
items * array  

(Required *)

Result Details


items

type : array

resultSchema / items / ...

items

Reference : : See Arguments "logCentralItem"
description : The entries of the log.


Examples :

Retrieve the SoundBank log.

Use the channel 'soundbankGenerate' to retrieve the latest SoundBank generation log.

Arguments:

{
"channel": "soundbankGenerate"
}

Result:

{
"items": [
{
"severity": "Warning",
"time": 1523563779,
"messageId": 31,
"message": "RTPC : object New Audio Bus, property PositioningType cannot be resolved; the RTPC will be ignored.",
"platform": {
"id": "{F546017D-201A-49BD-8D4E-0A28F5DBB28D}",
"name": "Windows"
},
"parameters": [
"Init"
]
},
{
"severity": "Message",
"time": 1523563779,
"messageId": 0,
"message": "2 message(s), 2 warning(s), 0 error(s), 0 fatal error(s)"
}
]
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"channel": {
"description": "The log channel.",
"type": "string",
"enum": [
"soundbankGenerate",
"conversion",
"copyPlatformSettings"
]
}
},
"required": [
"channel"
],
"additionalProperties": false
}


Options :

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


Response :

{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/logCentralItem",
"description": "The entries of the log."
}
}
},
"required": [
"items"
],
"additionalProperties": false
}

Document version : 1