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