Project

工程

可用的最大的对象，包含了 音轨 、 时间轴 、音符组 等。

扩展

• 嵌套对象

方法

addNoteGroup

addNoteGroup(group, suggestedIndex) → {number}

在 suggestedIndex 处插入一个音符组 。如果 suggestedIndex 没有给出，则该 音符组 将会被添加到末尾。其返回新增 音符组 的索引。

参数：

参数名	类型	描述
group	音符组
suggestedIndex	数字	可选

返回：

类型：数字

addTrack

addTrack(track) → {number}

将一个 音轨 添加到 项目 中。返回新增 音轨 的索引。

参数：

参数名	类型	描述
track	轨道

返回：

类型：数字

getDuration

getDuration() → {number}

获取该 项目 的持续时间（blicks），其由最长 音轨` 的持续时间所决定。

返回：

类型：数字

getFileName

getFileName() → {string}

获取该工程在文件系统中的绝对路径

返回：

类型：字符串

getIndexInParent

getIndexInParent() → {number}

继承自：嵌套对象 - getIndexInParent

获取在父级对象中当前对象的索引。在 Lua 中索引从 1 开始，在 JavaScript 中索引从 0 开始。

getNoteGroup

getNoteGroup(id) → {NoteGroup|undefined}

如果 id 为一个数字，则获取该项目库中的第 id 个 音符组 。

如果 id 为一个字符串，则在该项目库中寻找 UUID 为 id 的 音符组 ；如果这样的 音符组 不存在，则返回 undefined 。

参数：

参数名	类型	描述
id	数字 | 字符串

返回：

类型：音符组 | undefined

getNumNoteGroupsInLibrary

getNumNoteGroupsInLibrary() → {number}

获取该 音符组 在项目的音符组库中的编号。

该函数不会统计主音符组，并且与 音符组引用 的编号无关。

返回：

类型：数字

getNumTracks

getNumTracks() → {number}

获取音轨数量。

返回：

类型：数字

getParent

getParent() → {NestedObject|undefined}

继承自：嵌套对象 - getParent

获取父级 嵌套对象 。如果不存在则返回 undefined。

返回：

类型：嵌套对象 | undefined

getTimeAxis

getTimeAxis() → {TimeAxis}

获取当前 项目 的 时间轴 对象。

返回：

类型： 时间轴

getTrack

getTrack(index) → {Track}

获取第 index 个 音轨 。索引（index）是基于存储顺序而非显示顺序。

参数：

参数名	类型	描述
index	数字

返回：

类型：轨道

isMemoryManaged

isMemoryManaged() → {boolean}

继承自：嵌套对象 - isMemoryManaged

检测选中的对象是否被内存管理（即脚本环境的垃圾回收）。

返回：

类型：布尔

newUndoRecord

newUndoRecord()

为当前 项目 新增一个撤销记录。也就是说，当用户按下 Ctrl + Z 或 Ctrl + Y 时，在最后一条撤销记录之后的所有编辑都会一起被撤销 / 重做。

在脚本开始执行时，新的撤销记录会自动添加到当前打开的项目中。

removeNoteGroup

removeNoteGroup(index)

从项目音符组库中移除第 index 个 音符组 。其也会移除所有引用了该 音符组 的 音符组引用 。

参数：

参数名	类型	描述
index	数字

removeTrack

removeTrack(index)

从该 项目 中移除第 index 个 音轨 。

参数名	类型	描述
index	数字