趣味で作ってるロボット用ソフトウェア
 All Classes Files Functions Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
hrk::Sound_effect Class Reference

効果音の再生 More...

#include <Sound_effect.h>

Public Types

enum  { All_id = -1, Invalid_id = -2 }
 

Public Member Functions

const char * what () const
 状態を示すメッセージを返す More...
 
void terminate ()
 リソースを解放する
 
bool register_alias (const std::string &alias, const std::string &file_name)
 効果音を登録する More...
 
void unregister_alias (const std::string &alias)
 登録した効果音を解放する More...
 
void set_volume_percent (double percent)
 音量を設定する
 
double volume_percent () const
 音量の設定を取得する
 
int play (const std::string &alias, double fade_in_sec=0.0)
 効果音を再生する More...
 
bool is_playing (int effect_id)
 効果音を再生中かを返す More...
 
void pause (int effect_id)
 効果音の再生をポーズする More...
 
void resume (int effect_id)
 効果音の再生を再開する More...
 
void stop (int effect_id, double fade_out_sec=0.0)
 効果音の再生を停止する More...
 

Detailed Description

効果音の再生

Examples:
play_sound_effect.cpp.

Member Enumeration Documentation

anonymous enum
Enumerator
All_id 

再生中の効果音を指定するときの ID

Invalid_id 

無効な ID

Member Function Documentation

const char * Sound_effect::what ( void  ) const

状態を示すメッセージを返す

Returns
メッセージ文字列
Examples:
play_sound_effect.cpp.
bool Sound_effect::register_alias ( const std::string &  alias,
const std::string &  file_name 
)

効果音を登録する

Parameters
[in]alias登録名
[in]file_name効果音のファイル名
Return values
true成功
falseエラー
Examples:
play_sound_effect.cpp.
void Sound_effect::unregister_alias ( const std::string &  alias)

登録した効果音を解放する

Parameters
[in]alias登録名
Examples:
play_sound_effect.cpp.
int Sound_effect::play ( const std::string &  alias,
double  fade_in_sec = 0.0 
)

効果音を再生する

Parameters
[in]alias登録名
[in]fade_in_secフェードインの時間 [秒]
Returns
再生 ID
Return values
Invalid_idエラー
Examples:
play_sound_effect.cpp.
bool Sound_effect::is_playing ( int  effect_id)

効果音を再生中かを返す

Parameters
[in]play_id再生 ID
Return values
true再生中
false再生していない
Examples:
play_sound_effect.cpp.
void Sound_effect::pause ( int  effect_id)

効果音の再生をポーズする

Parameters
[in]play_id再生 ID
void Sound_effect::resume ( int  effect_id)

効果音の再生を再開する

Parameters
[in]play_id再生 ID
void Sound_effect::stop ( int  effect_id,
double  fade_out_sec = 0.0 
)

効果音の再生を停止する

Parameters
[in]play_id再生 ID
[in]fade_out_secフェードアウト時間 [秒]

The documentation for this class was generated from the following files: