Table of Contents

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.

Arguments

Name Type Description
channel * string The log channel.
The log channel.
Possible values:
  • soundbankGenerate
  • conversion
  • copyPlatformSettings
  • waapi
  • projectLoad
  • general

(Required *)

Arguments Schema

Result

Name Type Description
items * array The entries of the log.
items[...] object A log entry.
A log entry.
items[...].severity * string Message: not impacting the integrity of the current operation. Warning: potentially impacting the integrity of the current operation. Error: impacting the integrity of the current operation. Fatal Error: impacting the completion of the current operation.
Possible values:
  • Message
  • Warning
  • Error
  • Fatal Error
items[...].parameters array An array of parameters in the log item. Not present when no parameter.
items[...].parameters[...] string A parameter of the log entry. Normally an object name.
items[...].time * integer Number of seconds elapsed since midnight (00:00:00), January 1, 1970, Coordinated Universal Time (UTC), according to the system clock.
items[...].platform object The platform for which the log item was reported.
A Wwise object. Use the return options to specify which property is required.
items[...].platform.soundbank:bnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac.
items[...].platform.objectSize integer The amount of space (in bytes) the meta-data of the object will take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
items[...].platform.audioSource:maxDurationSource object Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
items[...].platform.audioSource:maxDurationSource.id string The ID (GUID) of the audio source object with longest duration.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.audioSource:maxDurationSource.trimmedDuration number The duration in seconds of the longest trimmed source.
items[...].platform.music:transitionRoot object The music transition root containing all other music transitions recursively.
items[...].platform.music:transitionRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.workunit:type string The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder".
Possible values:
  • folder
  • rootFile
  • nestedFile
items[...].platform.owner object The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
items[...].platform.owner.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.owner.name string The name of the object.
items[...].platform.mediaSize integer The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate.
items[...].platform.sound:originalWavFilePath string Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac.
items[...].platform.structureSize integer The amount of space (in bytes) the meta-data of the object and all of its children will take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
items[...].platform.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
items[...].platform.switchContainerChild:context object The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox).
items[...].platform.switchContainerChild:context.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.totalSize integer The amount of space (in bytes) this object and all of its children will take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate.
items[...].platform.type string The type of the object. Refer to Wwise Objects Reference for more information on the types available.
items[...].platform.workunit:isDefault boolean True if the work unit is the default.
items[...].platform.isPlayable boolean True if the object can be played in Transport.
items[...].platform.audioSource:trimValues object Range of time for which the audio source is trimmed.
items[...].platform.audioSource:trimValues.trimBegin number The time value in seconds of the start trim.
items[...].platform.audioSource:trimValues.trimEnd number The time value in seconds of the end trim.
items[...].platform.audioSource:maxRadiusAttenuation object Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
items[...].platform.audioSource:maxRadiusAttenuation.radius number The radius of the attenuation object.
items[...].platform.audioSource:maxRadiusAttenuation.id string The ID (GUID) of the attenuation object with the largest radius.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.parent object The parent of the object in the hierarchy.
items[...].platform.parent.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.parent.name string The name of the object.
items[...].platform.filePath string The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac.
items[...].platform.workunit:isDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.
items[...].platform.workunit object The parent Work Unit containing the object. The 'id' and the 'name' will be returned.
items[...].platform.workunit.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.workunit.name string The name of the object.
items[...].platform.shortId integer The short ID of the object.
items[...].platform.sound:convertedWemFilePath string Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac.
items[...].platform.audioSource:playbackDuration object The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
items[...].platform.audioSource:playbackDuration.playbackDurationMin number The minimum possible time playback can take.
items[...].platform.audioSource:playbackDuration.playbackDurationMax number The maximum possible time playback can take.
items[...].platform.audioSource:playbackDuration.playbackDurationType string The type of duration.
items[...].platform.path string The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
items[...].platform.music:playlistRoot object The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
items[...].platform.music:playlistRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.classId integer The class ID of the object.
Unsigned Integer 32-bit.
Range: [0,4294967295]
items[...].platform.name string The name of the object.
items[...].platform.audioSource:language object Language associated to the audio source. This only applies to Audio Source objects directly.
items[...].platform.audioSource:language.id string The ID (GUID) of the Language object to which the Audio Source object is associated.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.audioSource:language.name string The name of the Language object to which the Audio Source object is associated.
items[...].platform.notes string The notes of the object.
items[...].platform.childrenCount number The number of children for the object.
items[...].platform.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) any of: Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @ specifies the value of the property using the source of override. Refer to Wwise Objects Reference for more information on the properties and references for all types available.
string A string value.
number A numeric value.
boolean A boolean value.
object An object reference value.
items[...].platform.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
items[...].platform.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).name string The name of the object.
items[...].messageId * string The message ID for the log item.
items[...].message * string The description message of the log item.

(Required *)

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about WAAPI.