OSDLAudio.h

Go to the documentation of this file.

#ifndef OSDL_AUDIO_H_
#define OSDL_AUDIO_H_


#include "OSDLTypes.h"       // for Flags
#include "OSDLException.h"   // for OSDL::Exception 

#include "Ceylan.h"          // for inheritance

#include <string>
#include <list>



namespace OSDL
{

    
    // Manager of the audio module.
    class CommonModule ;
        
    
    namespace Audio 
    {
            
            
        class OSDL_DLL AudioException: public OSDL::Exception 
        { 
            public: 
            
                AudioException( const std::string & reason ) throw() ; 
                virtual ~AudioException() throw() ; 
        } ;
                
                
                                
        class OSDL_DLL AudioModule : public Ceylan::Module
        {
        
        
            // The common module has to create the audio module.
            friend class OSDL::CommonModule ;
        
        
            public:


            
                virtual const std::string toString( 
                        Ceylan::VerbosityLevels level = Ceylan::high ) 
                    const throw() ;
            
                
                // Static section.
    
    
                static std::string DescribeEnvironmentVariables() throw() ; 
                    
                
                static bool IsAudioInitialized() throw() ;
                    
                
                    
            protected:
    

                static bool _AudioInitialized ;



            private:


    
                AudioModule() throw( AudioException ) ;


                virtual ~AudioModule() throw() ;
    
    
                explicit AudioModule( const AudioModule & source ) throw() ;
            
            
                AudioModule & operator = ( const AudioModule & source ) 
                    throw() ;
    


        
                static std::string SDLEnvironmentVariables[] ;
                            
                            
                // Common module must be able to create the audio module.       
                friend class CommonModule ;
            
            
        } ;
        
    }   
    
}   




#endif // OSDL_AUDIO_H_

---