版本
menu_open
Wwise SDK 2024.1.0
ak.wwise.core.soundbank.generate

Generate a list of SoundBanks with the import definition specified in the WAAPI request. If you do not write the SoundBanks to disk, subscribe to ak.wwise.core.soundbank.generated to receive SoundBank structure info and the bank data as base64. Note: This is a synchronous operation.

参数

名称 类型 说明
soundbanks array 此数组中包含所要生成的 SoundBank。
soundbanks [...] object SoundBank 信息。
soundbanks[...].name * string 所要生成的 SoundBank 的名称。若 SoundBank 不存在，则创建临时 SoundBank。
soundbanks[...].events array 该数组中列有此 SoundBank 中所要包含的 Event。若 SoundBank 已存在，则无需使用此项。
soundbanks[...].events [...] any of: SoundBank 中所要包含的 Event 的 ID (GUID)、名称或路径。
string 由类型或 Short ID 限定的对象名称，格式为 type:name 或 Global:shortId。仅支持采用全局唯一名称或 Short Id 的对象类型。例如：Event:Play_Sound_01, Global:245489792
string 以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
string Wwise 对象的工程路径，包含类别和 Work Unit。例如：\Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX。
soundbanks[...].auxBusses array 该数组中列有此 SoundBank 中所要包含的 AuxBus。
soundbanks[...].auxBusses [...] any of: SoundBank 中所要包含的 Auxiliary Bus 的 ID (GUID)、名称或路径。
string 由类型或 Short ID 限定的对象名称，格式为 type:name 或 Global:shortId。仅支持采用全局唯一名称或 Short Id 的对象类型。例如：Event:Play_Sound_01, Global:245489792
string 以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
string Wwise 对象的工程路径，包含类别和 Work Unit。例如：\Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX。
soundbanks[...].inclusions array 该数组中包含此 SoundBank 所要使用的 Inclusion 类型。若 SoundBank 已存在，则无需使用此项。
soundbanks[...].inclusions [...] string 可能的值：
  • event
  • structure
  • media
soundbanks[...].rebuild boolean 强制重新构建这一 SoundBank。默认值：false。
platforms array 此数组中包含所要生成的平台。若不指定任何平台，则将生成所有平台。
platforms [...] string 平台的 ID (GUID) 或名称。
languages array 此数组中包含所要生成的语言。若不指定任何语言，则将生成所有语言。
languages [...] string 语言的 ID (GUID) 或名称。
skipLanguages boolean 在默认情况下，若不指定任何语言，则将生成所有语言。若将此参数设为 true，则不生成任何本地化 SoundBank。
rebuildSoundBanks boolean 若为 true，则重新构建所有 SoundBank。若要同时清理经过转码的媒体，请使用 clearAudioFileCache 参数。默认值：false。
clearAudioFileCache boolean 在对源文件进行转码并生成 SoundBank 前，删除 Wwise 音频文件缓存文件夹所含内容，以此来确保所有源文件都会重新进行转码。注意，无论是否使用平台参数，都会将所有平台的缓存清空。默认值：false。
writeToDisk boolean 使用正常的 SoundBank 生成流程，并将 SoundBank 及信息文件写入到磁盘中。默认值：false。
rebuildInitBank boolean 若不使用 rebuildSoundBanks，请使用此选项来针对各个给定平台强制重新构建 Init Bank。

参数架构

Result

名称 类型 说明
logs array SoundBank 生成日志。The log is empty when used in WwiseConsole.
logs [...] object 日志条目。
logs[...].severity * string
  • Message: Does not affect the integrity of the current operation. - Warning: Might affect the integrity of the current operation. - Error: Affects the integrity of the current operation. - Fatal Error: Prevents the completion of the current operation. 可能的值：
    • Message
    • Warning
    • Error
    • Fatal Error
