MGL::Audio::SourceInstance クラス

MGL オーディオソースインスタンス [詳解]

#include <mgl_audio_source_instance.h>

公開メンバ関数
	SourceInstance (SharedVoice &voice, bool isAutoRemove) noexcept
	コンストラクタ
	~SourceInstance () noexcept
	デストラクタ
bool	Play (uint32_t trackIndex, LoopType loopType, float volume) noexcept
	再生開始
bool	Update (float &outDataL, float &outDataR) noexcept
	ソースの更新処理
void	Pause (bool isEnabled) noexcept
	一時停止
bool	IsPaused () const noexcept
	一時停止の状態を取得
void	Remove () noexcept
	削除要求
void	SetVolume (float volume) noexcept
	音量の設定
void	SetVolume (float volume, float fadeTimeSec, float samplesPerSec, bool isAutoStop) noexcept
	変化時間を指定して音量を設定
float	GetVolume () const noexcept
	音量を取得
bool	IsPlaying () const noexcept
	再生中かどうかを取得
constexpr bool	IsFading () const noexcept
	フェード中かどうかを取得
void	SetAutoRemove (bool isEnabled) noexcept
	再生終了後に自動で削除するかの設定

詳解

MGL オーディオソースインスタンス

構築子と解体子

SourceInstance()

MGL::Audio::SourceInstance::SourceInstance ( SharedVoice & voice, bool isAutoRemove )

noexcept

コンストラクタ

引数

[in]	voice	ボイス
[in]	isAutoRemove	再生終了後に自動で削除するかのフラグ

関数詳解

GetVolume()

float MGL::Audio::SourceInstance::GetVolume ( ) const

inlinenoexcept

音量を取得

戻り値

現在の音量

IsFading()

bool MGL::Audio::SourceInstance::IsFading ( ) const

inlineconstexprnoexcept

フェード中かどうかを取得

戻り値

true	フェード期間中
false	フェード期間中でない

IsPaused()

bool MGL::Audio::SourceInstance::IsPaused ( ) const

inlinenoexcept

一時停止の状態を取得

戻り値

true	一時停止中
false	再生中

IsPlaying()

bool MGL::Audio::SourceInstance::IsPlaying ( ) const

inlinenoexcept

再生中かどうかを取得

戻り値

true	再生中
false	再生中でない

Pause()

void MGL::Audio::SourceInstance::Pause ( bool isEnabled )

inlinenoexcept

一時停止

引数

[in]

isEnabled

trueで一時停止，falseで解除

Play()

bool MGL::Audio::SourceInstance::Play ( uint32_t trackIndex, LoopType loopType, float volume )

noexcept

再生開始

引数

[in]	trackIndex	トラック番号
[in]	loopType	ループタイプ
[in]	volume	音量

戻り値

true	成功
false	失敗

SetAutoRemove()

void MGL::Audio::SourceInstance::SetAutoRemove ( bool isEnabled )

inlinenoexcept

再生終了後に自動で削除するかの設定

引数

[in]

isEnabled

trueを指定すると自動削除が有効になる

SetVolume() [1/2]

void MGL::Audio::SourceInstance::SetVolume ( float volume )

inlinenoexcept

音量の設定

引数

[in]

volume

音量

覚え書き

フェード期間中に呼び出した場合，フェードはキャンセルされる

SetVolume() [2/2]

void MGL::Audio::SourceInstance::SetVolume ( float volume, float fadeTimeSec, float samplesPerSec, bool isAutoStop )

inlinenoexcept

変化時間を指定して音量を設定

引数

[in]	volume	音量
[in]	fadeTimeSec	指定した音量に変化するまでの時間
[in]	samplesPerSec	サンプリングレート
[in]	isAutoStop	音量変化後に自動停止するかのフラグ

覚え書き

フェード期間中に呼び出した場合，指定したパラメータで上書きされる

Update()

bool MGL::Audio::SourceInstance::Update ( float & outDataL, float & outDataR )

noexcept

ソースの更新処理

引数

[out]	outDataL	左チャンネルの出力
[out]	outDataR	右チャンネルの出力

戻り値

true	再生継続
false	再生終了

---

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

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