MGL::Audio::WaveLoader クラス

WAVEローダークラス [詳解]

#include <mgl_audio_wave_loader.h>

クラス
struct	Format
	フォーマット [詳解]

公開メンバ関数
constexpr bool	IsOpen () const noexcept
	WAVEファイルがオープンされているかを取得
constexpr const Format &	GetFormat () const noexcept
	フォーマットを取得
constexpr void	Seek (uint32_t sampleFrame) noexcept
	読み込み位置を設定
constexpr bool	IsFinished () const noexcept
	読み込み位置が終端に達しているかを取得
constexpr size_t	GetDataSize () const noexcept
	データサイズを取得
bool	Open (const File::PathView &path) noexcept
	WAVEファイルをオープン
void	Close () noexcept
	WAVEファイルをクローズ
size_t	GetSample (void *buffer, size_t bufferSize) noexcept
	サンプルの取得
size_t	GetSampleWithConvert (float *buffer, size_t bufferSize) noexcept
	サンプルをfloatに変換して取得

詳解

WAVEローダークラス

関数詳解

GetDataSize()

size_t MGL::Audio::WaveLoader::GetDataSize ( ) const

inlinenodiscardconstexprnoexcept

データサイズを取得

戻り値

データサイズ（バイト数）

GetFormat()

const Format & MGL::Audio::WaveLoader::GetFormat ( ) const

inlinenodiscardconstexprnoexcept

フォーマットを取得

戻り値

フォーマット

GetSample()

size_t MGL::Audio::WaveLoader::GetSample ( void * buffer, size_t bufferSize )

noexcept

サンプルの取得

引数

[in]	buffer	サンプルの格納先
[in]	bufferSize	サンプルの格納先のサイズ

戻り値

実際に格納されたサイズ

GetSampleWithConvert()

size_t MGL::Audio::WaveLoader::GetSampleWithConvert ( float * buffer, size_t bufferSize )

noexcept

サンプルをfloatに変換して取得

引数

[in]	buffer	サンプルの格納先
[in]	bufferSize	サンプルの格納先のサイズ

戻り値

実際に格納されたサイズ

IsFinished()

bool MGL::Audio::WaveLoader::IsFinished ( ) const

inlinenodiscardconstexprnoexcept

読み込み位置が終端に達しているかを取得

戻り値

true	終端に達している
false	終端に達していない

IsOpen()

bool MGL::Audio::WaveLoader::IsOpen ( ) const

inlinenodiscardconstexprnoexcept

WAVEファイルがオープンされているかを取得

戻り値

true	オープンされている
false	オープンされていない

Open()

bool MGL::Audio::WaveLoader::Open ( const File::PathView & path )

noexcept

WAVEファイルをオープン

引数

[in]

path

読み込むファイルのパス

戻り値

true	成功
false	失敗

Seek()

void MGL::Audio::WaveLoader::Seek ( uint32_t sampleFrame )

inlineconstexprnoexcept

読み込み位置を設定

引数

[in]

sampleFrame

設定するサンプルフレーム

---

このクラス詳解は次のファイルから抽出されました:

• /Users/acerola/work/mgl-work/mgl/include/mgl/audio/voice/mgl_audio_wave_loader.h
• /Users/acerola/work/mgl-work/mgl/src/audio/voice/mgl_audio_wave_loader.cc