Project - Synthesizer V Studio Scripting Manual

継承

NestedObject

メソッド

addNoteGroup(group, suggestedIndex) → {number}

プロジェクトライブラリの添え字 suggestedIndex の位置に NoteGroup を挿入します。suggestedIndexが与えられていない場合は、NoteGroup を末尾に追加します。追加された NoteGroup の添え字を返します。

パラメータ：

名前	型	細細
`group`	NoteGroup
`suggestedIndex`	number	(optional)

戻り値：

型: number

addTrack(track) → {number}

Project に Track を追加します。追加された Track の添え字を返します。

パラメータ：

名前	型	細細
`track`	Track

戻り値：

型: number

getDuration() → {number}

Project の長さ（ブリック）を取得します。最長の Track の長さとして定義されています。

戻り値：

型: number

getFileName() → {string}

このプロジェクトのファイルシステム上での絶対パスを取得します。

戻り値：

型: string

getIndexInParent() → {number}

継承元：

NestedObject#getIndexInParent

現在のオブジェクトの、親の中での添え字を取得します。Lua では、添え字は 1 から始まります。JavaScript では、添え字は 0 から始まります。

戻り値：

型: number

getNoteGroup(id) → {NoteGroup|undefined}

id が数値の場合、プロジェクトライブラリの id 番目の NoteGroup を取得します。

id が文字列の場合、プロジェクトライブラリの中で id を UUID とする NoteGroup を取得します。そのような NoteGroup が存在しない場合は undefined を返します。

パラメータ：

名前	型	細細
`id`	number \| string

戻り値：

型: NoteGroup | undefined

getNumNoteGroupsInLibrary() → {number}

プロジェクトライブラリの NoteGroup の数を取得します。

メイングループはカウントされず、NoteGroupReference の数とは無関係です。

戻り値：

型: number

getNumTracks() → {number}

トラックの数を取得します。

戻り値：

型: number

getParent() → {NestedObject|undefined}

継承元：

NestedObject#getParent

親 NestedObject を取得します。現在のオブジェクトが親に付いていない場合、undefined を返します。

戻り値：

型: NestedObject | undefined

getTimeAxis() → {TimeAxis}

この Project の TimeAxis オブジェクトを取得します。

戻り値：

型: TimeAxis

getTrack(index) → {Track}

添え字が index の Track を取得します。添え字は表示順ではなく、ストレージ配置順となります。

パラメータ：

名前	型	細細
`index`	number

戻り値：

型: Track

isMemoryManaged() → {boolean}

継承元：

NestedObject#isMemoryManaged

現在のオブジェクトがメモリ管理されているかどうか（スクリプト環境によってガベージコレクションされるか）を確認します。

戻り値：

型: boolean

newUndoRecord()

この Project に新しい編集記録を追加する。ユーザが Ctrl + Z / Ctrl + Y を押したとき、最後の編集記録に続くすべての編集が一緒に元に戻される / やり直されることを意味します。

スクリプトの実行開始時に、現在開いているプロジェクトに新しい編集記録が自動的に追加されます。

removeNoteGroup(index)

プロジェクトライブラリから index 番目の NoteGroup を削除します。NoteGroup を参照しているすべての NoteGroupReference も削除されます。

パラメータ：

名前	型	細細
`index`	number

removeTrack(index)

Project から index 番目の Track を削除します。

パラメータ：

名前	型	細細
`index`	number