MGL::Audio::Player クラス

オーディオプレイヤークラス [詳解]

#include <mgl_audio_player.h>

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

公開メンバ関数
bool	Initialize (STL::unique_ptr< Renderer > &renderer, InitializeMode initMode) noexcept
	初期化処理
bool	Load (const SharedVoice &voice) noexcept
	ボイスの読み込み
bool	Unload (VoiceKey key) noexcept
	ボイスを解放
SharedSourceInstance	MakeSourceInstance (VoiceKey key, bool isAutoRemove) noexcept
	ソースインスタンスを生成
const DataFormat &	GetOutputFormat () const noexcept
	出力フォーマットの取得
void	SetMasterVolume (float volume) noexcept
	マスター音量の設定
float	GetMasterVolume () const noexcept
	マスター音量の取得
void	SetVoiceVolume (VoiceKey voiceKey, float volume) noexcept
	ボイスのボリュームを設定
float	GetVoiceVolume (VoiceKey voiceKey) noexcept
	ボイスのボリュームを設定
基底クラス MGL::SharedSingleton< Player > に属する継承公開メンバ関数
	SharedSingleton (const SharedSingleton &) noexcept=delete
	SharedSingleton (SharedSingleton &&) noexcept=delete
SharedSingleton &	operator= (const SharedSingleton &) noexcept=delete
SharedSingleton &	operator= (SharedSingleton &&) noexcept=delete

静的公開メンバ関数
static STL::unique_ptr< Player > &	GetInstanceRef () noexcept
	インスタンスの取得
基底クラス MGL::SharedSingleton< Player > に属する継承静的公開メンバ関数
static Player &	CreateInstance (Args... args) noexcept
	インスタンスの生成
static Player &	GetInstance () noexcept
	インスタンスの取得
static void	DestroyInstance () noexcept
	インスタンスの破棄
static bool	HasInstance () noexcept
	有効なインスタンスを保持しているかを取得

詳解

オーディオプレイヤークラス

関数詳解

GetInstanceRef()

STL::unique_ptr< Player > & MGL::Audio::Player::GetInstanceRef ( )

staticnoexcept

インスタンスの取得

戻り値

インスタンスの参照

GetMasterVolume()

float MGL::Audio::Player::GetMasterVolume ( ) const

inlinenodiscardnoexcept

マスター音量の取得

戻り値

現在のマスター音量

GetOutputFormat()

const DataFormat & MGL::Audio::Player::GetOutputFormat ( ) const

inlinenodiscardnoexcept

出力フォーマットの取得

戻り値

出力フォーマット情報

GetVoiceVolume()

float MGL::Audio::Player::GetVoiceVolume ( VoiceKey voiceKey )

nodiscardnoexcept

ボイスのボリュームを設定

引数

[in]

voiceKey

ボイスキー

戻り値

ボイスのボリューム．無効なボイスキーを指定した場合は0.0f

Initialize()

bool MGL::Audio::Player::Initialize ( STL::unique_ptr< Renderer > & renderer, InitializeMode initMode )

noexcept

初期化処理

引数

[in]

initMode

初期化モード

戻り値

true	成功
false	失敗

Load()

bool MGL::Audio::Player::Load ( const SharedVoice & voice )

noexcept

ボイスの読み込み

引数

[in]

voice

ボイス

戻り値

true	成功
false	失敗

MakeSourceInstance()

SharedSourceInstance MGL::Audio::Player::MakeSourceInstance ( VoiceKey key, bool isAutoRemove )

noexcept

ソースインスタンスを生成

引数

[in]	key	ボイスキー
[in]	isAutoRemove	自動削除フラグ

戻り値

生成したソースインスタンス．失敗時はnullptr

SetMasterVolume()

void MGL::Audio::Player::SetMasterVolume ( float volume )

inlinenoexcept

マスター音量の設定

引数

[in]

volume

設定する音量

SetVoiceVolume()

void MGL::Audio::Player::SetVoiceVolume ( VoiceKey voiceKey, float volume )

noexcept

ボイスのボリュームを設定

引数

[in]	voiceKey	ボイスキー
[in]	volume	ボリューム

Unload()

bool MGL::Audio::Player::Unload ( VoiceKey key )

noexcept

ボイスを解放

引数

[in]

key

ボイスキー

戻り値

true	成功
false	失敗

---

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

• /Users/acerola/x/mgl/include/mgl/audio/mgl_audio_player.h
• /Users/acerola/x/mgl/src/audio/mgl_audio_player.cc