サウンド用デバイスの基底クラスです。 [詳細]

#include <SoundManager.h>

BaseSoundManagerに対する継承グラフ

Public メソッド
	BaseSoundManager ()
	デフォルトコンストラクタです。
virtual	~BaseSoundManager ()
	仮想デストラクタです。
void	Initialize ()
	初期化を行います。
long	GetSEVolume () const
	SEの音量を取得します。
long	GetBGMVolume () const
	BGMの音量を取得します。
long	GetVoiceVolume () const
	音声の音量を取得します。
void	SetSEVolume (long Volume)
	SEの音量を設定します。
void	SetBGMVolume (long Volume)
	BGMの音量を設定します。
void	SetVoiceVolume (long Volume)
	音声の音量を設定します。
void	SetSEVolumeIM (long Volume)
	SEの音量を設定します。
void	SetBGMVolumeIM (long Volume)
	BGMの音量を設定します。
void	SetVoiceVolumeIM (long Volume)
	音声の音量を設定します。
long	GetDefaultSEVolume () const
	SEのデフォルト音量を取得します。
long	GetDefaultBGMVolume () const
	BGMのデフォルト音量を取得します。
long	GetDefaultVoiceVolume () const
	音声のデフォルト音量を取得します。
void	SetDefaultSEVolume (long Volume)
	SEのデフォルト音量を設定します。
void	SetDefaultBGMVolume (long Volume)
	BGMのデフォルト音量を設定します。
void	SetDefaultVoiceVolume (long Volume)
	音声のデフォルト音量を設定します。
bool	IsBasedOnDefaultSEVolume () const
	現在、SEの音量がデフォルト音量に準拠しているかを取得します。
bool	IsBasedOnDefaultBGMVolume () const
	現在、BGMの音量がデフォルト音量に準拠しているかを取得します。
bool	IsBasedOnDefaultVoiceVolume () const
	現在、音声の音量がデフォルト音量に準拠しているかを取得します。
void	SaveE (IIOStream *IOStream)
	環境設定の保存を行います。
void	LoadE (IIOStream *IOStream)
	環境設定の読み込みを行います。
void	SaveL (IIOStream *IOStream)
	ローカル設定の保存を行います。
void	LoadL (IIOStream *IOStream)
	ローカル設定の読み込みを行います。
bool	StopAllSE ()
	再生中の全SEを停止します。
bool	UnloadAllSE ()
	メモリに読み込んだ全SEを解放します。
bool	PlaySE (const char *FileName)
	SEを再生します。
bool	StopSE (const char *FileName)
	SEを停止します。
bool	LoadSE (const char *FileName)
	SEをメモリに読み込みます。
bool	UnloadSE (const char *FileName)
	SEをメモリから解放します。
bool	StopBGM ()
	BGMを停止します。
bool	PlayBGM (const char *FileName)
	BGMを再生します（ループ再生）
bool	PlayOnceBGM (const char *FileName)
	BGMを再生します（１周だけ再生）
bool	UnloadBGM ()
	BGMをメモリから解放します。
bool	StopAllVoice ()
	再生中の全音声を停止します。
bool	UnloadAllVoice ()
	メモリに読み込んだ全音声を解放します。
bool	PlayVoice (const char *FileName)
	音声を再生します。
bool	StopVoice (const char *FileName)
	音声を停止します。
bool	LoadVoice (const char *FileName)
	音声をメモリに読み込みます。
bool	UnloadVoice (const char *FileName)
	音声をメモリから解放します。
bool	IsUsedSE (const char *FileName) const
	音声ファイルがSEとして現在使用されているかを取得します。
bool	IsUsedBGM (const char *FileName) const
	音声ファイルがBGMとして現在使用されているかを取得します。
bool	IsUsedVoice (const char *FileName) const
	音声ファイルが音声として現在使用されているかを取得します。
Protected メソッド
virtual void	_SetSEVolume (long Volume)=0
	SEの音量を設定します。
virtual bool	_PlaySE (const char *FileName)=0
	SEを再生します。
virtual bool	_StopSE (const char *FileName)=0
	SEを停止します。
virtual bool	_LoadSE (const char *FileName)=0
	SEをメモリに読み込みます。
virtual bool	_UnloadSE (const char *FileName)=0
	SEをメモリから解放します。
virtual bool	_IsPlayingSE (const char *FileName) const =0
	音声ファイルがSEとして現在再生中かを取得します。
virtual void	_SetBGMVolume (long Volume)=0
	BGMの音量を設定します。
virtual bool	_PlayBGM (bool IsOnce)=0
	BGMを再生します。
virtual bool	_StopBGM ()=0
	BGMを停止します。
