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