OSDLAudioChannel.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_AUDIO_CHANNEL_H_
#define OSDL_AUDIO_CHANNEL_H_


#include "OSDLAudioCommon.h" // for AudioException, FadingStatus, etc.

#include "Ceylan.h"          // for inheritance

#include <string>




namespace OSDL
{

    
    
    namespace Audio 
    {
            

            
        class OSDL_DLL AudioChannelException: public AudioException 
        { 
            public: 
            
                AudioChannelException( const std::string & reason ) ; 
                virtual ~AudioChannelException() throw() ; 
        } ;
            
                            
                                                
        class OSDL_DLL AudioChannel: public Ceylan::TextDisplayable
        {
        
        
            public:
                


                explicit AudioChannel( ChannelNumber channelNumber ) ;
                
                
                
                virtual ~AudioChannel() throw() ;
        
        
        
                virtual ChannelNumber getNumber() const ;
        
        
        
                virtual Volume getVolume() const ;


        
                virtual void setVolume( Volume newVolume ) ;
        
        
        
                virtual void setPanning( 
                    Ceylan::Maths::Percentage leftPercentage ) ;
                    
                    
                    
                virtual void unsetPanning() ;
        
        

                virtual void setReverseStereo( bool reverse = true ) ;
        
        
        
                virtual void setDistanceAttenuation( 
                    ListenerDistance distance ) ;
                    
                    
                    
                virtual void unsetDistanceAttenuation() ;
        


                virtual void setPositionAttenuation( ListenerDistance distance,
                    ListenerAngle angle )  ;
                    
                    
                    
                virtual void unsetPositionAttenuation() ;


        
                virtual bool isPlaying() const ;
                
                
                
                virtual bool isPaused() const ;
                
                
                
                virtual FadingStatus getFadingStatus() const ;
                
                
                
                virtual void pause() ;
        
        
        
                virtual void resume() ;
        
        
        
                virtual void waitEndOfPlayback() const ;
                    

                
                virtual void halt() ;
        
        
        
                virtual void expireIn( 
                    Ceylan::System::Millisecond expireDuration ) ;
        
        
        
                virtual void fadeOutDuring( 
                    Ceylan::System::Millisecond fadeOutDuration ) ;
        
                    
        
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
            
            
            
            
            protected:
            
                
                
                virtual void onPlaybackFinished() ;

            
            
                ChannelNumber _channelNumber ;
                
                
                
                
            private:



                static void HandleFinishedPlaybackCallback( 
                    int channelNumber ) ;
                

    
                explicit AudioChannel( const AudioChannel & source ) ;
            
            
            
                AudioChannel & operator = ( const AudioChannel & source ) ;
                
            
        } ;
        
        
    }   
    
}   



#endif // OSDL_AUDIO_CHANNEL_H_

---