virtual bool	_LoadBGM (const char *FileName)=0
	BGMをメモリに読み込みます。
virtual bool	_UnloadBGM ()=0
	BGMをメモリから解放します。
virtual bool	_IsPlayingBGM () const =0
	BGMが現在再生中かを取得します。
virtual void	_SetVoiceVolume (long Volume)=0
	音声の音量を設定します。
virtual bool	_PlayVoice (const char *FileName)=0
	音声を再生します。
virtual bool	_StopVoice (const char *FileName)=0
	音声を停止します。
virtual bool	_LoadVoice (const char *FileName)=0
	音声をメモリに読み込みます。
virtual bool	_UnloadVoice (const char *FileName)=0
	音声をメモリから解放します。
virtual bool	_IsPlayingVoice (const char *FileName) const =0
	音声ファイルが音声として現在再生中かを取得します。

説明

サウンド用デバイスの基底クラスです。

実装する場合は本クラスから継承するようにしてください。

コンストラクタとデストラクタ

BaseSoundManager ( )

デフォルトコンストラクタです。

virtual ~BaseSoundManager ( ) [inline, virtual]

仮想デストラクタです。

関数

void Initialize ( )

初期化を行います。

long GetSEVolume ( ) const [virtual]

SEの音量を取得します。

音量は0〜10000の整数値です。

戻り値:: SEの音量を返します。

ISoundManagerを実装しています。

long GetBGMVolume ( ) const [virtual]

BGMの音量を取得します。

音量は0〜10000の整数値です。

戻り値:: BGMの音量を返します。

ISoundManagerを実装しています。

long GetVoiceVolume ( ) const [virtual]

音声の音量を取得します。

音量は0〜10000の整数値です。

戻り値:: 音声の音量を返します。

ISoundManagerを実装しています。

void SetSEVolume ( long Volume ) [virtual]

SEの音量を設定します。

音量は0〜10000の整数値です。
音量の変更は次回SE再生時から適用されます。
誤った指定の場合、ランタイムエラーが発生します。

引数:

Volume [in]SEの音量を指定します。
音量の範囲は0〜10000です。
範囲外を指定した場合、GetSEVolumeメソッドの戻り値が GetDefaultSEVolumeメソッドの戻り値と同じになります。

ISoundManagerを実装しています。

void SetBGMVolume ( long Volume ) [virtual]

BGMの音量を設定します。

音量は0〜10000の整数値です。
音量の変更は次回BGM再生時から適用されます。
誤った指定の場合、ランタイムエラーが発生します。

引数:

Volume [in]BGMの音量を指定します。
音量の範囲は0〜10000です。
範囲外を指定した場合、GetBGMVolumeメソッドの戻り値が GetDefaultBGMVolumeメソッドの戻り値と同じになります。

ISoundManagerを実装しています。

void SetVoiceVolume ( long Volume ) [virtual]

音声の音量を設定します。

音量は0〜10000の整数値です。
音量の変更は次回音声再生時から適用されます。
誤った指定の場合、ランタイムエラーが発生します。

引数:

Volume [in]音声の音量を指定します。
音量の範囲は0〜10000です。
範囲外を指定した場合、GetVoiceVolumeメソッドの戻り値が GetDefaultVoiceVolumeメソッドの戻り値と同じになります。

ISoundManagerを実装しています。

void SetSEVolumeIM ( long Volume ) [virtual]

SEの音量を設定します。

音量は0〜10000の整数値です。
音量の変更は即座に適用されます。

引数:

Volume [in]SEの音量を指定します。
音量の範囲は0〜10000です。
範囲外を指定した場合、SetSEVolumeメソッドの戻り値が GetDefaultSEVolumeメソッドの戻り値と同じになります。

ISoundManagerを実装しています。

void SetBGMVolumeIM ( long Volume ) [virtual]

BGMの音量を設定します。

音量は0〜10000の整数値です。
音量の変更は即座に適用されます。

引数:

Volume [in]BGMの音量を指定します。
音量の範囲は0〜10000です。
範囲外を指定した場合、SetBGMVolumeメソッドの戻り値が GetDefaultBGMVolumeメソッドの戻り値と同じになります。

ISoundManagerを実装しています。

void SetVoiceVolumeIM ( long Volume ) [virtual]

音声の音量を設定します。

音量は0〜10000の整数値です。
音量の変更は即座に適用されます。

引数:

Volume [in]音声の音量を指定します。
音量の範囲は0〜10000です。
範囲外を指定した場合、SetVoiceVolumeメソッドの戻り値が GetDefaultVoiceVolumeメソッドの戻り値と同じになります。

ISoundManagerを実装しています。

long GetDefaultSEVolume ( ) const [virtual]

