view/sound/MusicManager.h

#ifndef MUSIC_MANAGER_H
#define MUSIC_MANAGER_H

/*!
  \file
  \brief wiČĚÇ

  \author Satofumi KAMIMURA

  $Id$
*/

#include <memory>


namespace beego {
  /*!
    \brief wiČĚÇNX
  */
  class MusicManager {
    MusicManager(const MusicManager& rhs);
    MusicManager& operator = (const MusicManager& rhs);

    struct pImpl;
    //const std::auto_ptr<pImpl> pimpl;
    // !!! shared_ptr Éˇ×ŤČĚŠH
    pImpl* pimpl;

  public:
    enum {
      Infinity = -1,                //!< łŔńĚÄś
    };
    MusicManager(void);
    ~MusicManager(void);

    /*!
      \brief úťĎÝŠđÔˇ

      \retval true úťĎÝ
      \retval false ˘úť
    */
    bool isInitialized(void);

    /*!
      \brief šyĚo^

      \param music_id [i] o^ľ˝˘ ID Ô
      \param file_path [i] šyt@CĚ épX

      \retval true o^Ź÷
      \retval false o^¸s

      \attention Żś music_id ŞĄwčłę˝ęAĹăĚwčŞLřÉČé
    */

    bool registerMusic(int music_id, const char* file_path);

    /*!
      \brief šyĚo^í

      \param music_id [i] íľ˝˘ ID Ô
    */
    void unregisterMusic(int music_id);

    /*!
      \brief šĘĚđÝč

      \param percent [i] šyĚoÍ{[Ýu [%]
    */
    void updateVolume(size_t percent);

    /*!
      \brief ČĚŘčÖŚ

      \param next_music_id [i] ÉÄśłšéšyĚ ID Ô
      \param play_times [i] Äśń (0 ĹÄśâ~)
    */
    void setNextMusic(int next_music_id, int play_times = Infinity);

    /*!
      \brief ČĚâ~

      \param fade_out_msec [i] tF[hAEgÔ [msec]
    */
    void stop(size_t fade_out_msec = 0);

    void halt(void);

    /*!
      \brief tF[hCÝč

      setNextMusic() Épłęé

      \param effect_msec [i] tF[hCÔ [msec]
    */
    void setFadeInEffect(size_t effect_msec);

    /*!
      \brief tF[hAEgÝč

      setNextMusic(), stop() Épłęé

      \param effect_msec [i] tF[hAEgÔ [msec]
    */
    void setFadeOutEffect(size_t effect_msec);

    /*!
      \brief ťÝÄśĚšyÔđwč

      \return ÄśĚšyÔ

      \attention ÄśoČ˘ęAßčlÍłř
    */
    int getCurrentMusicId(void);

    /*!
      \brief ÄśŠđÔˇ

      \retval true Äś
      \retval false â~
    */
    bool nowPlaying(void);
  };
};

#endif /* !MUSIC_MANAGER_H */