FineKernelToolKit: FK_CLI.fk_BGM クラス

FineKernelToolKit 4.3.0

読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | プロパティ | 全メンバ一覧
FK_CLI.fk_BGM クラス

BGM 再生クラス [詳解]

FK_CLI.fk_BGM の継承関係図
[凡例]
FK_CLI.fk_BGM 連携図
[凡例]

## 公開メンバ関数

| fk_BGM (string argFileName)
| コンストラクタ
void | Start ()
| BGM 再生開始メソッド

## プロパティ

bool | StopStatus`[get, set]`
| 終了指示用プロパティ
double | Gain`[set]`
| 音量プロパティ

## 詳解

BGM 再生クラス

このクラスは、BGM (Back Ground Music) を再生する機能を提供します。 同様の目的を持つクラスとして fk_AudioStream がありますが、 この fk_BGM の方がより容易に用いることができます。

本クラスは、内部で fk_AudioStream を用いており、 音楽再生専用のスレッドを生成してストリーミング再生を行います。 そのため、再生の即応性が求められる効果音には向いていません。 効果音再生には fk_Sound を用いて下さい。

参照
  fk_Sound, fk_AudioStream, fk_AudioBase

## 構築子と解体子

## ◆ fk_BGM()

FK_CLI.fk_BGM.fk_BGM | ( | string | argFileName | ) |

inline

コンストラクタ

引数

  [in] | argFileName | 音源ファイル名。Ogg 形式の音源データである必要があります。 入力に失敗した場合、コンソールに「Audio File Open Error.」 というエラーメッセージが出力されます。

なお、インスタンス生成時はまだ再生は開始しません。 再生を開始するのは Start() メソッドを実行する必要があります。

## 関数詳解

## ◆ Start()

void FK_CLI.fk_BGM.Start | ( |  | ) |

inline

BGM 再生開始メソッド

BGM の再生を開始します。

## プロパティ詳解

## ◆ StopStatus

bool FK_CLI.fk_BGM.StopStatus

getset

終了指示用プロパティ

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

## ◆ Gain

double FK_CLI.fk_BGM.Gain

set

音量プロパティ

音量設定を行うプロパティです。 1.0 が最大で、0.0 で無音状態となります。 なお、初期値は 0.5 となっています。