SEのデフォルト音量を取得します。

音量は0〜10000の整数値です。

戻り値:: SEのデフォルト音量を返します。

ISoundManagerを実装しています。

long GetDefaultBGMVolume ( ) const [virtual]

BGMのデフォルト音量を取得します。

音量は0〜10000の整数値です。

戻り値:: BGMのデフォルト音量を返します。

ISoundManagerを実装しています。

long GetDefaultVoiceVolume ( ) const [virtual]

音声のデフォルト音量を取得します。

音量は0〜10000の整数値です。

戻り値:: 音声のデフォルト音量を返します。

ISoundManagerを実装しています。

void SetDefaultSEVolume ( long Volume ) [virtual]

SEのデフォルト音量を設定します。

音量は0〜10000の整数値です。

引数:

Volume [in]SEのデフォルト音量を指定します。
音量の範囲は0〜10000です。

ISoundManagerを実装しています。

void SetDefaultBGMVolume ( long Volume ) [virtual]

BGMのデフォルト音量を設定します。

音量は0〜10000の整数値です。

引数:

Volume [in]BGMのデフォルト音量を指定します。
音量の範囲は0〜10000です。

ISoundManagerを実装しています。

void SetDefaultVoiceVolume ( long Volume ) [virtual]

音声のデフォルト音量を設定します。

音量は0〜10000の整数値です。

引数:

Volume [in]音声のデフォルト音量を指定します。
音量の範囲は0〜10000です。

ISoundManagerを実装しています。

bool IsBasedOnDefaultSEVolume ( ) const [virtual]

現在、SEの音量がデフォルト音量に準拠しているかを取得します。

SetSEVolume〜メソッドで範囲（0〜10000）外を指定した場合、SEの音量がデフォルト音量に準拠するようになります。

戻り値:: 現在、SEの音量がデフォルト音量に準拠しているかを返します。
準拠している場合はtrueを、そうでない場合はfalseを返します。

ISoundManagerを実装しています。

bool IsBasedOnDefaultBGMVolume ( ) const [virtual]

現在、BGMの音量がデフォルト音量に準拠しているかを取得します。

SetBGMVolume〜メソッドで範囲（0〜10000）外を指定した場合、BGMの音量がデフォルト音量に準拠するようになります。

戻り値:: 現在、BGMの音量がデフォルト音量に準拠しているかを返します。
準拠している場合はtrueを、そうでない場合はfalseを返します。

ISoundManagerを実装しています。

bool IsBasedOnDefaultVoiceVolume ( ) const [virtual]

現在、音声の音量がデフォルト音量に準拠しているかを取得します。

SetVoiceVolume〜メソッドで範囲（0〜10000）外を指定した場合、音声の音量がデフォルト音量に準拠するようになります。

戻り値:: 現在、音声の音量がデフォルト音量に準拠しているかを返します。
準拠している場合はtrueを、そうでない場合はfalseを返します。

ISoundManagerを実装しています。

void SaveE ( IIOStream * IOStream )

環境設定の保存を行います。

引数:

IOStream [in]データ入出力クラスを指定します。

void LoadE ( IIOStream * IOStream )

環境設定の読み込みを行います。

引数:

IOStream [in]データ入出力クラスを指定します。

void SaveL ( IIOStream * IOStream )

ローカル設定の保存を行います。

引数:

IOStream [in]データ入出力クラスを指定します。

void LoadL ( IIOStream * IOStream )

ローカル設定の読み込みを行います。

ＢＧＭの再生に失敗した場合、ランタイムエラーが発生します。

引数:

IOStream [in]データ入出力クラスを指定します。

bool StopAllSE ( ) [virtual]

再生中の全SEを停止します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool UnloadAllSE ( ) [virtual]

メモリに読み込んだ全SEを解放します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool PlaySE ( const char * FileName ) [virtual]

SEを再生します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool StopSE ( const char * FileName ) [virtual]

SEを停止します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool LoadSE ( const char * FileName ) [virtual]

SEをメモリに読み込みます。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool UnloadSE ( const char * FileName ) [virtual]

SEをメモリから解放します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool StopBGM ( ) [virtual]

BGMを停止します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool PlayBGM ( const char * FileName ) [virtual]

BGMを再生します（ループ再生）

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool PlayOnceBGM ( const char * FileName ) [virtual]

BGMを再生します（１周だけ再生）

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool UnloadBGM ( )

BGMをメモリから解放します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

bool StopAllVoice ( ) [virtual]

再生中の全音声を停止します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool UnloadAllVoice ( ) [virtual]

メモリに読み込んだ全音声を解放します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool PlayVoice ( const char * FileName ) [virtual]

