電子マネーのサウンド情報を提供するクラス。 [詳解]

#include <EMoneySound.h>

公開メンバ関数
	EMoneySound (bool stopRequired, const wchar_t *filePath)
	コンストラクタ。 [詳解]

	EMoneySound (const EMoneySound &src)
	コピーコンストラクタ。 [詳解]

	EMoneySound (EMoneySound &&src)
	ムーブコンストラクタ。 [詳解]

	‾EMoneySound ()
	デストラクタ。 [詳解]

EMoneySound &	operator= (const EMoneySound &r)
	コピー代入演算子のオーバロード。 [詳解]

EMoneySound &	operator= (EMoneySound &&r)
	ムーブ代入演算子のオーバロード。 [詳解]

bool	isStopRequired () const
	サウンド停止処理要求であるか否かを取得する。 [詳解]

const wchar_t *	getId () const
	サウンドIDを取得する。 [詳解]

const wchar_t *	getFilePath () const
	サウンドWAVEファイルパスを取得する。 [詳解]

詳解

電子マネーのサウンド情報を提供するクラス。

参照: EMoney, EMoney::setSoundHook

EMoney クラスのメンバ関数 EMoney::setSoundHook に設定したコールバックへ受け渡される。

サウンド再生について: 一般業務用の電子マネー対応アプリでは、メンバ関数 getFilePath が返すWAVEファイルパスを用いてサウンド再生を行うが、この方法はゲーム用途にはそぐわない場合が多い。

: そこで、メンバ関数 getId などの情報を用いて、ゲームアプリにとって最適な手段でサウンド再生を行っても構わない。当然ながら、再生されるサウンドは本来のWAVEファイルと同等のものにすること。

: いずれの場合でも、メンバ関数 isStopRequired が true を返す場合は、再生中の電子マネー関連サウンドの停止処理を行うこと。

構築子と解体子

amdaemon::EMoneySound::EMoneySound	(	bool	stopRequired,
		const wchar_t *	filePath
	)

コンストラクタ。

引数

[in]	stopRequired	停止処理要求フラグ。
[in]	filePath	サウンドWAVEファイルパス。 stopRequired が true ならば無視される。

amdaemon::EMoneySound::EMoneySound ( const EMoneySound & src )

コピーコンストラクタ。

引数

[in] src コピー元。

amdaemon::EMoneySound::EMoneySound ( EMoneySound && src )

ムーブコンストラクタ。

引数

[in] src ムーブ元。

amdaemon::EMoneySound::‾EMoneySound ( )

デストラクタ。

関数詳解

EMoneySound& amdaemon::EMoneySound::operator= ( const EMoneySound & r )

コピー代入演算子のオーバロード。

引数

[in] r 右辺値。

戻り値: 自身の参照。

EMoneySound& amdaemon::EMoneySound::operator= ( EMoneySound && r )

ムーブ代入演算子のオーバロード。

引数

[in] r 右辺値。

戻り値: 自身の参照。

bool amdaemon::EMoneySound::isStopRequired ( ) const

inline

サウンド停止処理要求であるか否かを取得する。

戻り値

true	サウンド停止処理要求である場合。
false	サウンド再生処理要求である場合。

この関数が true を返す場合、電子マネー関連サウンドの停止処理を行うこと。既に停止済みである場合は何も行わなくてよい。

この関数が true を返す場合、メンバ関数 getId および getFilePath は nullptr を返す。

const wchar_t* amdaemon::EMoneySound::getId ( ) const

サウンドIDを取得する。

戻り値: サウンドID。停止処理要求の場合は nullptr 。

サウンドWAVEファイルパスのファイル名部分を抜き出した文字列を返す。ただし停止指示の場合は nullptr を返す。

例えば "0001-02-00" といった文字列になる。ゲームアプリで再生するサウンドを決定するためのキーとして利用できる。

この関数の返す文字列にはファイル拡張子は含まれない。拡張子を含めたファイル名を取得したい場合は、 getFilePath の戻り値に対して util::Path クラスの静的メンバ関数 util::Path::getName を用いて抜き出すとよい。

const wchar_t* amdaemon::EMoneySound::getFilePath ( ) const

サウンドWAVEファイルパスを取得する。

戻り値: サウンドWAVEファイルパス。停止処理要求の場合は nullptr 。

設定ファイルで指定したリソースディレクトリ以下にある、サウンドWAVEファイルの絶対パスを返す。ただし停止指示の場合は nullptr を返す。

サウンド再生については EMoneySound クラスの説明を参照すること。

ファイル名のみ利用したい場合、 util::Path クラスの静的メンバ関数 util::Path::getName を用いるとよい。

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

EMoneySound.h

公開メンバ関数

詳解

構築子と解体子

関数詳解