Sound_effect.h

Go to the documentation of this file.

#ifndef HRK_SOUND_EFFECT_H
#define HRK_SOUND_EFFECT_H

#include <string>


namespace hrk
{
    class Sound_effect
    {
    public:
        enum {
            All_id = -1,        
            Invalid_id = -2,    
        };
        Sound_effect();
        ~Sound_effect();

        const char* what() const;

        void terminate();

        bool register_alias(const std::string& alias,
                            const std::string& file_name);

        void unregister_alias(const std::string& alias);

        void set_volume_percent(double percent);

        double volume_percent() const;

        int play(const std::string& alias, double fade_in_sec = 0.0);

        bool is_playing(int effect_id);

        void pause(int effect_id);

        void resume(int effect_id);

        void stop(int effect_id, double fade_out_sec = 0.0);

    private:
        Sound_effect(const Sound_effect& rhs);
        Sound_effect& operator = (const Sound_effect& rhs);

        struct pImpl;
        pImpl* pimpl;
    };
}

#endif