版本
menu
Wwise SDK 2023.1.14
ak.soundengine.getState 结果架构

架构

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

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