VCSSL Sound ライブラリ は、サウンドを扱う標準ライブラリです。
VCSSL におけるサウンド再生の基本的な流れは、以下の通りです。
まず、newSound 関数でファイルからサウンドデータを読み込みます。現在VCSSL で利用可能なサウンド形式としては、WAVE 形式( 拡張子 .wav )のみがサポートされています。
続いて、setSoundGain 関数で音量を設定した後、startSound 関数で再生を開始します。サウンドの再生は、VCSSLプログラムの実行とは非同期で行われます。つまり、サウンドの再生終了を待つことなく、VCSSL の処理も引き続き実行されていきます。これは複数のサウンドを再生する場合も同様で、サウンドは互いの終了を待つ事なく、非同期に再生されます。
サウンドの再生が終了すると、onSoundEnd イベントハンドラがコールされます。サウンドをリピート再生したい場合は、ここで setSoundFrame関数にフレーム値 0 を指定してサウンドを巻き戻し、再び startSound 関数で再生します。
- なし - None -
- なし - None -
定義 - Signature |
int newSound(string filePath) |
詳細 - Details |
サウンドファイルを読み込んでサウンドデータを生成し、それに固有の識別番号である「グラフィックスデータID」を割り振って返します。 |
引数 - Arguments |
filePath : 読み込むサウンドファイルの名称またはパス(現時点でWAV形式のみ対応) |
戻り値 - Return |
生成したサウンドデータに割り振られたサウンドデータID(識別番号) |
定義 - Signature |
void deleteSound(int soundID) |
詳細 - Details |
サウンドデータを破棄します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
定義 - Signature |
void startSound(int soundID) |
詳細 - Details |
サウンドの再生を開始します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
定義 - Signature |
void stopSound(int soundID) |
詳細 - Details |
サウンドの再生を一時停止します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
定義 - Signature |
void setSoundGain(int soundID, float gain) |
詳細 - Details |
サウンドの音量ゲインを設定します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID gain : 音量ゲイン。 |
定義 - Signature |
void setSoundFrame(int soundID, int frame) |
詳細 - Details |
サウンドの再生位置をフレーム単位で設定します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID gain : 再生位置フレーム |
定義 - Signature |
int getSoundFrame(int soundID) |
詳細 - Details |
サウンドの再生位置をフレーム単位で取得します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
戻り値 - Return |
現在の再生位置フレーム |
定義 - Signature |
int getSoundFrameLength(int soundID) |
詳細 - Details |
サウンドの長さをフレーム数単位で取得します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
戻り値 - Return |
総フレーム数 |
定義 - Signature |
void setSoundTime(int soundID, int milliSec) |
詳細 - Details |
サウンドの再生位置を時間単位(ミリ秒)で設定します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID milliSec : 再生位置時間(ミリ秒) |
定義 - Signature |
int getSoundTime(int soundID) |
詳細 - Details |
サウンドの再生位置を時間単位(ミリ秒)で取得します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
戻り値 - Return |
再生位置時間(ミリ秒) |
定義 - Signature |
int getSoundTimeLength(int soundID) |
詳細 - Details |
サウンドの長さを時間単位(ミリ秒)で取得します。 |
引数 - Arguments |
soundID : 対象サウンドデータのID |
戻り値 - Return |
総ミリ秒数 |
定義 - Signature |
void onSoundStart( int soundID ) |
詳細 - Details |
サウンドの再生が開始した際にコールされます。 |
引数 - Arguments |
soundID : イベント発生元サウンドデータのID |
定義 - Signature |
void onSoundStop( int soundID ) |
詳細 - Details |
サウンドの再生が停止した際にコールされます。 |
引数 - Arguments |
soundID : イベント発生元サウンドデータのID |
定義 - Signature |
void onSoundEnd( int soundID ) |
詳細 - Details |
サウンドの再生が終了した際にコールされます。 |
引数 - Arguments |
soundID : イベント発生元サウンドデータのID |