オーディオソースクラス [詳解]

#include <mgl_audio_source.h>

公開メンバ関数
	Source (const SharedSourceInstance &sourceInstance) noexcept
	コンストラクタ

constexpr	Source () noexcept=default
	コンストラクタ

	Source (VoiceKey voiceKey, bool isAutoRemove=true) noexcept
	コンストラクタ

	~Source () noexcept
	デストラクタ

bool	Attach (VoiceKey voiceKey, bool isAutoRemove) noexcept
	ボイスとソースの関連付け

void	Detach () noexcept
	ボイスとソースの関連付けを解除

bool	IsAttached () const noexcept
	ソースがボイスと関連付けられているかを取得

bool	Play (VoiceKey voiceKey, bool isAutoRemove=true, uint32_t trackIndex=0, LoopType loopType=LoopType::ResourceDefault, float volume=1.0f) noexcept
	アタッチして再生

bool	Play (uint32_t trackIndex=0, LoopType loopType=LoopType::ResourceDefault, float volume=1.0f) noexcept
	アタッチ済みのボイスを再生

void	Pause (bool isEnabled=true) noexcept
	一時停止

void	Resume () noexcept
	再開

bool	IsPaused () const noexcept
	一時停止の状態を取得

void	Stop () noexcept
	停止要求

void	SetVolume (float volume) noexcept
	音量の設定

void	SetVolume (float volume, float fadeTimeSec, bool isAutoStop=false) noexcept
	変化時間を指定して音量を設定

void	Fadeout (float fadeTimeSec, bool isAutoStop=true) noexcept
	フェードアウト

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

bool	IsPlaying () const noexcept
	再生中かどうかを取得

bool	IsFading () const noexcept
	フェード中かどうかを取得

	Source (const Source &)=delete

Source &	operator= (const Source &)=delete

	Source (Source &&other) noexcept
	ムーブコンストラクタ

Source &	operator= (Source &&other) noexcept
	ムーブ代入演算

詳解

オーディオソースクラス

構築子と解体子

◆ Source() [1/3]

MGL::Audio::Source::Source ( const SharedSourceInstance & sourceInstance )

inlinenoexcept

コンストラクタ

引数

[in] sourceInstance 関連付けるオーディオソースインスタンス

◆ Source() [2/3]

MGL::Audio::Source::Source	(	VoiceKey	voiceKey,
		bool	isAutoRemove = true )

inlinenoexcept

コンストラクタ

引数

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

◆ Source() [3/3]

MGL::Audio::Source::Source ( Source && other )

inlinenoexcept

ムーブコンストラクタ

引数

[in] other 移動元ハンドル

関数詳解

◆ Attach()

bool MGL::Audio::Source::Attach	(	VoiceKey	voiceKey,
		bool	isAutoRemove )

inlinenoexcept

ボイスとソースの関連付け

引数

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

戻り値

true	成功
false	失敗

◆ Fadeout()

void MGL::Audio::Source::Fadeout	(	float	fadeTimeSec,
		bool	isAutoStop = true )

inlinenoexcept

フェードアウト

引数

[in]	fadeTimeSec	フェード時間
[in]	isAutoStop	音量変化後に自動停止するかのフラグ

◆ GetVolume()

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

inlinenodiscardnoexcept

ボリュームの取得

戻り値: 現在のボリューム

◆ IsAttached()

bool MGL::Audio::Source::IsAttached ( ) const

inlinenodiscardnoexcept

ソースがボイスと関連付けられているかを取得

戻り値

true	関連付けられている
false	関連付けられていない

◆ IsFading()

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

inlinenodiscardnoexcept

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

戻り値

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

◆ IsPaused()

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

inlinenodiscardnoexcept

一時停止の状態を取得

戻り値

true	一時停止中
false	再生中

◆ IsPlaying()

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

inlinenodiscardnoexcept

再生中かどうかを取得

戻り値

true	再生中
false	再生中でない

◆ operator=()

Source & MGL::Audio::Source::operator= ( Source && other )

inlinenoexcept

ムーブ代入演算

引数

[in] other 移動元ハンドル

◆ Pause()

void MGL::Audio::Source::Pause ( bool isEnabled = true )

inlinenoexcept

一時停止

引数

[in] isEnabled trueで一時停止，falseで解除

◆ Play() [1/2]

bool MGL::Audio::Source::Play	(	uint32_t	trackIndex = 0,
		LoopType	loopType = LoopType::ResourceDefault,
		float	volume = 1.0f )

inlinenoexcept

アタッチ済みのボイスを再生

引数

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

戻り値

true	成功
false	失敗

◆ Play() [2/2]

bool MGL::Audio::Source::Play	(	VoiceKey	voiceKey,
		bool	isAutoRemove = true,
		uint32_t	trackIndex = 0,
		LoopType	loopType = LoopType::ResourceDefault,
		float	volume = 1.0f )

inlinenoexcept

アタッチして再生

引数

[in]	voiceKey	ボイスキー
[in]	isAutoRemove	再生終了時に自動で削除するかのフラグ
[in]	trackIndex	トラック番号
[in]	loopType	ループタイプ
[in]	volume	再生音量

戻り値

true	成功
false	失敗

◆ Resume()

void MGL::Audio::Source::Resume ( )

inlinenoexcept

再開

覚え書き: Pause(false)と等価

◆ SetVolume() [1/2]

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

inlinenoexcept

音量の設定

引数

[in] volume 音量

覚え書き: フェード期間中は音量操作を行えず，この呼び出しは無視される

◆ SetVolume() [2/2]

void MGL::Audio::Source::SetVolume	(	float	volume,
		float	fadeTimeSec,
		bool	isAutoStop = false )

inlinenoexcept

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

引数

[in]	volume	音量
[in]	fadeTimeSec	指定した音量に変化するまでの時間
[in]	isAutoStop	音量変化後に自動停止するかのフラグ

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

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

/Users/acerola/x/mgl/include/mgl/audio/mgl_audio_source.h

公開メンバ関数

詳解

構築子と解体子

◆ Source() [1/3]

◆ Source() [2/3]

◆ Source() [3/3]

関数詳解

◆ Attach()

◆ Fadeout()

◆ GetVolume()

◆ IsAttached()

◆ IsFading()

◆ IsPaused()

◆ IsPlaying()

◆ operator=()

◆ Pause()

◆ Play() [1/2]

◆ Play() [2/2]

◆ Resume()

◆ SetVolume() [1/2]

◆ SetVolume() [2/2]