クラス Handle

ハンドルを取り扱います。


フィールドの概要
 boolean addQuotationMark
           歌詞・発音記号列の前後にクォーテーションマークを付けるかどうか
 string iconId
           ハンドルを特定するための文字列
 string ids
           ハンドルの名前
 int index
           メタテキストに出力されるこのオブジェクトの ID
 int language
           歌手の歌唱言語を表す番号(バンクセレクト)。
 int original
           ハンドルのオリジナル
 int program
           歌手の種類を表す番号(プログラムチェンジ)。
 
コンストラクタの概要
static  Handle new(HandleTypeEnum type)
          
static  Handle new(TextStream stream,int index,table lastLine)
          テキストストリームからハンドルの内容を読み込み初期化する
 
メソッドの概要
 Handle clone()
          コピーを作成する
 ArticulationTypeEnum getArticulation()
          articulation の種類を取得する
 string getCaption()
          キャプションを取得する
 int getDepth()
          Depth 値を取得する
 VibratoBPList getDepthBP()
          Depth のビブラートカーブを取得する
 string getDisplayString()
          Display String 値を取得する
 int getDuration()
          Duration 値を取得する
 VibratoBPList getDynBP()
          DYN カーブを取得する
 int getEndDyn()
          DYN の終了値を取得する
 HandleTypeEnum getHandleType()
          ハンドルのタイプを取得する
 int getLength()
          Tick 単位の長さを取得する
 Lyric getLyricAt(int index)
          指定した位置にある歌詞を取得する
 int getLyricCount()
          歌詞の個数を返す
 VibratoBPList getRateBP()
          Rate のビブラートカーブを取得する
 int getStartDepth()
          Depth の開始値を取得する
 int getStartDyn()
          DYN の開始値を取得する
 int getStartRate()
          Rate の開始値を取得する
 boolean isCrescendType()
          このハンドルがクレッシェンドを表すものかどうかを表すブール値を取得する
 boolean isDecrescendType()
          このハンドルがデクレッシェンドを表すものかどうかを表すブール値を取得する
 boolean isDynaffType()
          このハンドルが強弱記号を表すものかどうかを表すブール値を取得する
 void setCaption(string value)
          キャプションを設定する
 void setDepth(int value)
          Depth 値を設定する
 void setDepthBP(VibratoBPList value)
          Depth のビブラートカーブを設定する
 void setDuration(int value)
          Duration 値を設定する
 void setDynBP(VibratoBPList value)
          DYN カーブを設定する
 void setEndDyn(int value)
          DYN の終了値を設定する
 void setLength(int value)
          長さを設定する
 void setLyricAt(int index,Lyric value)
          指定した位置にある歌詞を指定した要素で置き換える
 void setRateBP(VibratoBPList value)
          Rate のビブラートカーブを設定する
 void setStartDepth(int value)
          Depth の開始値を設定する
 void setStartDyn(int value)
          DYN の開始値を設定する
 void setStartRate(int value)
          Rate の開始値を設定する
 string toString()
          オブジェクトを文字列に変換する
 void write(TextStream stream)
          ストリームに書き込む
 
フィールドの詳細

addQuotationMark

public boolean addQuotationMark
歌詞・発音記号列の前後にクォーテーションマークを付けるかどうか


iconId

public string iconId
ハンドルを特定するための文字列


ids

public string ids
ハンドルの名前


index

public int index
メタテキストに出力されるこのオブジェクトの ID


language

public int language
歌手の歌唱言語を表す番号(バンクセレクト)。歌手ハンドルでのみ使われる


original

public int original
ハンドルのオリジナル


program

public int program
歌手の種類を表す番号(プログラムチェンジ)。歌手ハンドルでのみ使われる

コンストラクタの詳細

new

public static Handle new(HandleTypeEnum type)

パラメータ:
type - ハンドルの種類
戻り値:

new

public static Handle new(TextStream stream,
                         int index,
                         table lastLine)

テキストストリームからハンドルの内容を読み込み初期化する

パラメータ:
stream - 読み込み元のテキストストリーム
index - index フィールドの値
lastLine - 読み込んだ最後の行。テーブルの ["value"] に文字列が格納される
戻り値:
メソッドの詳細

clone

public Handle clone()

コピーを作成する

戻り値:
このオブジェクトのコピー

getArticulation

