NoteGroupReference

NoteGroupReference

時間とピッチオフセット、および歌声 / データベースプロパティを持つ場合もある NoteGroup への参照。NoteGroup を言語コンテキストに置くので、歌詞から音素への変換やレンダリングが可能になります。

NoteGroupReference は常に Track の中に置かれます。NoteGroup は、複数の NoteGroupReference によって参照されることがあります。

継承

メソッド

clone() → {NoteGroupReference}

現在のオブジェクトの深いコピー。

注意: NoteGroupReference は参照対象NoteGroupの所有していないので、NoteGroup をコピーしません。

戻り値:
NoteGroupReference

getDuration() → {number}

現在の NoteGroupReference の長さ(ブリック)。

getEnd() - getOnset() に等しいです。

戻り値:
number

getEnd() → {number}

終了位置(ブリック)、つまり、対象 NoteGroup の最後のノートの終了位置に時間オフセットを加えたものを取得します。

NoteGroupReference がオーディオファイル(NoteGroupReference#isInstrumental)を保持している場合、getEnd() はオーディオの終了位置(ブリック)に時間オフセットを加えたものを返します。ただし、NoteGroupReferenceProject の中に配置されていない場合、オーディオの長さを音楽的に意味のある時間単位で決定するのに情報が十分でなく、getEnd() は長さがオーディオの長さが 0 であると仮定してしまいます。

戻り値:
number

getIndexInParent() → {number}

継承元:

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

戻り値:
number

getOnset() → {number}

開始位置(ブリック)を取得します。つまり、対象 NoteGroup 内の最初の Note の開始位置(ブリック)に時間オフセットを加えたものを取得します。

戻り値:
number

getParent() → {NestedObject|undefined}

継承元:

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

戻り値:
NestedObject | undefined

getPitchOffset() → {number}

対象 NoteGroup} 内のすべてのノートに適用されるピッチシフト(半音)を取得します。

戻り値:
number

getTarget() → {NoteGroup}

参照対象の NoteGroup を取得します。

戻り値:
NoteGroup

getTimeOffset() → {number}

対象 NoteGroup 内のすべてのノートに適用される時間オフセット(ブリック)を取得します。

戻り値:
number

getVoice() → {object}

現在のグループのデフォルト歌声プロパティを保持するオブジェクトを取得します。Note#getAttributes と同様です。

このオブジェクトには、以下のプロパティがあります。

  • tF0Left: number ピッチ - 長さ左(秒)
  • tF0Right: number ピッチ - 長さ右(秒)
  • dF0Left: number ピッチ - 深さ左(半音)
  • dF0Right: number ピッチ - 深さ右(半音)
  • tF0VbrStart: number ビブラート - 開始タイミング(秒)
  • tF0VbrLeft: number ビブラート - 左(秒)
  • tF0VbrRight: number ビブラート - 右(秒)
  • dF0Vbr: number ビブラート - 深さ(半音)
  • fF0Vbr: number ビブラート - 周波数(Hz)
  • paramLoudness: number パラメータ - ラウドネス(dB)
  • paramTension: number パラメータ - テンション
  • paramBreathiness: number パラメータ - ブレス
  • paramGender: number パラメータ - ジェンダー
戻り値:
object

isInstrumental() → {boolean}

この NoteGroupReference が外部のオーディオファイルを参照しているかどうか。そうである場合、NoteGroup は参照対象とならない。

戻り値:
boolean

isMain() → {boolean}

この NoteGroupReference が親 Track のメイングループを参照対象としているかどうか。

戻り値:
boolean

isMemoryManaged() → {boolean}

継承元:

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

戻り値:
boolean

setPitchOffset(pitchOffset)

ピッチオフセットを pitchOffset (半音)に設定する。

パラメータ:
名前 細細
pitchOffset number

setTarget(group)

参照対象の NoteGroup を設定します。

一度設定した参照対象は変更できないことに注意してください。

パラメータ:
名前 細細
group NoteGroup

setTimeOffset(blickOffset)

時間オフセットを blickOffset (ブリック)に設定します。

パラメータ:
名前 細細
blickOffset number

setVoice(attributes)

属性オブジェクトに基づいて歌声プロパティを設定します(NoteGroupReference#getVoice を参照)。属性オブジェクトは完全である必要はありません。与えられたプロパティのみが更新されます(Note#setAttributes を参照)。

パラメータ:
名前 細細
attributes object