channelInterface.hpp

/*
  ==============================================================================

    channel.h
    Created: 30 Jan 2014 4:20:50pm
    Author:  yvan

  ==============================================================================
*/

#ifndef CHANNELINTERFACE_H_INCLUDED
#define CHANNELINTERFACE_H_INCLUDED

#include <string>
#include "../headers/defines.hpp"
#include "../headers/types.hpp"
#include "channel.hpp"


namespace YSE {
  
  namespace SOUND {
    class managerObject;
    class implementationObject;
  }

  namespace CHANNEL{


    class API interfaceObject {
    public:

      interfaceObject&  create(const char * name, channel& parent);

      interfaceObject&  setVolume(Flt value);

      Flt getVolume();

      interfaceObject& moveTo(interfaceObject& parent);

      interfaceObject& attachReverb();

      interfaceObject& setVirtual(Bool value);

      bool getVirtual();

      bool isValid();

      const char * getName() { return name.c_str(); }

      interfaceObject();
      ~interfaceObject();
    private:
      
      void createGlobal();

      Flt volume; // to remember the channel volume
      Bool allowVirtual; // allows virtual sounds in this channel (defaults to true)
      std::string name;
      implementationObject * pimpl;

      // friend classes
      friend class CHANNEL::implementationObject;
      friend class SOUND::implementationObject;
      friend class YSE::system;
      friend class SOUND::managerObject;
    };
  }
  
  API channel& ChannelMaster();
  API channel& ChannelFX();
  API channel& ChannelMusic();
  API channel& ChannelAmbient();
  API channel& ChannelVoice();
  API channel& ChannelGui();
}




#endif  // CHANNEL_H_INCLUDED