public ArticulationTypeEnum getArticulation()

articulation の種類を取得する

戻り値:
articulation の種類

getCaption

public string getCaption()

キャプションを取得する

戻り値:
キャプション

getDepth

public int getDepth()

Depth 値を取得する

戻り値:
Depth 値

getDepthBP

public VibratoBPList getDepthBP()

Depth のビブラートカーブを取得する

戻り値:
Depth のビビラートカーブ

getDisplayString

public string getDisplayString()

Display String 値を取得する

戻り値:
Display String 値

getDuration

public int getDuration()

Duration 値を取得する

戻り値:
Duration 値

getDynBP

public VibratoBPList getDynBP()

DYN カーブを取得する

戻り値:
DYN カーブ

getEndDyn

public int getEndDyn()

DYN の終了値を取得する

戻り値:
DYN の終了値

getHandleType

public HandleTypeEnum getHandleType()

ハンドルのタイプを取得する

戻り値:
ハンドルのタイプ

getLength

public int getLength()

Tick 単位の長さを取得する

戻り値:

getLyricAt

public Lyric getLyricAt(int index)

指定した位置にある歌詞を取得する

パラメータ:
index - 取得する要素のインデックス(最初のインデックスは0)
戻り値:
歌詞

getLyricCount

public int getLyricCount()

歌詞の個数を返す

戻り値:
歌詞の個数

getRateBP

public VibratoBPList getRateBP()

Rate のビブラートカーブを取得する

戻り値:
Rate のビブラートカーブ

getStartDepth

public int getStartDepth()

Depth の開始値を取得する

戻り値:
Depth の開始値

getStartDyn

public int getStartDyn()

DYN の開始値を取得する

戻り値:
DYN の開始値

getStartRate

public int getStartRate()

Rate の開始値を取得する

戻り値:
Rate の開始値

isCrescendType

public boolean isCrescendType()

このハンドルがクレッシェンドを表すものかどうかを表すブール値を取得する

戻り値:
このオブジェクトがクレッシェンドを表すものであれば true を、そうでなければ false を返す

isDecrescendType

public boolean isDecrescendType()

このハンドルがデクレッシェンドを表すものかどうかを表すブール値を取得する

戻り値:
このオブジェクトがデクレッシェンドを表すものであれば true を、そうでなければ false を返す

isDynaffType

public boolean isDynaffType()

このハンドルが強弱記号を表すものかどうかを表すブール値を取得する

戻り値:
このオブジェクトが強弱記号を表すものであれば true を、そうでなければ false を返す

setCaption

public void setCaption(string value)

キャプションを設定する

パラメータ:
value - キャプション

setDepth

public void setDepth(int value)

Depth 値を設定する

パラメータ:
value - Depth 値

setDepthBP

public void setDepthBP(VibratoBPList value)

Depth のビブラートカーブを設定する

パラメータ:
value - 設定するビブラートカーブ

setDuration

public void setDuration(int value)

Duration 値を設定する

パラメータ:
value - Duration 値

setDynBP

public void setDynBP(VibratoBPList value)

DYN カーブを設定する

パラメータ:
value - DYN カーブ

setEndDyn

public void setEndDyn(int value)

DYN の終了値を設定する

パラメータ:
value - DYN の終了値

setLength

public void setLength(int value)

長さを設定する

パラメータ:
value - Tick単位の長さ

setLyricAt

public void setLyricAt(int index,
                       Lyric value)

指定した位置にある歌詞を指定した要素で置き換える

パラメータ:
index - 置き換える要素のインデックス(最初のインデックスは0)
value - 置き換える要素

setRateBP

public void setRateBP(VibratoBPList value)

Rate のビブラートカーブを設定する

パラメータ:
value - 設定するビブラートカーブ

setStartDepth

public void setStartDepth(int value)

Depth の開始値を設定する

パラメータ:
value - Depth の開始値

setStartDyn

public void setStartDyn(int value)

DYN の開始値を設定する

パラメータ:
value - DYN の開始値

setStartRate

public void setStartRate(int value)

Rate の開始値を設定する

パラメータ:
value - Rate の開始値

toString

public string toString()

オブジェクトを文字列に変換する

戻り値:
文字列

write

public void write(TextStream stream)

ストリームに書き込む

パラメータ:
stream - 書き込み先のストリーム