logs[...].time * integer 从 1970 年 1 月 1 日午夜 (00:00:00) 开始所经过的秒数，按协调世界时 (UTC) 算，依据系统时钟得出。
logs[...].messageId * string 日志条目的消息 ID。
logs[...].message * string 日志条目的描述消息。
logs[...].platform object 报告日志条目的平台 ID 和名称。
logs[...].platform.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.name string 对象的名称。
logs[...].platform.notes string 对象的备注。
logs[...].platform.type string 对象的类型。有关可用类型的详细信息，请参阅 Wwise 对象参考 章节。
logs[...].platform.pluginName string Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。
logs[...].platform.path string 工程根目录下的对象路径。例如：'\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
logs[...].platform.parent object 层级结构下的对象的父对象。
logs[...].platform.parent.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.parent.name string 对象的名称。
logs[...].platform.owner object 对象的所有者。此项适用于其他对象在本地拥有的对象（如自定义效果器、自定义衰减等）。
logs[...].platform.owner.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.owner.name string 对象的名称。
logs[...].platform.isPlayable boolean 若对象可在 Transport 中播放，则返回 true。
logs[...].platform.shortId integer 对象的 Short ID。
logs[...].platform.classId integer 对象的 Class ID。
32 位无符号整数。范围：[0,4294967295]
logs[...].platform.category string 对象的类别。例如：'Actor-Mixer Hierarchy'
logs[...].platform.filePath string 对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.workunit object 对象所在的父级 Work Unit。返回 'id' 和 'name'。
logs[...].platform.workunit.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.workunit.name string 对象的名称。
logs[...].platform.childrenCount number 对象的子对象数量。注意，此项已弃用。The same result can be obtained with children.count().
logs[...].platform.totalSize integer 此对象及其所有子对象在 SoundBank 中占用的空间大小（字节）。此项不包括 objectSize。注意，需生成 SoundBank 方可确保此数值的准确性。
logs[...].platform.mediaSize integer 此对象及其所有子对象的媒体文件的 Converted Size 总和（字节）。注意，需生成 SoundBank 方可确保此数值的准确性。
logs[...].platform.objectSize integer 对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
logs[...].platform.structureSize integer 对象及其所有子对象的元数据在 SoundBank 中占用的空间大小（字节）。此项不包括媒体文件。注意，需生成 SoundBank 方可确保此数值的准确性。
logs[...].platform.musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. 注意，此项已弃用。The TransitionRoot reference should be used instead.
logs[...].platform.musicTransitionRoot.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. 此项仅适用于 Music Playlist Container。注意，此项已弃用。The PlaylistRoot reference should be used instead.
logs[...].platform.musicPlaylistRoot.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.originalWavFilePath string （已弃用）原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.originalFilePath string 原始文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. 仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.activeSource object 声音对象的活跃音频源。
logs[...].platform.activeSource.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.activeSource.name string 对象的名称。
logs[...].platform.convertedWemFilePath string （已弃用）转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.convertedFilePath string 转码后文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.soundbankBnkFilePath string 所生成的 SoundBank 文件的绝对路径，该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI，请参阅 在 Mac 上使用 WAAPI 章节。
logs[...].platform.playbackDuration object 包含最小/最大时长和时长类型的 Duration 根对象。注意，此项已弃用。应当改用时长。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
logs[...].platform.playbackDuration.playbackDurationMin number 播放操作可能花费的最小时长。
logs[...].platform.playbackDuration.playbackDurationMax number 播放操作可能花费的最大时长。
logs[...].platform.playbackDuration.playbackDurationType string 时长的类型。
logs[...].platform.duration object 包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
logs[...].platform.duration.min number 播放操作可能花费的最小时长。
logs[...].platform.duration.max number 播放操作可能花费的最大时长。
logs[...].platform.duration.type string 时长的类型。
logs[...].platform.maxDurationSource object 时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
logs[...].platform.maxDurationSource.id string 时长最长的 Audio Source 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.maxDurationSource.trimmedDuration number 修剪的最长音频源的时长（秒）。
logs[...].platform.audioSourceTrimValues object 修剪的音频源的时间范围。
logs[...].platform.audioSourceTrimValues.trimBegin number Trim Start 的时间值（秒）。
logs[...].platform.audioSourceTrimValues.trimEnd number Trim End 的时间值（秒）。
logs[...].platform.maxRadiusAttenuation object 半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象（以源的形式直接实现，或通过下级对象间接实现）。
logs[...].platform.maxRadiusAttenuation.id string 半径最长的 Attenuation 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.maxRadiusAttenuation.radius number Attenuation 对象的半径。
logs[...].platform.audioSourceLanguage object 与音频源关联的语言。此项仅直接适用于 Audio Source 对象。
logs[...].platform.audioSourceLanguage.id string 与 Audio Source 对象关联的 Language 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.audioSourceLanguage.name string 与 Audio Source 对象关联的 Language 对象的名称。
logs[...].platform.originalTotalChannelCount number The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalNormalChannelCount number The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalHeightChannelCount number The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalLFEChannelCount number The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalChannelConfig string The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalBitDepth number The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalDuration number The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.originalCodec string The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedTotalChannelCount number The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedNormalChannelCount number The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedHeightChannelCount number The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedLFEChannelCount number The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedChannelConfig string The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedBitDepth number The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedDuration number The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.convertedCodec string The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
logs[...].platform.workunitIsDefault boolean 若为 Default Work Unit，则返回 true。
logs[...].platform.workunitType string Work Unit 的类型。请注意，物理文件夹与 Work Unit 一样，类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值：
  • folder
  • rootFile
  • nestedFile
