AbyssLib 1.301
あびす謹製ノベルゲームフレームワークライブラリ

クラス ISoundManager

サウンド用デバイスクラスのインターフェースです。 [詳細]

#include <SoundManager.h>

ISoundManagerに対する継承グラフ
BaseSoundManager NullSoundManager

すべてのメンバ一覧

Public メソッド

virtual long GetSEVolume () const =0
 SEの音量を取得します。
virtual long GetBGMVolume () const =0
 BGMの音量を取得します。
virtual long GetVoiceVolume () const =0
 音声の音量を取得します。
virtual void SetSEVolume (long Volume)=0
 SEの音量を設定します。
virtual void SetBGMVolume (long Volume)=0
 BGMの音量を設定します。
virtual void SetVoiceVolume (long Volume)=0
 音声の音量を設定します。
virtual void SetSEVolumeIM (long Volume)=0
 SEの音量を設定します。
virtual void SetBGMVolumeIM (long Volume)=0
 BGMの音量を設定します。
virtual void SetVoiceVolumeIM (long Volume)=0
 音声の音量を設定します。
virtual long GetDefaultSEVolume () const =0
 SEのデフォルト音量を取得します。
virtual long GetDefaultBGMVolume () const =0
 BGMのデフォルト音量を取得します。
virtual long GetDefaultVoiceVolume () const =0
 音声のデフォルト音量を取得します。
virtual void SetDefaultSEVolume (long Volume)=0
 SEのデフォルト音量を設定します。
virtual void SetDefaultBGMVolume (long Volume)=0
 BGMのデフォルト音量を設定します。
virtual void SetDefaultVoiceVolume (long Volume)=0
 音声のデフォルト音量を設定します。
virtual bool IsBasedOnDefaultSEVolume () const =0
 現在、SEの音量がデフォルト音量に準拠しているかを取得します。
virtual bool IsBasedOnDefaultBGMVolume () const =0
 現在、BGMの音量がデフォルト音量に準拠しているかを取得します。
virtual bool IsBasedOnDefaultVoiceVolume () const =0
 現在、音声の音量がデフォルト音量に準拠しているかを取得します。
virtual bool StopAllSE ()=0
 再生中の全SEを停止します。
virtual bool UnloadAllSE ()=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 StopBGM ()=0
 BGMを停止します。
virtual bool PlayBGM (const char *FileName)=0
 BGMを再生します(ループ再生)
virtual bool PlayOnceBGM (const char *FileName)=0
 BGMを再生します(1周だけ再生)
virtual bool StopAllVoice ()=0
 再生中の全音声を停止します。
virtual bool UnloadAllVoice ()=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 IsUsedSE (const char *FileName) const =0
 音声ファイルがSEとして現在使用されているかを取得します。
virtual bool IsUsedBGM (const char *FileName) const =0
 音声ファイルがBGMとして現在使用されているかを取得します。
virtual bool IsUsedVoice (const char *FileName) const =0
 音声ファイルが音声として現在使用されているかを取得します。

説明

サウンド用デバイスクラスのインターフェースです。

本クラスは全てのサウンド処理を行います。
各メソッドの説明を参考に、BaseSoundManagerクラスを継承して具象クラスを作成してください。


関数

virtual long GetSEVolume ( ) const [pure virtual]

SEの音量を取得します。

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

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

BaseSoundManagerで実装されています。

virtual long GetBGMVolume ( ) const [pure virtual]

BGMの音量を取得します。

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

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

BaseSoundManagerで実装されています。

virtual long GetVoiceVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual void SetSEVolume ( long  Volume) [pure virtual]

SEの音量を設定します。

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

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

BaseSoundManagerで実装されています。

virtual void SetBGMVolume ( long  Volume) [pure virtual]

BGMの音量を設定します。

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

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

BaseSoundManagerで実装されています。

virtual void SetVoiceVolume ( long  Volume) [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual void SetSEVolumeIM ( long  Volume) [pure virtual]

SEの音量を設定します。

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

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

BaseSoundManagerで実装されています。

virtual void SetBGMVolumeIM ( long  Volume) [pure virtual]

BGMの音量を設定します。

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

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

BaseSoundManagerで実装されています。

virtual void SetVoiceVolumeIM ( long  Volume) [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual long GetDefaultSEVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual long GetDefaultBGMVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual long GetDefaultVoiceVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual void SetDefaultSEVolume ( long  Volume) [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual void SetDefaultBGMVolume ( long  Volume) [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual void SetDefaultVoiceVolume ( long  Volume) [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual bool IsBasedOnDefaultSEVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual bool IsBasedOnDefaultBGMVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual bool IsBasedOnDefaultVoiceVolume ( ) const [pure virtual]

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

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

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

BaseSoundManagerで実装されています。

virtual bool StopAllSE ( ) [pure virtual]

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

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

BaseSoundManagerで実装されています。

virtual bool UnloadAllSE ( ) [pure virtual]

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

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

BaseSoundManagerで実装されています。

virtual bool PlaySE ( const char *  FileName) [pure virtual]

SEを再生します。

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool StopSE ( const char *  FileName) [pure virtual]

SEを停止します。

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool LoadSE ( const char *  FileName) [pure virtual]

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

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool UnloadSE ( const char *  FileName) [pure virtual]

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

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool StopBGM ( ) [pure virtual]

BGMを停止します。

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

BaseSoundManagerで実装されています。

virtual bool PlayBGM ( const char *  FileName) [pure virtual]

BGMを再生します(ループ再生)

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool PlayOnceBGM ( const char *  FileName) [pure virtual]

BGMを再生します(1周だけ再生)

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool StopAllVoice ( ) [pure virtual]

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

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

BaseSoundManagerで実装されています。

virtual bool UnloadAllVoice ( ) [pure virtual]

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

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

BaseSoundManagerで実装されています。

virtual bool PlayVoice ( const char *  FileName) [pure virtual]

音声を再生します。

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool StopVoice ( const char *  FileName) [pure virtual]

音声を停止します。

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool LoadVoice ( const char *  FileName) [pure virtual]

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

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

virtual bool UnloadVoice ( const char *  FileName) [pure virtual]

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

引数:
FileName[in]音声ファイル名を指定します。
戻り値:
成功した場合はtrueを、失敗した場合はfalseを返します。

BaseSoundManagerで実装されています。

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

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

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

BaseSoundManagerで実装されています。

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

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

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

BaseSoundManagerで実装されています。

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

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

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

BaseSoundManagerで実装されています。


このクラスの説明は次のファイルから生成されました:
 全て クラス ネームスペース ファイル 関数 変数 型定義 列挙型 列挙型の値 フレンド マクロ定義