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のスクリプトエンジンアーキテクチャ解説1: 全体像
2019年05月28日 - RINEARNでは現在、 アプリケーション組み込み用スクリプトエンジン「 Vnano 」を、オープンソースで開発中です。今回は、このスクリプトエンジンのアーキテクチャ面を掘り下げて解説します。

リニアンプロセッサー nano の先行開発版やソースコードリポジトリを公開
2019年04月16日 - オープンソースで開発中の小型プログラム関数電卓ソフト、「 リニアンプロセッサー nano 」の先行開発版やソースコードリポジトリを公開しました。概要と使用方法、ビルド方法などについて解説します。

各ソフトウェアの最新版を一括でリリース、OpenJDKのJava実行環境(JRE)に対応
2019年03月06日 - RINEARNでは3月6日に、主要なソフトウェアの最新版を一括でリリースしました。今回のアップデートには、以前お知らせした、OpenJDKで生成したJREへの対応が含まれています。その概要等をお知らせします。

新着
連番ファイルから3Dグラフをアニメーション描画するツール

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

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

「VCSSL 3DCG開発ガイド」内のサンプルコードです。立体モデルを生成し、3D空間に配置します。
2019年05月21日
[公式ガイドサンプル] ポリゴンを生成して3D空間に配置する

「VCSSL 3DCG開発ガイド」内のサンプルコードです。立体の基本的な構成要素となるポリゴンを生成し、3D空間に配置します。
2019年05月20日
[公式ガイドサンプル] CSVファイルにデータを書き出し&読み込んで、複雑な3次元曲面のグラフを描く(魔法陣形)

「VCSSLスタートアップガイド」内のサンプルコードです。CSVファイルにデータを書き出し、さらにそれを読み込んで、魔法陣のような3次元曲面のグラフを描画します。
2019年05月17日
開発元Twitterアカウント