libmedia/AudioInput.h

   1 // AudioInput.h: Audio input base class
   2 //
   3 //   Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012
   4 //   Free Software Foundation, Inc.
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 3 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19
  20 #ifndef GNASH_AUDIOINPUT_H
  21 #define GNASH_AUDIOINPUT_H
  22
  23 #include <boost/cstdint.hpp> // for C99 int types
  24 #include <string>
  25 #include "dsodefs.h" //DSOEXPORT
  26
  27 namespace gnash {
  28 namespace media {
  29
  30 /// A class representing a single AudioInput device.
  31 //
  32 /// This interface has almost everything needed for control of the input
  33 /// device, but currently no data-fetching functions. These should be
  34 /// implemented only when the requirements of AS have been investigated!
  35 class AudioInput
  36 {
  37
  38 public:
  39
  40     DSOEXPORT AudioInput() {}
  41
  42     virtual ~AudioInput() {}
  43
  44     virtual void setActivityLevel(double a) = 0;
  45
  46     virtual double activityLevel() const = 0;
  47
  48     virtual void setGain(double g) = 0;
  49
  50     virtual double gain() const = 0;
  51
  52     virtual void setIndex(int i) = 0;
  53
  54     virtual int index() const = 0;
  55
  56     virtual bool muted() = 0;
  57
  58     virtual void setName(std::string name) = 0;
  59
  60     virtual const std::string& name() const = 0;
  61
  62     virtual void setRate(int r) = 0;
  63
  64     virtual int rate() const = 0;
  65
  66     virtual void setSilenceLevel(double s) = 0;
  67
  68     virtual double silenceLevel() const = 0;
  69
  70     virtual void setSilenceTimeout(int s) = 0;
  71
  72     virtual int silenceTimeout() const = 0;
  73
  74     virtual void setUseEchoSuppression(bool e) = 0;
  75
  76     virtual bool useEchoSuppression() const = 0;
  77
  78 };
  79
  80
  81 } // gnash.media namespace
  82 } // gnash namespace
  83
  84 #endif