FK_CLI.fk_Sound クラス

効果音再生クラス [詳解]

FK_CLI.fk_Sound の継承関係図

FK_CLI.fk_Sound 連携図

公開メンバ関数
	fk_Sound (int argNum)
	コンストラクタ
bool	LoadData (int argID, string argFileName)
	効果音源読み込みメソッド
void	Start ()
	再生準備メソッド
void	StartSound (int argID)
	再生開始メソッド
void	SetGain (int argID, double argGain)
	音量設定メソッド
double	GetGain (int argID)
	音量参照メソッド

プロパティ
bool	StopStatus [get, set]
	終了指示用プロパティ

詳解

効果音再生クラス

このクラスは、効果音 (Sound Effect, SE) を再生する機能を提供します。 同様の目的を持つクラスとして fk_AudioOggBuffer や fk_AudioWavBuffer がありますが、 この fk_Sound の方がより容易に用いることができます。

本クラスは、内部で fk_WavBuffer を用いており、 効果音再生専用のスレッドを生成して音源データを全てメモリ上に保存します。 そのため、長時間の再生を行う BGM には向いていません。 BGM 再生には fk_BGM を用いて下さい。

参照

fk_BGM, fk_AudioWavBuffer, fk_AudioOggBuffer, fk_AudioBase

構築子と解体子

fk_Sound()

FK_CLI.fk_Sound.fk_Sound ( int argNum )

inline

コンストラクタ

引数

[in]

argNum

効果音の個数を設定します。

関数詳解

LoadData()

bool FK_CLI.fk_Sound.LoadData ( int argID, string argFileName )

inline

効果音源読み込みメソッド

効果音の音源データファイルを設定し、読み込みを行います。 音源データは WAV 形式である必要があります。

引数

[in]	argID	音源に割り当てる ID。 0 から(コンストラクタで設定した個数 - 1) のいずれかである必要があります。
[in]	argFileName	音源ファイル名。WAV 形式である必要があります。

戻り値

入力に成功すれば true を、失敗すれば false を返します。

参照

StartSound(), Start()

Start()

void FK_CLI.fk_Sound.Start ( )

inline

再生準備メソッド

効果音再生の準備を行います。 このメソッドを実行しないと、 StartSound() を実行しても再生されません。

参照

StartSound()

StartSound()

void FK_CLI.fk_Sound.StartSound ( int argID )

inline

再生開始メソッド

効果音の再生を開始します。 現在再生中の効果音についても、 本メソッドを実行することにより「頭出し再生」を行います。

引数

[in]

argID

効果音の ID

SetGain()

void FK_CLI.fk_Sound.SetGain ( int argID, double argGain )

inline

音量設定メソッド

各効果音ごとに音量を設定します。 最大が 1.0 で、0.0 で無音となります。 なお、初期値は 0.5 となっています。

引数

[in]	argID	効果音ID
[in]	argGain	音量

GetGain()

double FK_CLI.fk_Sound.GetGain ( int argID )

inline

音量参照メソッド

各効果音ごとに音量を参照します。 最大が 1.0 で、0.0 で無音となります。

引数

[in]

argID

効果音ID

戻り値

音量値

プロパティ詳解

StopStatus

bool FK_CLI.fk_Sound.StopStatus

getset

終了指示用プロパティ

効果音再生を終了したいタイミングで、このプロパティに true を代入します。 false を代入しても、即財には終了せずわずかなタイムラグがあることに注意して下さい。