logs[...].platform.workunitIsDirty boolean 若 Work Unit 或工程（wproj 文件）处于未同步状态（即修改了而没保存），则返回 true。
logs[...].platform.switchContainerChildContext object 与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性（对 Switch Container 来说，与上下文相关）。比如，'1st only' 复选框的属性。
logs[...].platform.switchContainerChildContext.id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.isExplicitMute boolean 对象是否已被显式设为 Mute 状态。若对象显式被设为 Mute 状态，则将子级对象隐式设为 Mute 状态。
logs[...].platform.isExplicitSolo boolean 对象是否已被显式设为 Solo 状态。若对象被设为 Solo 状态，则将工程中除此之外的所有其他对象静音。
logs[...].platform.isImplicitMute boolean 对象是否已被隐式设为 Mute 状态。若对象显式被设为 Mute 状态，则将子级对象隐式设为 Mute 状态。
logs[...].platform.isImplicitSolo boolean 对象是否已被隐式设为 Solo 状态。若对象被设为 Solo 状态，则将工程中除此之外的所有其他对象静音。
logs[...].platform.isIncluded boolean Whether or not the object is Included. 指定选项中的平台。This takes into consideration the Inclusion status of the object's ancestors.
logs[...].platform.points array 此项仅适用于 Curve 对象。
此数组中包含定义曲线的控制点。
logs[...].platform.points [...] object 曲线上的控制点。
logs[...].platform.points[...].x * number 曲线控制点的 X 坐标。
logs[...].platform.points[...].y * number 曲线控制点的 Y 坐标。
logs[...].platform.points[...].shape * string 这一控制点和下一控制点之间曲线线段的形状。可能的值：
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
logs[...].platform.stateProperties array An array of state properties to set.
logs[...].platform.stateProperties [...] string The name of the property to set.
logs[...].platform.stateGroups array The State Group objects associated with this object.
logs[...].platform.stateGroups [...] object A State Group object.
logs[...].platform.stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.stateGroups[...].name string The name of the State Group object.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) any of: 指定点号分隔的访问器，来构建查询并生成属性值或对象引用。若指定一个 @，则返回关联对象的属性值。若指定两个 @，则返回 override 对应源的属性值。如需详细了解所有可用类型的属性和引用，请参阅 Wwise 对象参考 章节。
string 字符串值。
array An array of string values.
number 数字值。
array An array of numeric values.
boolean 布尔值。
array An array of boolean values.
object 对象引用值。
array 对象列表引用值。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string 字符串值。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number 数字值。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean 布尔值。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string 对象的名称。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object 对象引用值。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id string 对象的 ID (GUID)。
以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string 对象的名称。
logs[...].parameters array 此数组中包含日志条目中的参数。若无参数，则不显示。
logs[...].parameters [...] string 日志条目中的参数。通常为对象名称。

结果架构

另请参阅

示例

有关 Wwise Authoring API 的详细信息，请参阅 使用 Wwise Authoring API（WAAPI） 章节。

此页面对您是否有帮助？

需要技术支持？

仍有疑问？或者问题？需要更多信息？欢迎联系我们，我们可以提供帮助！

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目，我们帮您快速入门，不带任何附加条件！

开始 Wwise 之旅