Sound ライブラリ


概要 - Abstract

VCSSL Sound ライブラリ は、サウンドを扱う標準ライブラリです。

VCSSL におけるサウンド再生の基本的な流れは、以下の通りです。

まず、newSound 関数でファイルからサウンドデータを読み込みます。現在VCSSL で利用可能なサウンド形式としては、WAVE 形式( 拡張子 .wav )のみがサポートされています。

続いて、setSoundGain 関数で音量を設定した後、startSound 関数で再生を開始します。サウンドの再生は、VCSSLプログラムの実行とは非同期で行われます。つまり、サウンドの再生終了を待つことなく、VCSSL の処理も引き続き実行されていきます。これは複数のサウンドを再生する場合も同様で、サウンドは互いの終了を待つ事なく、非同期に再生されます。

サウンドの再生が終了すると、onSoundEnd イベントハンドラがコールされます。サウンドをリピート再生したい場合は、ここで setSoundFrame関数にフレーム値 0 を指定してサウンドを巻き戻し、再び startSound 関数で再生します。


目次 - Index

int newSound(string filePath)
サウンドファイルを読み込んでサウンドデータを生成し、それに固有の識別番号である「グラフィックスデータID」を割り振って返します。
void deleteSound(int soundID)
サウンドデータを破棄します。
void startSound(int soundID)
サウンドの再生を開始します。
void stopSound(int soundID)
サウンドの再生を一時停止します。
void setSoundGain(int soundID, float gain)
サウンドの音量ゲインを設定します。
void setSoundFrame(int soundID, int frame)
サウンドの再生位置をフレーム単位で設定します。
int getSoundFrame(int soundID)
サウンドの再生位置をフレーム単位で取得します。
int getSoundFrameLength(int soundID)
サウンドの長さをフレーム数単位で取得します。
void setSoundTime(int soundID, int milliSec)
サウンドの再生位置を時間単位(ミリ秒)で設定します。
int getSoundTime(int soundID)
サウンドの再生位置を時間単位(ミリ秒)で取得します。
int getSoundTimeLength(int soundID)
サウンドの長さを時間単位(ミリ秒)で取得します。
void onSoundStart( int soundID )
サウンドの再生が開始した際にコールされます。
void onSoundStop( int soundID )
サウンドの再生が停止した際にコールされます。
void onSoundEnd( int soundID )
サウンドの再生が終了した際にコールされます。

構造体 - Structs

- なし - None -


変数 - Variables

- なし - None -


関数 - Functions

定義
- 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
総ミリ秒数

イベントハンドラ - Event Handler

定義
- 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

この階層の目次
お知らせ

Vnanoの公式サイトがオープン、チュートリアルやAPI仕様書等も掲載
2019年08月07日 - オープンソースのアプリケーション組み込み用スクリプトエンジン「 Vnano 」の公式サイトを開設しました。チュートリアルや、スクリプトエンジンのAPI仕様書などが参照できます。その概要をお知らせします。

リニアングラフ3D/2Dが連番ファイルのアニメーションに標準で対応
2019年07月17日 - リニアングラフ3D/2Dでは、7月17日公開の最新版より、連番ファイルを連続的に読み込みながらアニメーション描画するプログラムを同梱し、メニューから標準で使用可能になりました。その概要をお知らせします。

Vnanoのスクリプトエンジンアーキテクチャ解説2: コンパイラ
2019年07月03日 - オープンソースで開発中のスクリプトエンジン「 Vnano 」のアーキテクチャを解説する連載の第2回です。今回は、スクリプトを中間コードへと変換する、コンパイラ部分の内部をクローズアップして解説します。

新着
[公式ガイドサンプル] ユーザーのGUI操作に対して処理を行う

「VCSSL GUI開発ガイド」内のサンプルコードです。ユーザーがGUIを操作した際に行う処理を実装します。
2019年07月28日
[公式ガイドサンプル] 各種GUIコンポーネントを画面上に配置する

「VCSSL GUI開発ガイド」内のサンプルコードです。色々な種類のGUI部品を画面上に配置します。
2019年07月28日
連番ファイルから3Dグラフをアニメーション描画するツール

フォルダ内の連番データファイルを読み込み、3Dグラフを高速で連続描画して、アニメーションさせるツールです。グラフを連番の画像ファイルに保存する事もできます。
2019年06月03日
連番ファイルから2Dグラフをアニメーション描画するツール

フォルダ内の連番データファイルを読み込み、2Dグラフを高速で連続描画して、アニメーションさせるツールです。グラフを連番の画像ファイルに保存する事もできます。
2019年05月24日
[公式ガイドサンプル] 立体モデルを生成して3D空間に配置する

「VCSSL 3DCG開発ガイド」内のサンプルコードです。立体モデルを生成し、3D空間に配置します。
2019年05月21日
開発元Twitterアカウント