FineKernelToolKit: FK_CLI::fk_AudioWavBuffer クラス

FineKernelToolKit 4.3.0

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

Wave オーディオバッファクラス [詳解]

`#include <CLI/FK_CLI/include/AudioWavBuffer_CLI.h>`

FK_CLI::fk_AudioWavBuffer の継承関係図
[凡例]
FK_CLI::fk_AudioWavBuffer 連携図
[凡例]

## 公開メンバ関数

| fk_AudioWavBuffer ()
| コンストラクタ
| ~fk_AudioWavBuffer ()
| デストラクタ
| !fk_AudioWavBuffer ()
| ファイナライザ
virtual bool | Open (String^ filename) override
| オーディオデータ読み込みメソッド
基底クラス FK_CLI::fk_AudioOggBuffer に属する継承公開メンバ関数
| fk_AudioOggBuffer ()
| コンストラクタ
| ~fk_AudioOggBuffer ()
| デストラクタ
| !fk_AudioOggBuffer ()
| ファイナライザ
virtual bool | Ready (void) override
| 再生開始可能状態取得メソッド
virtual bool | Play (void) override
| 再生メソッド
virtual double | Tell (void) override
| 再生位置取得メソッド
virtual void | Seek (double time) override
| 再生位置頭出しメソッド
virtual void | Stop (void) override
| 停止メソッド
virtual void | End (void) override
| オーディオデータ解放メソッド
基底クラス FK_CLI::fk_AudioBase に属する継承公開メンバ関数
| fk_AudioBase ()
| コンストラクタ
| ~fk_AudioBase ()
| デストラクタ
| !fk_AudioBase ()
| ファイナライザ
void | Pause (void)
| ポーズメソッド
void | SetLoopArea (double start, double end)
| ループエリア設定メソッド
double | GetLoopStartTime (void)
| ループ開始点取得メソッド
double | GetLoopEndTime (void)
| ループ終了点取得メソッド

## その他の継承メンバ

基底クラス FK_CLI::fk_AudioBase に属する継承静的公開メンバ関数
static bool | Init (void)
| オーディオシステム初期化メソッド
static bool | GetInit (void)
| オーディオシステム初期化状態取得メソッド
static void | Sleep (double time)
| プロセススリープメソッド
static void | SetListenerModel (fk_Model^ model)
| サラウンドリスナー同期モデル設定メソッド
static fk_Model ^ | GetListenerModel (void)
| サラウンドリスナーモデル取得メソッド
基底クラス FK_CLI::fk_AudioBase に属する継承プロパティ
double | Gain`[get, set]`
| 音量プロパティ
int | QueueSize`[get, set]`
| キューバッファサイズプロパティ
bool | LoopMode`[get, set]`
| ループモードプロパティ
fk_Vector^ | Position`[get, set]`
| サラウンド音源位置プロパティ
fk_Model^ | Model`[get, set]`
| サラウンド音源同期モデルプロパティ
double | Distance`[get, set]`
| サラウンド音源有効距離プロパティ
bool | SurroundMode`[get, set]`
| サラウンド効果状態プロパティ

## 詳解

Wave オーディオバッファクラス

このクラスは、Wave 形式のファイルに格納された音声を、 オンメモリで再生する機能を提供します。 このクラスは、ファイルを読み込む時点で全ての音声データをメモリ上に展開します。 これにより、頻繁な再生と停止を繰り返したり、 seek() を頻繁に用いて再生位置を変更するといった、 即応性の高い再生を可能としています。 短くて頻繁に再生と停止を繰り返すような、効果音などの音源に適しています。 また、サラウンドにも対応しています。

しかしながら、全てのデータをメモリ上に展開するという仕様上、 巨大な音声データを入力した場合にはかなりのメモリを使用してしまいます。 長尺で単調に再生するような BGM 再生などの用途には向いていません。 そのような用途を想定する場合は、 fk_AudioStream クラスを利用して下さい。

また、Ogg Vorbis 形式のファイルを再生したい場合は fk_AudioOggBuffer クラスを利用してください。 本クラスとほぼ同一の機能を持ちます。

なお、本クラスは fk_AudioBase クラスの派生クラスであり、 音量やループ再生の制御、サラウンド効果の使用といった機能の利用については fk_AudioBase のメソッドを用いて行います。

参照
  fk_AudioBase, fk_AudioOggBuffer, fk_AudioStream

## 構築子と解体子

## ◆ fk_AudioWavBuffer()

FK_CLI::fk_AudioWavBuffer::fk_AudioWavBuffer | ( |  | ) |

コンストラクタ

## ◆ ~fk_AudioWavBuffer()

FK_CLI::fk_AudioWavBuffer::~fk_AudioWavBuffer | ( |  | ) |

デストラクタ

## ◆ !fk_AudioWavBuffer()

FK_CLI::fk_AudioWavBuffer::!fk_AudioWavBuffer | ( |  | ) |

ファイナライザ

## 関数詳解

## ◆ Open()

virtual bool FK_CLI::fk_AudioWavBuffer::Open | ( | String^ | filename | ) |

overridevirtual

オーディオデータ読み込みメソッド

Wave 形式のファイルを指定することで、 音声データを読み込みます。

覚え書き
  サラウンド効果を有効とするためには、 音源はモノラルでなければなりません。

引数

  [in] | filename | ファイル名。

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

FK_CLI::fk_AudioOggBufferを再実装しています。