継承
メソッド
clone() → {Note}
現在のオブジェクトのディープコピー。
戻り値:
- 型
- Note
getAttributes() → {object}
ノートのプロパティを保持するオブジェクトを取得します。このオブジェクトには、以下のプロパティが含まれています。
rTone
:number
ラップ - トーン (1.9.0b2以降)rIntonation
:number
ラップ - イントネーション (1.9.0b2以降)dF0VbrMod
:number
ピッチ - ビブラートの強度 (1.9.0b2以降)expValueX
:number
表現コントロールX(2.1.1以降)expValueY
:number
表現コントロールY(2.1.1以降)phonemes
: 各音素の属性を格納したオブジェクトの配列(2.1.1以降)leftOffset
:number
音素の左オフセットposition
:number
音素の位置activity
:number
音素のアクティビティstrength
:number
発音の強さ
muted
:boolean
ノートがミュートされているかどうか(2.1.1以降)evenSyllableDuration
:boolean
複数の音節がある場合にノートを均等に分割するかどうか(2.1.1以降)languageOverride
:string
設定された値でグループの持つ言語設定を上書きします(2.1.1以降)phonesetOverride
:string
設定された値でグループの持つ音素セットの設定を上書きします(2.1.1以降)
バージョン1のみで利用可能なプロパティ:
tF0Offset
:number
ピッチ推移 - タイミング(秒)tF0Left
:number
ピッチ推移 - 長さ左(秒)tF0Right
:number
ピッチ推移 - 長さ右(秒)dF0Left
:number
ピッチ推移 - 深さ左(半音)dF0Right
:number
ピッチ推移 - 深さ右(半音)tF0VbrStart
:number
ビブラート - 開始タイミング(秒)tF0VbrLeft
:number
ビブラート - 左(秒)tF0VbrRight
:number
ビブラート - 右(秒)dF0Vbr
:number
ビブラート - 深さ(半音)pF0Vbr
:number
ビブラート - 位相(ラジアン、-π から π まで)fF0Vbr
:number
ビブラート - 周波数(Hz)tNoteOffset
:number
タイミングと音素 - ノートオフセット(秒)exprGroup
(optional):string
表現グループdur
: 音素長スケーリング用の要素number
の配列alt
: 代替発音用の要素number
の配列
ノートが属する NoteGroupReference
に基づくデフォルト値を使用している場合、数値プロパティの値は NaN となります。
戻り値:
- 型
- object
getDuration() → {number}
ノートの長さを取得します。単位はブリックです。
戻り値:
- 型
- number
getEnd() → {number}
ノートの終了位置(開始位置+長さ)を取得します。単位はブリックです。
戻り値:
- 型
- number
getIndexInParent() → {number}
現在のオブジェクトの、親の中での添え字を取得します。Lua では、添え字は 1 から始まります。JavaScript では、添え字は 0 から始まります。
戻り値:
- 型
- number
getLanguageOverride() → {string}
ノートに対して設定された言語を取得します。 このノートがグループ/トラックのデフォルト言語を使用している場合、この関数は空を返します。 (1.9.0b2以降でサポート)
戻り値:
- 型
- string
getLyrics() → {string}
現在のノートの歌詞を取得します。
戻り値:
- 型
- string
getMusicalType() → {string}
ノートの種類("sing"または"rap")を取得します。 (1.9.0b2以降でサポート)
戻り値:
- 型
- string
getOnset() → {number}
ノートの開始位置を取得します。単位はブリックです。
戻り値:
- 型
- number
getParent() → {NestedObject|undefined}
親 NestedObject
を取得します。現在のオブジェクトが親に付いていない場合、undefined
を返します。
戻り値:
- 型
- NestedObject | undefined
getPhonemes() → {string}
ユーザがノートに設定した音素をスペース区切りで返します。例: "hh ah ll ow" 。
音素が設定されていない場合は、デフォルトの発音ではなく空の文字列を返します(SV#getPhonemesForGroup
をご参照ください)。
戻り値:
- 型
- string
getPitch() → {number}
ピッチを MIDI ノート番号で取得します。C4 は 60 に対応します。
戻り値:
- 型
- number
getPitchAutoMode() → {boolean}
ノートのピッチモードを取得します:オートの場合はtrue、マニュアルの場合はfalse。 (1.9.0b2以降でサポート)
戻り値:
- 型
- boolean
getRapAccent() → {string}
ラップノートのアクセントを取得します(可能な場合)。 (1.9.0b2以降でサポート)
戻り値:
- 型
- string
getRetakes() → {RetakeList}
このノートのリテイクリストを取得します。
リテイクは、長さ、ピッチ、音色パラメータに異なるシード値を使用することで、同じノートに対して異なるレンダリングバリエーションを生成することを可能にします。
(2.1.1 以降でサポート)
戻り値:
isMemoryManaged() → {boolean}
現在のオブジェクトがメモリ管理されているかどうか(スクリプト環境によってガベージコレクションされるか)を確認します。
戻り値:
- 型
- boolean
setAttributes(object)
属性オブジェクトに基づいてノートプロパティを設定します。属性オブジェクトは完全である必要はありません。与えられたプロパティのみが更新されます。例えば、
note.setAttributes({
"dF0VbrMod" : 0.2,
"phonemes" : [
{ "leftOffset": -0.1, "position": 0.5, "strength": 0.8 },
{ "leftOffset": 0.05, "position": 0.7, "activity": 0.9 }
]
});
パラメータ:
名前 | 型 | 細細 |
---|---|---|
object |
attributes |
For the definition, see |
setDuration(t)
ノートの長さを t
に変更します。単位はブリックです。終了位置も変更されますが、開始位置は変更されません。
パラメータ:
名前 | 型 | 細細 |
---|---|---|
t |
number |
setLanguageOverride(language)
ノート単位に言語を設定し、トラックまたは、グループで設定された情報を上書きます。 次のオプションが設定可能です:"mandarin", "japanese", "english", "cantonese" (1.9.0b2以降でサポート)
パラメータ:
名前 | 型 | 細細 |
---|---|---|
language |
string |
setLyrics(lyrics)
歌詞を変更します。
パラメータ:
名前 | 型 | 細細 |
---|---|---|
lyrics |
string |
setMusicalType(type)
ノートのタイプ("sing"または"rap")を設定します。 (1.9.0b2以降でサポート)
パラメータ:
名前 | 型 | 細細 |
---|---|---|
type |
string |
setOnset(t)
ノートを t
から始まるように移動します。単位はブリックです。長さは変わりません。
パラメータ:
名前 | 型 | 細細 |
---|---|---|
t |
number |
setPhonemes(phoneme_str)
音素を phoneme_str
に変更します。例: "hh ah ll ow " 。
パラメータ:
名前 | 型 | 細細 |
---|---|---|
phoneme_str |
string |
A space-delimited list of phonemes. |
setPitch(pitchNumber)
ピッチを MIDI ノート番号 pitchNumber
に設定します。
パラメータ:
名前 | 型 | 細細 |
---|---|---|
pitchNumber |
number |
setPitchAutoMode(isAuto)
ノートのピッチモードにオートモード(true)、もしくはマニュアルモード(false)かを設定します。 (1.9.0b2以降でサポート)
パラメータ:
名前 | 型 | 細細 |
---|---|---|
isAuto |
boolean |
setRapAccent(accent)
ラップノートのラップアクセントを設定します。 ラップアクセントは、5種類のアクセントタイプ(1, 2, 3, 4, 5)を持つ中国語標準語でのみ使用できることに注意してください。 (1.9.0b2以降でサポート)
パラメータ:
名前 | 型 | 細細 |
---|---|---|
accent |
string |
setTimeRange(onset, duration)
開始位置と長さの両方を設定します。setOnset(onset)
と
setDuration(duration)
の両方を呼び出すのと同じです。
パラメータ:
名前 | 型 | 細細 |
---|---|---|
onset |
number | |
duration |
number |