Wwise SDK 2025.1.0
|
检索有关当前所打开工程的信息,包括平台、语言和工程目录。
名称 | 类型 | 说明 |
---|---|---|
name * | string | Project 名称。注意,若在创建 Project 后对文件进行了重命名,Project 名称可能跟 WPROJ 文件名称不同。 |
displayTitle * | string | Wwise 标题栏的完整文本。 |
path * | string | WPROJ 文件的绝对路径。 |
id * | string | Project ID。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
isDirty * | boolean | 若 Project 或 Work Unit 有未保存的更改,则返回 true。 |
currentLanguageId * | string | 用户界面中设置的当前 Language。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
referenceLanguageId * | string | Language 设置中设定的参考 Language。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
currentPlatformId * | string | 用户界面中设置的当前 Platform。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
languages * | array | 此数组中包含工程中定义的 Language。 |
languages [...] | object | 工程中定义的 Language。 |
languages[...].id * | string | Language 唯一 ID。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
languages[...].name * | string | Language 名称。 |
languages[...].shortId * | integer | 语言的 Short ID(32 位)。 32 位无符号整数。范围:[0,4294967295] |
platforms * | array | 此数组中包含工程中定义的 Platform。 |
platforms [...] | object | 工程中定义的 Platform。 |
platforms[...].id * | string | Platform 唯一 ID。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
platforms[...].name * | string | Project 中定义的 Platform 名称。 |
platforms[...].baseName * | string | 文件系统中所用部署平台的名称。 |
platforms[...].baseDisplayName * | string | 部署平台的正式名称。该名称可能包含特殊字符。 |
platforms[...].soundBankPath * | string | 在该路径针对此 Platform 生成 SoundBank 文件。 |
platforms[...].copiedMediaPath * | string | 在该路径针对此 Platform 复制 SoundBank 媒体文件。 |
defaultConversion * | object | Project 中所用的默认 Conversion Settings 对象。 |
defaultConversion.id * | string | Conversion Settings 唯一 ID。 以下形式的对象 GUID:{aabbcc00-1122-3344-5566-77889900aabb}。 |
defaultConversion.name * | string | Conversion Settings 对象名称。 |
directories * | object | Wwise 所用的各项目录。 |
directories.root * | string | 工程的根目录(wproj 文件所在位置)。 |
directories.cache * | string | 工程的 .cache 目录(如 Project Settings 中指定)。.cache 目录下包含转码后媒体文件(WEM 文件)。 |
directories.originals * | string | 工程的 Originals 目录(如 Project Settings 中指定)。Originals 目录下包含工程的 WAV 文件(按语言分组存放)。 |
directories.soundBankOutputRoot * | string | 工程的 SoundBank 输出根目录(如 Project Settings 中指定)。此目录下包含 Project 的 SoundBank C++ 头文件、XML 和 JSON 文件。See the 'platforms' section for Platform specific directories. |
directories.commands * | string | 工程的 Commands 目录。See 定义命令扩展 for more information. |
directories.properties * | string | 工程的根目录。See 定义自定义属性 for more information. |
defaultWorkUnits | object | Default work units organized by category. |
defaultWorkUnits.Busses * | object | The work unit information. |
defaultWorkUnits.Busses.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Busses.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Busses.path * | string | Path in the Project. |
defaultWorkUnits.Busses.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Containers * | object | The work unit information. |
defaultWorkUnits.Containers.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Containers.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Containers.path * | string | Path in the Project. |
defaultWorkUnits.Containers.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Events * | object | The work unit information. |
defaultWorkUnits.Events.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Events.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Events.path * | string | Path in the Project. |
defaultWorkUnits.Events.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Switches * | object | The work unit information. |
defaultWorkUnits.Switches.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Switches.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Switches.path * | string | Path in the Project. |
defaultWorkUnits.Switches.filePath * | string | Absolute path in file system. |
defaultWorkUnits.States * | object | The work unit information. |
defaultWorkUnits.States.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.States.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.States.path * | string | Path in the Project. |
defaultWorkUnits.States.filePath * | string | Absolute path in file system. |
defaultWorkUnits.SoundBanks * | object | The work unit information. |
defaultWorkUnits.SoundBanks.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.SoundBanks.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.SoundBanks.path * | string | Path in the Project. |
defaultWorkUnits.SoundBanks.filePath * | string | Absolute path in file system. |
defaultWorkUnits.GameParameters * | object | The work unit information. |
defaultWorkUnits.GameParameters.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.GameParameters.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.GameParameters.path * | string | Path in the Project. |
defaultWorkUnits.GameParameters.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Effects * | object | The work unit information. |
defaultWorkUnits.Effects.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Effects.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Effects.path * | string | Path in the Project. |
defaultWorkUnits.Effects.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Devices * | object | The work unit information. |
defaultWorkUnits.Devices.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Devices.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Devices.path * | string | Path in the Project. |
defaultWorkUnits.Devices.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Presets * | object | The work unit information. |
defaultWorkUnits.Presets.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Presets.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Presets.path * | string | Path in the Project. |
defaultWorkUnits.Presets.filePath * | string | Absolute path in file system. |
defaultWorkUnits.SoundcasterSessions * | object | The work unit information. |
defaultWorkUnits.SoundcasterSessions.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.SoundcasterSessions.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.SoundcasterSessions.path * | string | Path in the Project. |
defaultWorkUnits.SoundcasterSessions.filePath * | string | Absolute path in file system. |
defaultWorkUnits.MixingSessions * | object | The work unit information. |
defaultWorkUnits.MixingSessions.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.MixingSessions.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.MixingSessions.path * | string | Path in the Project. |
defaultWorkUnits.MixingSessions.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Queries * | object | The work unit information. |
defaultWorkUnits.Queries.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Queries.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Queries.path * | string | Path in the Project. |
defaultWorkUnits.Queries.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Triggers * | object | The work unit information. |
defaultWorkUnits.Triggers.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Triggers.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Triggers.path * | string | Path in the Project. |
defaultWorkUnits.Triggers.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Attenuations * | object | The work unit information. |
defaultWorkUnits.Attenuations.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Attenuations.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Attenuations.path * | string | Path in the Project. |
defaultWorkUnits.Attenuations.filePath * | string | Absolute path in file system. |
defaultWorkUnits.DynamicDialogue * | object | The work unit information. |
defaultWorkUnits.DynamicDialogue.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.DynamicDialogue.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.DynamicDialogue.path * | string | Path in the Project. |
defaultWorkUnits.DynamicDialogue.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Conversions * | object | The work unit information. |
defaultWorkUnits.Conversions.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Conversions.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Conversions.path * | string | Path in the Project. |
defaultWorkUnits.Conversions.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Modulators * | object | The work unit information. |
defaultWorkUnits.Modulators.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Modulators.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Modulators.path * | string | Path in the Project. |
defaultWorkUnits.Modulators.filePath * | string | Absolute path in file system. |
defaultWorkUnits.ControlSurfaceSessions * | object | The work unit information. |
defaultWorkUnits.ControlSurfaceSessions.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.ControlSurfaceSessions.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.ControlSurfaceSessions.path * | string | Path in the Project. |
defaultWorkUnits.ControlSurfaceSessions.filePath * | string | Absolute path in file system. |
defaultWorkUnits.VirtualAcoustics * | object | The work unit information. |
defaultWorkUnits.VirtualAcoustics.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.VirtualAcoustics.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.VirtualAcoustics.path * | string | Path in the Project. |
defaultWorkUnits.VirtualAcoustics.filePath * | string | Absolute path in file system. |
defaultWorkUnits.Metadatas * | object | The work unit information. |
defaultWorkUnits.Metadatas.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultWorkUnits.Metadatas.name * | string | Name of the Work Unit in the Project. |
defaultWorkUnits.Metadatas.path * | string | Path in the Project. |
defaultWorkUnits.Metadatas.filePath * | string | Absolute path in file system. |
defaultImportWorkUnit | object | The default location to import WAV and MIDI files as sounds and music segments. The work unit information. |
defaultImportWorkUnit.id * | string | Work Unit unique id. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
defaultImportWorkUnit.name * | string | Name of the Work Unit in the Project. |
defaultImportWorkUnit.path * | string | Path in the Project. |
defaultImportWorkUnit.filePath * | string | Absolute path in file system. |
(必填 *)
有关 Wwise Authoring API 的详细信息,请参阅 使用 Wwise Authoring API(WAAPI) 章节。