音声を再生します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool StopVoice ( const char * FileName ) [virtual]

音声を停止します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool LoadVoice ( const char * FileName ) [virtual]

音声をメモリに読み込みます。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool UnloadVoice ( const char * FileName ) [virtual]

音声をメモリから解放します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

ISoundManagerを実装しています。

bool IsUsedSE ( const char * FileName ) const [virtual]

音声ファイルがSEとして現在使用されているかを取得します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルがSEとして現在使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

ISoundManagerを実装しています。

bool IsUsedBGM ( const char * FileName ) const [virtual]

音声ファイルがBGMとして現在使用されているかを取得します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルがBGMとして現在使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

ISoundManagerを実装しています。

bool IsUsedVoice ( const char * FileName ) const [virtual]

音声ファイルが音声として現在使用されているかを取得します。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルが音声として現在使用されているかを返します。
使用されている場合はtrueを、そうでない場合はfalseを返します。

ISoundManagerを実装しています。

virtual void _SetSEVolume ( long Volume ) [protected, pure virtual]

SEの音量を設定します。

設定するように実装してください。
音量は0〜10000の整数値です。

引数:

Volume [in]SEの音量を指定します。

NullSoundManagerで実装されています。

virtual bool _PlaySE ( const char * FileName ) [protected, pure virtual]

SEを再生します。

再生するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _StopSE ( const char * FileName ) [protected, pure virtual]

SEを停止します。

停止するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _LoadSE ( const char * FileName ) [protected, pure virtual]

SEをメモリに読み込みます。

読み込むように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _UnloadSE ( const char * FileName ) [protected, pure virtual]

SEをメモリから解放します。

解放するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _IsPlayingSE ( const char * FileName ) const [protected, pure virtual]

音声ファイルがSEとして現在再生中かを取得します。

取得するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルがSEとして現在再生中かを返します。
再生中の場合はtrueを、そうでない場合はfalseを返します。

NullSoundManagerで実装されています。

virtual void _SetBGMVolume ( long Volume ) [protected, pure virtual]

BGMの音量を設定します。

設定するように実装してください。
音量は0〜10000の整数値です。

引数:

Volume [in]BGMの音量を指定します。

NullSoundManagerで実装されています。

virtual bool _PlayBGM ( bool IsOnce ) [protected, pure virtual]

BGMを再生します。

再生するように実装してください。

引数:

IsOnce [in]１周のみの再生かループ再生かを指定します。
１周のみの場合はtrueを、ループ再生の場合はfalseを指定してください。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _StopBGM ( ) [protected, pure virtual]

BGMを停止します。

停止するように実装してください。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _LoadBGM ( const char * FileName ) [protected, pure virtual]

BGMをメモリに読み込みます。

読み込むように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _UnloadBGM ( ) [protected, pure virtual]

BGMをメモリから解放します。

解放するように実装してください。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _IsPlayingBGM ( ) const [protected, pure virtual]

BGMが現在再生中かを取得します。

取得するように実装してください。

戻り値:: BGMが現在再生中かを返します。
再生中の場合はtrueを、そうでない場合はfalseを返します。

NullSoundManagerで実装されています。

virtual void _SetVoiceVolume ( long Volume ) [protected, pure virtual]

音声の音量を設定します。

設定するように実装してください。
音量は0〜10000の整数値です。

引数:

Volume [in]音声の音量を指定します。

NullSoundManagerで実装されています。

virtual bool _PlayVoice ( const char * FileName ) [protected, pure virtual]

音声を再生します。

再生するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _StopVoice ( const char * FileName ) [protected, pure virtual]

音声を停止します。

停止するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _LoadVoice ( const char * FileName ) [protected, pure virtual]

音声をメモリに読み込みます。

読み込むように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _UnloadVoice ( const char * FileName ) [protected, pure virtual]

音声をメモリから解放します。

解放するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 成功した場合はtrueを、失敗した場合はfalseを返します。

NullSoundManagerで実装されています。

virtual bool _IsPlayingVoice ( const char * FileName ) const [protected, pure virtual]

音声ファイルが音声として現在再生中かを取得します。

取得するように実装してください。

引数:

FileName [in]音声ファイル名を指定します。

戻り値:: 音声ファイルが音声として現在再生中かを返します。
再生中の場合はtrueを、そうでない場合はfalseを返します。

NullSoundManagerで実装されています。

このクラスの説明は次のファイルから生成されました:

AbyssLibSrc/AbyssLib/AbyssLib/SoundManager.h

クラス BaseSoundManager

Public メソッド

Protected メソッド

説明

コンストラクタとデストラクタ

関数