MGL WAVEボイス [詳解]

#include <mgl_audio_wave_voice.h>

MGL::Audio::WaveVoice の継承関係図

公開メンバ関数
	WaveVoice (VoiceKey key, const File::PathView &path, bool isLoop=false, uint32_t loopFrame=0) noexcept
	コンストラクタ

bool	Load () noexcept override
	ボイスの読み込み処理

bool	GetSample (float &outDataL, float &outDataR, uint32_t trackIndex, size_t sampleFrame) const noexcept override
	スタティックボイスのサンプルの取得

uint32_t	GetTotalFrame (uint32_t trackIndex) const noexcept override
	ボイスの最大フレーム数を取得

bool	IsLoop (uint32_t trackIndex) const noexcept override
	指定したトラックのループ設定を取得

uint32_t	GetLoopFrame (uint32_t trackIndex) const noexcept override
	指定したトラックのループフレームを取得

uint32_t	GetTrackCount () const noexcept override
	ボイスが持つトラックの数を取得

基底クラス MGL::Audio::Voice に属する継承公開メンバ関数
constexpr	Voice (VoiceKey key, Type type) noexcept
	コンストラクタ

virtual bool	GetSample (float &outDataL, float &outDataR) noexcept
	ダイナミックボイスのサンプルの取得

virtual bool	Start (uint32_t trackIndex, LoopType loopType) noexcept
	ボイスの開始処理

virtual void	Stop () noexcept
	ボイスの停止処理

constexpr VoiceKey	GetKey () const noexcept
	ボイスキーを取得

void	RemoveRequests () noexcept
	削除を要求

Status	GetStatus () const noexcept
	ボイスのステータスを取得

constexpr Type	GetType () const noexcept
	ボイスの種類を取得

void	SetVolume (float volume) noexcept
	ボイスのボリュームを設定

float	GetVolume () const noexcept
	ボイスのボリュームを取得

その他の継承メンバ
基底クラス MGL::Audio::Voice に属する継承公開型
enum class	Status : uint8_t { None , Loading , Error , Ready , Remove }
	ボイスの状態 [詳解]

enum class	Type : uint8_t { Static , Dynamic }
	ボイスのタイプ [詳解]

基底クラス MGL::Audio::Voice に属する継承限定公開メンバ関数
void	SetStatus (Status status) noexcept
	ボイスのステータスを設定

詳解

MGL WAVEボイス

構築子と解体子

◆ WaveVoice()

MGL::Audio::WaveVoice::WaveVoice	(	VoiceKey	key,
		const File::PathView &	path,
		bool	isLoop = false,
		uint32_t	loopFrame = 0 )

noexcept

コンストラクタ

引数

[in]	key	ボイスキー
[in]	path	読み込むファイルのパス
[in]	isLoop	ループフラグ
[in]	loopFrame	ループ開始位置

関数詳解

◆ GetLoopFrame()

uint32_t MGL::Audio::WaveVoice::GetLoopFrame ( uint32_t trackIndex ) const

inlineoverridevirtualnoexcept

指定したトラックのループフレームを取得

引数

[in] trackIndex トラック番号

戻り値: ループフレーム

MGL::Audio::Voiceを実装しています。

◆ GetSample()

bool MGL::Audio::WaveVoice::GetSample	(	float &	outDataL,
		float &	outDataR,
		uint32_t	trackIndex,
		size_t	sampleFrame ) const

overridevirtualnoexcept

スタティックボイスのサンプルの取得

引数

[out]	outDataL	左チャンネル出力の格納先
[out]	outDataR	右チャンネル出力の格納先
[in]	trackIndex	トラック番号
[in]	sampleFrame	サンプルフレーム

戻り値

true	継続
false	終了

MGL::Audio::Voiceを再実装しています。

◆ GetTotalFrame()

uint32_t MGL::Audio::WaveVoice::GetTotalFrame ( uint32_t trackIndex ) const

inlineoverridevirtualnoexcept

ボイスの最大フレーム数を取得

引数

[in] trackIndex トラック番号

戻り値: 最大フレーム数

MGL::Audio::Voiceを実装しています。

◆ GetTrackCount()

uint32_t MGL::Audio::WaveVoice::GetTrackCount ( ) const

inlineoverridevirtualnoexcept

ボイスが持つトラックの数を取得

戻り値: トラック数

MGL::Audio::Voiceを実装しています。

◆ IsLoop()

bool MGL::Audio::WaveVoice::IsLoop ( uint32_t trackIndex ) const

inlineoverridevirtualnoexcept

指定したトラックのループ設定を取得

引数

[in] trackIndex トラック番号

戻り値

true	ループあり
false	ループなし

MGL::Audio::Voiceを実装しています。

◆ Load()

bool MGL::Audio::WaveVoice::Load ( )

overridevirtualnoexcept

ボイスの読み込み処理

戻り値

true	成功
false	失敗

MGL::Audio::Voiceを実装しています。

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

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

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ WaveVoice()

関数詳解

◆ GetLoopFrame()

◆ GetSample()

◆ GetTotalFrame()

◆ GetTrackCount()

◆ IsLoop()

◆ Load()