Wwise SDK 2022.1.17
|
在从另一对象的子对象移除对象时发送。
名称 | 类型 | 说明 |
---|---|---|
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}。 |
名称 | 类型 | 说明 |
---|---|---|
child * | object | 被移除的子对象。 Wwise 对象。使用 return 选项来指定所需的属性。 |
child.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.name | string | 对象的名称。 |
child.notes | string | 对象的备注。 |
child.type | string | 对象的类型。有关可用类型的详细信息,请参阅 Wwise 对象参考 章节。 |
child.pluginName | string | Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。 |
child.path | string | 工程根目录下的对象路径。例如:'\Actor-Mixer Hierarchy\Default Work Unit\Sound1' |
child.parent | object | 层级结构下的对象的父对象。 |
child.parent.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.parent.name | string | 对象的名称。 |
child.owner | object | 对象的所有者。此项适用于其他对象在本地拥有的对象(如自定义效果器、自定义衰减等)。 |
child.owner.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.owner.name | string | 对象的名称。 |
child.isPlayable | boolean | 若对象可在 Transport 中播放,则返回 true。 |
child.shortId | integer | 对象的 Short ID。 |
child.classId | integer | 对象的 Class ID。 32 位无符号整数。范围:[0,4294967295] |
child.category | string | 对象的类别。例如:'Actor-Mixer Hierarchy' |
child.filePath | string | 对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
child.workunit | object | 对象所在的父级 Work Unit。返回 'id' 和 'name'。 |
child.workunit.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.workunit.name | string | 对象的名称。 |
child.childrenCount | number | 对象的子对象数量。 |
child.totalSize | integer | 此对象及其所有子对象在 SoundBank 中占用的空间大小(字节)。此项不包括 objectSize。注意,需生成 SoundBank 方可确保此数值的准确性。 |
child.mediaSize | integer | 此对象及其所有子对象的媒体文件的 Converted Size 总和(字节)。注意,需生成 SoundBank 方可确保此数值的准确性。 |
child.objectSize | integer | 对象的元数据在 SoundBank 中占用的空间大小(字节)。此项不包括媒体文件。注意,需生成 SoundBank 方可确保此数值的准确性。 |
child.structureSize | integer | 对象及其所有子对象的元数据在 SoundBank 中占用的空间大小(字节)。此项不包括媒体文件。注意,需生成 SoundBank 方可确保此数值的准确性。 |
child.musicTransitionRoot | object | 包含其他所有以递归方式获取的 Music Transition 的 Music Transition 根对象。 |
child.musicTransitionRoot.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.musicPlaylistRoot | object | 包含其他所有以递归方式获取的 Music Playlist 条目的 Music Playlist 根对象。此项仅适用于 Music Playlist Container。 |
child.musicPlaylistRoot.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.originalWavFilePath | string | (已弃用)原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
child.originalFilePath | string | 原始文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
child.activeSource | object | 声音对象的活跃音频源。 |
child.activeSource.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.activeSource.name | string | 对象的名称。 |
child.convertedWemFilePath | string | (已弃用)转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
child.convertedFilePath | string | 转码后文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
child.soundbankBnkFilePath | string | 所生成的 SoundBank 文件的绝对路径,该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
child.playbackDuration | object | 包含最小/最大时长和时长类型的 Duration 根对象。注意,此项已弃用。应当改用时长。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
child.playbackDuration.playbackDurationMin | number | 播放操作可能花费的最小时长。 |
child.playbackDuration.playbackDurationMax | number | 播放操作可能花费的最大时长。 |
child.playbackDuration.playbackDurationType | string | 时长的类型。 |
child.duration | object | 包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
child.duration.min | number | 播放操作可能花费的最小时长。 |
child.duration.max | number | 播放操作可能花费的最大时长。 |
child.duration.type | string | 时长的类型。 |
child.maxDurationSource | object | 时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
child.maxDurationSource.id | string | 时长最长的 Audio Source 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.maxDurationSource.trimmedDuration | number | 修剪的最长音频源的时长(秒)。 |
child.audioSourceTrimValues | object | 修剪的音频源的时间范围。 |
child.audioSourceTrimValues.trimBegin | number | Trim Start 的时间值(秒)。 |
child.audioSourceTrimValues.trimEnd | number | Trim End 的时间值(秒)。 |
child.maxRadiusAttenuation | object | 半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
child.maxRadiusAttenuation.id | string | 半径最长的 Attenuation 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.maxRadiusAttenuation.radius | number | Attenuation 对象的半径。 |
child.audioSourceLanguage | object | 与音频源关联的语言。此项仅直接适用于 Audio Source 对象。 |
child.audioSourceLanguage.id | string | 与 Audio Source 对象关联的 Language 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.audioSourceLanguage.name | string | 与 Audio Source 对象关联的 Language 对象的名称。 |
child.workunitIsDefault | boolean | 若为 Default Work Unit,则返回 true。 |
child.workunitType | string | Work Unit 的类型。请注意,物理文件夹与 Work Unit 一样,类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值:
|
child.workunitIsDirty | boolean | 若 Work Unit 或工程(wproj 文件)处于未同步状态(即修改了而没保存),则返回 true。 |
child.switchContainerChildContext | object | 与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性(对 Switch Container 来说,与上下文相关)。比如,'1st only' 复选框的属性。 |
child.switchContainerChildContext.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
child.isExplicitMute | boolean | 对象是否已被显式设为 Mute 状态。若对象显式被设为 Mute 状态,则将子级对象隐式设为 Mute 状态。 |
child.isExplicitSolo | boolean | 对象是否已被显式设为 Solo 状态。若对象被设为 Solo 状态,则将工程中除此之外的所有其他对象静音。 |
child.isImplicitMute | boolean | 对象是否已被隐式设为 Mute 状态。若对象显式被设为 Mute 状态,则将子级对象隐式设为 Mute 状态。 |
child.isImplicitSolo | boolean | 对象是否已被隐式设为 Solo 状态。若对象被设为 Solo 状态,则将工程中除此之外的所有其他对象静音。 |
child.isIncluded | boolean | Whether or not the object is Included. 指定选项中的平台。This takes into consideration the Inclusion status of the object's ancestors. |
child.points | array | 此项仅适用于 Curve 对象。 此数组中包含定义曲线的控制点。 |
child.points [...] | object | 曲线上的控制点。 |
child.points[...].x * | number | 曲线控制点的 X 坐标。 |
child.points[...].y * | number | 曲线控制点的 Y 坐标。 |
child.points[...].shape * | string | 这一控制点和下一控制点之间曲线线段的形状。可能的值:
|
child.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) | any of: | 指定点号分隔的访问器,来构建查询并生成属性值或对象引用。若指定一个 @,则返回关联对象的属性值。若指定两个 @,则返回 override 对应源的属性值。如需详细了解所有可用类型的属性和引用,请参阅 Wwise 对象参考 章节。 |
string | 字符串值。 | |
number | 数字值。 | |
boolean | 布尔值。 | |
object | 对象引用值。 | |
array | 对象列表引用值。 | |
child.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}。 |
child.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).name | string | 对象的名称。 |
child.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) [...] | object | 对象引用值。 |
child.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}。 |
child.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$)[...].name | string | 对象的名称。 |
parent * | object | 移除了子对象的父对象。 Wwise 对象。使用 return 选项来指定所需的属性。 |
parent.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.name | string | 对象的名称。 |
parent.notes | string | 对象的备注。 |
parent.type | string | 对象的类型。有关可用类型的详细信息,请参阅 Wwise 对象参考 章节。 |
parent.pluginName | string | Source、Effect、Mixer、Device 和 Metadata 插件的插件名称。 |
parent.path | string | 工程根目录下的对象路径。例如:'\Actor-Mixer Hierarchy\Default Work Unit\Sound1' |
parent.parent | object | 层级结构下的对象的父对象。 |
parent.parent.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.parent.name | string | 对象的名称。 |
parent.owner | object | 对象的所有者。此项适用于其他对象在本地拥有的对象(如自定义效果器、自定义衰减等)。 |
parent.owner.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.owner.name | string | 对象的名称。 |
parent.isPlayable | boolean | 若对象可在 Transport 中播放,则返回 true。 |
parent.shortId | integer | 对象的 Short ID。 |
parent.classId | integer | 对象的 Class ID。 32 位无符号整数。范围:[0,4294967295] |
parent.category | string | 对象的类别。例如:'Actor-Mixer Hierarchy' |
parent.filePath | string | 对象所在文件的路径。该路径可为 Work Unit 文件或工程文件。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
parent.workunit | object | 对象所在的父级 Work Unit。返回 'id' 和 'name'。 |
parent.workunit.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.workunit.name | string | 对象的名称。 |
parent.childrenCount | number | 对象的子对象数量。 |
parent.totalSize | integer | 此对象及其所有子对象在 SoundBank 中占用的空间大小(字节)。此项不包括 objectSize。注意,需生成 SoundBank 方可确保此数值的准确性。 |
parent.mediaSize | integer | 此对象及其所有子对象的媒体文件的 Converted Size 总和(字节)。注意,需生成 SoundBank 方可确保此数值的准确性。 |
parent.objectSize | integer | 对象的元数据在 SoundBank 中占用的空间大小(字节)。此项不包括媒体文件。注意,需生成 SoundBank 方可确保此数值的准确性。 |
parent.structureSize | integer | 对象及其所有子对象的元数据在 SoundBank 中占用的空间大小(字节)。此项不包括媒体文件。注意,需生成 SoundBank 方可确保此数值的准确性。 |
parent.musicTransitionRoot | object | 包含其他所有以递归方式获取的 Music Transition 的 Music Transition 根对象。 |
parent.musicTransitionRoot.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.musicPlaylistRoot | object | 包含其他所有以递归方式获取的 Music Playlist 条目的 Music Playlist 根对象。此项仅适用于 Music Playlist Container。 |
parent.musicPlaylistRoot.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.originalWavFilePath | string | (已弃用)原始 wav 文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
parent.originalFilePath | string | 原始文件的绝对路径。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
parent.activeSource | object | 声音对象的活跃音频源。 |
parent.activeSource.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.activeSource.name | string | 对象的名称。 |
parent.convertedWemFilePath | string | (已弃用)转码后 wem 文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
parent.convertedFilePath | string | 转码后文件的绝对路径。指定选项中的平台。仅适用于 Sound 和 Audio Source 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
parent.soundbankBnkFilePath | string | 所生成的 SoundBank 文件的绝对路径,该文件与 SoundBank 对象关联。仅适用于 SoundBank 对象。如需了解如何在 Mac 上使用 WAAPI,请参阅 在 Mac 上使用 WAAPI 章节。 |
parent.playbackDuration | object | 包含最小/最大时长和时长类型的 Duration 根对象。注意,此项已弃用。应当改用时长。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
parent.playbackDuration.playbackDurationMin | number | 播放操作可能花费的最小时长。 |
parent.playbackDuration.playbackDurationMax | number | 播放操作可能花费的最大时长。 |
parent.playbackDuration.playbackDurationType | string | 时长的类型。 |
parent.duration | object | 包含最小/最大时长和时长类型的 Duration 根对象。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
parent.duration.min | number | 播放操作可能花费的最小时长。 |
parent.duration.max | number | 播放操作可能花费的最大时长。 |
parent.duration.type | string | 时长的类型。 |
parent.maxDurationSource | object | 时长最长的音频源。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
parent.maxDurationSource.id | string | 时长最长的 Audio Source 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.maxDurationSource.trimmedDuration | number | 修剪的最长音频源的时长(秒)。 |
parent.audioSourceTrimValues | object | 修剪的音频源的时间范围。 |
parent.audioSourceTrimValues.trimBegin | number | Trim Start 的时间值(秒)。 |
parent.audioSourceTrimValues.trimEnd | number | Trim End 的时间值(秒)。 |
parent.maxRadiusAttenuation | object | 半径最长的衰减。此项适用于可包含 Audio Source 对象的所有对象(以源的形式直接实现,或通过下级对象间接实现)。 |
parent.maxRadiusAttenuation.id | string | 半径最长的 Attenuation 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.maxRadiusAttenuation.radius | number | Attenuation 对象的半径。 |
parent.audioSourceLanguage | object | 与音频源关联的语言。此项仅直接适用于 Audio Source 对象。 |
parent.audioSourceLanguage.id | string | 与 Audio Source 对象关联的 Language 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.audioSourceLanguage.name | string | 与 Audio Source 对象关联的 Language 对象的名称。 |
parent.workunitIsDefault | boolean | 若为 Default Work Unit,则返回 true。 |
parent.workunitType | string | Work Unit 的类型。请注意,物理文件夹与 Work Unit 一样,类型都是 WorkUnit。物理文件夹的 workunitType 为 "folder"。可能的值:
|
parent.workunitIsDirty | boolean | 若 Work Unit 或工程(wproj 文件)处于未同步状态(即修改了而没保存),则返回 true。 |
parent.switchContainerChildContext | object | 与 Switch Container 的子对象关联的上下文对象。此对象具有与子对象关联的属性(对 Switch Container 来说,与上下文相关)。比如,'1st only' 复选框的属性。 |
parent.switchContainerChildContext.id | string | 对象的 ID (GUID)。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
parent.isExplicitMute | boolean | 对象是否已被显式设为 Mute 状态。若对象显式被设为 Mute 状态,则将子级对象隐式设为 Mute 状态。 |
parent.isExplicitSolo | boolean | 对象是否已被显式设为 Solo 状态。若对象被设为 Solo 状态,则将工程中除此之外的所有其他对象静音。 |
parent.isImplicitMute | boolean | 对象是否已被隐式设为 Mute 状态。若对象显式被设为 Mute 状态,则将子级对象隐式设为 Mute 状态。 |
parent.isImplicitSolo | boolean | 对象是否已被隐式设为 Solo 状态。若对象被设为 Solo 状态,则将工程中除此之外的所有其他对象静音。 |
parent.isIncluded | boolean | Whether or not the object is Included. 指定选项中的平台。This takes into consideration the Inclusion status of the object's ancestors. |
parent.points | array | 此项仅适用于 Curve 对象。 此数组中包含定义曲线的控制点。 |
parent.points [...] | object | 曲线上的控制点。 |
parent.points[...].x * | number | 曲线控制点的 X 坐标。 |
parent.points[...].y * | number | 曲线控制点的 Y 坐标。 |
parent.points[...].shape * | string | 这一控制点和下一控制点之间曲线线段的形状。可能的值:
|
parent.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) | any of: | 指定点号分隔的访问器,来构建查询并生成属性值或对象引用。若指定一个 @,则返回关联对象的属性值。若指定两个 @,则返回 override 对应源的属性值。如需详细了解所有可用类型的属性和引用,请参阅 Wwise 对象参考 章节。 |
string | 字符串值。 | |
number | 数字值。 | |
boolean | 布尔值。 | |
object | 对象引用值。 | |
array | 对象列表引用值。 | |
parent.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}。 |
parent.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).name | string | 对象的名称。 |
parent.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) [...] | object | 对象引用值。 |
parent.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}。 |
parent.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(\.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$)[...].name | string | 对象的名称。 |
(必填 *)
有关 Wwise Authoring API 的详细信息,请参阅 使用 Wwise Authoring API(WAAPI) 章节。