OSDLAudible.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_AUDIBLE_H_
#define OSDL_AUDIBLE_H_


#include "OSDLAudioCommon.h" // for AudioException

#include "Ceylan.h"          // for inheritance, Millisecond, etc.

#include <string>




namespace OSDL
{

        
    
    namespace Audio 
    {
            
            
            
        class OSDL_DLL AudibleException: public AudioException 
        { 
            public: 
            
                AudibleException( const std::string & reason ) ; 
                
                virtual ~AudibleException() throw() ; 
        } ;
            
        
        
        typedef Ceylan::Sint32 PlaybackCount ;      
        
        
        
        extern OSDL_DLL const PlaybackCount Loop ;  
            
                
                
        extern OSDL_DLL const Volume MinVolume ;  
                
            
                
        extern OSDL_DLL const Volume MaxVolume ;  
            
                
                                    
                                                
        class OSDL_DLL Audible: public Ceylan::TextDisplayable
        {
        
        
            public:
                

                explicit Audible( bool convertedToOutputFormat = true ) ;
                
                
                virtual ~Audible() throw() ;
        
        
        
                virtual Volume getVolume() const = 0 ;
        
        
        
                virtual void setVolume( Volume newVolume ) = 0 ;
        
        
        
        
        
                // Play section.
                
                
                
                virtual void play( PlaybackCount playCount = 1 ) = 0 ; 
    
                                
                
                virtual void playWithFadeIn( 
                    Ceylan::System::Millisecond fadeInMaxDuration, 
                    PlaybackCount playCount = 1 ) = 0 ; 
                                    
                
                
                virtual bool isConvertedToOutputFormat() const ;
                
                
                
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;

            
            
                static std::string FindAudiblePath( 
                    const std::string & audibleFilename ) ;
                
            
            
            
            
            protected:
            
                            
                bool _convertedToOutputFormat ;
            
            
                
                static int GetLoopsForPlayCount( PlaybackCount playCount ) ;
            
            
            
            
            private:
    
    
    
                explicit Audible( const Audible & source ) ;
            
            
            
                Audible & operator = ( const Audible & source ) ;
                
            
        } ;
        
        
    }   
    
}   



#endif // OSDL_AUDIBLE_H_

---