Wwise SDK 2025.1.0
|
在对象被删除后发送。See ak.wwise.core.object.structureChanged to receive changes in batch.
名称 | 类型 | 说明 |
---|---|---|
return | array | 每次删除对象后返回的数据。 此数组中包含一系列 return 表达式,用于定义所要返回的 Wwise 对象元素。这可能包括内置访问器(如名称或 ID)或对象属性(如 Volume 或 Pitch)。 |
return [...] | any of: | return 表达式。 |
string | 为 Wwise 对象指定一个或多个内置访问器。可能的值:
| |
string | 指定一个或多个点号分隔的访问器,来构建查询并生成数值或对象引用。若指定一个 @,则返回关联对象的属性值。若指定两个 @,则返回 override 对应源的属性值。参阅 Wwise 对象参考 章节。 | |
platform | string | 平台的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
名称 | 类型 | 说明 |
---|---|---|
object * | object | 被删除的对象。 Wwise 对象。使用 return 选项来指定所需的属性。 |
object.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.name | string | 对象的名称。 |
object.notes | string | 对象的备注。 |
object.type | string | 对象的类型。有关可用类型的详细信息,请参阅 Wwise 对象参考 章节。 |
object.pluginName | string | Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。 |
object.path | string | 工程根目录下的对象路径。Ex: '\Containers\Default Work Unit\Sound1' |
object.parent | object | 层级结构下的对象的父对象。 |
object.parent.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.parent.name | string | 对象的名称。 |
object.owner | object | 对象的所有者。此项适用于其他对象在本地拥有的对象(如自定义效果器、自定义衰减等)。 |
object.owner.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.owner.name | string | 对象的名称。 |
object.isPlayable | boolean | 若对象可在 Transport 中播放,则返回 true。 |
object.shortId | integer | 对象的 Short ID。 |
object.classId | integer | 对象的 Class ID。 32 位无符号整数。范围:[0,4294967295] |
object.category | string | 对象的类别。Ex: 'Containers' |
object.filePath | string | 对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.workunit | object | 对象所在的父级 Work Unit。返回 'id' 和 'name'。 |
object.workunit.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.workunit.name | string | 对象的名称。 |
object.childrenCount | number | 对象的子对象数量。注意,此项已弃用。The same result can be obtained with children.count(). |
object.totalSize | integer | 此对象及其所有子对象在 SoundBank 中占用的空间大小(字节)。此项不包括 objectSize。注意,需生成 SoundBank 方可确保此数值的准确性。 |
object.mediaSize | integer | 此对象及其所有子对象的媒体文件的 Converted Size 总和(字节)。注意,需生成 SoundBank 方可确保此数值的准确性。 |
object.objectSize | integer | 对象的元数据在 SoundBank 中占用的空间大小(字节)。此项不包括媒体文件。注意,需生成 SoundBank 方可确保此数值的准确性。 |
object.structureSize | integer | 对象及其所有子对象的元数据在 SoundBank 中占用的空间大小(字节)。此项不包括媒体文件。注意,需生成 SoundBank 方可确保此数值的准确性。 |
object.musicTransitionRoot | object | (DEPRECATED) The music transition root containing all other music transitions recursively. 注意,此项已弃用。The TransitionRoot reference should be used instead. |
object.musicTransitionRoot.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.musicPlaylistRoot | object | (DEPRECATED) The music playlist root containing all other music playlist items recursively. 此项仅适用于 Music Playlist Container。注意,此项已弃用。The PlaylistRoot reference should be used instead. |
object.musicPlaylistRoot.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.musicTransitionObject | object | The music transition segment. |
object.musicTransitionObject.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.originalWavFilePath | string | (已弃用)原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.originalFilePath | string | 原始文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.originalRelativeFilePath | string | Relative (from project's Originals Folder) path to the original file. 仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.activeSource | object | 声音对象的活跃音频源。 |
object.activeSource.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.activeSource.name | string | 对象的名称。 |
object.convertedWemFilePath | string | (已弃用)转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.convertedFilePath | string | 转码后文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.soundbankBnkFilePath | string | 所生成的 SoundBank 文件的绝对路径,该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
object.playbackDuration | object | 包含最小/最大时长和时长类型的 Duration 根对象。注意,此项已弃用。应当改用时长。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
object.playbackDuration.playbackDurationMin | number | The minimum possible time (in seconds) playback can take. |
object.playbackDuration.playbackDurationMax | number | The maximum possible time (in seconds) playback can take. |
object.playbackDuration.playbackDurationType | string | 时长的类型。 |
object.duration | object | 包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
object.duration.min | number | The minimum possible time (in seconds) playback can take. |
object.duration.max | number | The maximum possible time (in seconds) playback can take. |
object.duration.type | string | 时长的类型。 |
object.maxDurationSource | object | 时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
object.maxDurationSource.id | string | 时长最长的 Audio Source 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.maxDurationSource.trimmedDuration | number | 修剪的最长音频源的时长(秒)。 |
object.audioSourceTrimValues | object | 修剪的音频源的时间范围。 |
object.audioSourceTrimValues.trimBegin | number | Trim Start 的时间值(秒)。 |
object.audioSourceTrimValues.trimEnd | number | Trim End 的时间值(秒)。 |
object.maxRadiusAttenuation | object | 半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
object.maxRadiusAttenuation.id | string | 半径最长的 Attenuation 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.maxRadiusAttenuation.radius | number | Attenuation 对象的半径。 |
object.audioSourceLanguage | object | 与音频源关联的语言。此项仅直接适用于 Audio Source 对象。 |
object.audioSourceLanguage.id | string | 与 Audio Source 对象关联的 Language 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.audioSourceLanguage.name | string | 与 Audio Source 对象关联的 Language 对象的名称。 |
object.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. |
object.originalNormalChannelCount | number | The number of channels in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalHeightChannelCount | number | The number of channels in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalLFEChannelCount | number | The number of low frequency channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalNonLFEChannelCount | number | The number of normal and height channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalAnonymousChannelCount | number | The number of anonymous channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalAmbisonicsChannelCount | number | The number of ambisonics channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.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. |
object.originalChannelMask | number | The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalSampleRate | number | The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.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. |
object.originalFileSize | number | The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalDataSize | number | The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalSampleCount | number | The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.originalDuration | number | The file duration in seconds. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.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. |
object.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. |
object.convertedNormalChannelCount | number | The number of channels in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedHeightChannelCount | number | The number of channels in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedLFEChannelCount | number | The number of low frequency channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedNonLFEChannelCount | number | The number of normal and height channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedAnonymousChannelCount | number | The number of anonymous channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedAmbisonicsChannelCount | number | The number of ambisonics channels in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.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. |
object.convertedChannelMask | number | The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedSampleRate | number | The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedSampleRateSetting | string | The sample rate for the audio source, expressed as a string. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.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. |
object.convertedFileSize | number | The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedDataSize | number | The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedSampleCount | number | The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedDuration | number | The file duration in seconds. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.convertedTrimmedDuration | number | The duration (in seconds) of the trimmed audio source. 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. |
object.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. |
object.conversionFormat | string | The format specified in the Conversion Settings for the associated audio source. This differs from convertedCodec because the file does not have to be converted. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips. |
object.workunitIsDefault | boolean | 若为 Default Work Unit,则返回 true。 |
object.workunitType | string | Work Unit 的类型。请注意,物理文件夹与 Work Unit 一样,类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值:
|
object.workunitIsDirty | boolean | 若 Work Unit 或工程(wproj 文件)处于未同步状态(即修改了而没保存),则返回 true。 |
object.workunitIsLoaded | boolean | True if a Work Unit is currently loaded in the Project. False if it has been unloaded. |
object.switchContainerChildContext | object | 与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性(对 Switch Container 来说,与上下文相关)。比如,'1st only' 复选框的属性。 |
object.switchContainerChildContext.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.switchGroupGameParameter | object | The game parameter object associated with a Switch Group. |
object.switchGroupGameParameter.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.switchGroupGameParameter.name | string | 对象的名称。 |
object.isExplicitMute | boolean | 对象是否已被显式设为 Mute 状态。若对象显式被设为 Mute 状态,则将子级对象隐式设为 Mute 状态。 |
object.isExplicitSolo | boolean | 对象是否已被显式设为 Solo 状态。若对象被设为 Solo 状态,则将工程中除此之外的所有其他对象静音。 |
object.isImplicitMute | boolean | 对象是否已被隐式设为 Mute 状态。若对象显式被设为 Mute 状态,则将子级对象隐式设为 Mute 状态。 |
object.isImplicitSolo | boolean | 对象是否已被隐式设为 Solo 状态。若对象被设为 Solo 状态,则将工程中除此之外的所有其他对象静音。 |
object.isIncluded | boolean | Whether or not the object is Included. 指定选项中的平台。This takes into consideration the Inclusion status of the object's ancestors. |
object.isLanguageIncluded | boolean | Whether or not the Audio Source object's language is included for the current platform. |
object.points | array | 此项仅适用于 Curve 对象。 此数组中包含定义曲线的控制点。 |
object.points [...] | object | 曲线上的控制点。 |
object.points[...].x * | number | 曲线控制点的 X 坐标。 |
object.points[...].y * | number | 曲线控制点的 Y 坐标。 |
object.points[...].shape * | string | 这一控制点和下一控制点之间曲线线段的形状。可能的值:
|
object.stateProperties | array | An array of state properties to set. |
object.stateProperties [...] | string | The name of the property to set. |
object.stateGroups | array | The State Group objects associated with this object. |
object.stateGroups [...] | object | A State Group object. |
object.stateGroups[...].id | string | The ID (GUID) of the State Group object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
object.stateGroups[...].name | string | The name of the State Group object. |
object.definedStates | array | The Custom State objects associated with this object that have defined values. |
object.definedStates [...] | object | A State object. |
object.definedStates[...].id | string | The ID (GUID) of the State object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
object.definedStates[...].name | string | The name of the State object. |
object.supportsStates | boolean | Whether or not the object supports the use of States on any of its properties. |
object.supportsRandomizer | boolean | Whether or not the object supports the use of a Randomizer on any of its properties. |
object.hasEmptySwitchStateAssignment | boolean | Returns true if there are empty objects or paths assigned to any Switches or States this object uses. |
object.extractEvents | array | The Event objects extracted from the current SoundBank. |
object.extractEvents [...] | object | An event. |
object.extractEvents[...].id | string | The ID (GUID) of the Event object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
object.extractEvents[...].name | string | The name of the Event object. |
object.extractStructures | array | The object structures extracted from the current SoundBank. |
object.extractStructures [...] | object | An object, which is not an Event. |
object.extractStructures[...].id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
object.extractStructures[...].name | string | 对象的名称。 |
object.extractMedia | array | The Media files extracted from the current SoundBank. |
object.extractMedia [...] | string | A media file path. |
object.soundbanksReferencingEvent | array | The SoundBank objects referencing the current event object. |
object.soundbanksReferencingEvent [...] | object | A SoundBank object. |
object.soundbanksReferencingEvent[...].id | string | The ID (GUID) of the SoundBank object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
object.soundbanksReferencingEvent[...].name | string | The name of the SoundBank object. |
object.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 | 对象列表引用值。 | |
object.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | string | 字符串值。 |
object.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | number | 数字值。 |
object.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | boolean | 布尔值。 |
object.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}。 |
object.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name | string | 对象的名称。 |
object.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] | object | 对象引用值。 |
object.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}。 |
object.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name | string | 对象的名称。 |
(必填 *)
有关 Wwise Authoring API 的详细信息,请参阅 使用 Wwise Authoring API(WAAPI) 章节。