Gnash  0.8.11dev
Public Member Functions | List of all members
gnash::media::gst::AudioInputGst Class Reference

The main AudioInputGst class, which actually doesn't store too much important information (most of that is stored in the GnashAudio and GnashAudioPrivate classes) More...

#include <AudioInputGst.h>

Inheritance diagram for gnash::media::gst::AudioInputGst:
gnash::media::AudioInput gnash::media::gst::GnashAudioPrivate

Public Member Functions

 AudioInputGst ()
 This part implements the interface. More...
 
virtual ~AudioInputGst ()
 
virtual void setActivityLevel (double a)
 
virtual double activityLevel () const
 
virtual void setGain (double g)
 Set the input's gain. More...
 
virtual double gain () const
 Get the input's gain. More...
 
virtual void setIndex (int i)
 
virtual int index () const
 
virtual bool muted ()
 
virtual void setName (std::string name)
 
virtual const std::string & name () const
 
virtual void setRate (int r)
 Supported rates are (maybe hardware-dependent): 5, 8, 11, 16, 22, 44. More...
 
virtual int rate () const
 Supported rates are (maybe hardware-dependent): 5, 8, 11, 16, 22, 44. More...
 
virtual void setSilenceLevel (double s)
 
virtual double silenceLevel () const
 
virtual void setSilenceTimeout (int s)
 
virtual int silenceTimeout () const
 
virtual void setUseEchoSuppression (bool e)
 
virtual bool useEchoSuppression () const
 
- Public Member Functions inherited from gnash::media::AudioInput
DSOEXPORT AudioInput ()
 
virtual ~AudioInput ()
 
- Public Member Functions inherited from gnash::media::gst::GnashAudioPrivate
 GnashAudioPrivate ()
 Constructor for the GnashAudioPrivate class. More...
 
void setAudioDevice (GnashAudio *d)
 This function sets the private _audioDevice element in the GnashAudioPrivate class. More...
 
GnashAudiogetAudioDevice ()
 This function returns the private _audioDevice element pointer from the GnashAudioPrivate class. More...
 
void setDeviceName (gchar *n)
 This function sets the private _deviceName element in the GnashAudioPrivate class. More...
 
gchar * getDeviceName ()
 This function returns the private _deviceName variable from the GnashAudioPrivate class. More...
 

Additional Inherited Members

- Public Attributes inherited from gnash::media::gst::GnashAudioPrivate
GstElement * audioSource
 A pointer to the Gstreamer element corresponding to the audio source (e.g. a built-in or usb microphone). More...
 
GstElement * audioEnc
 A pointer to the audio encoder element of the Gstreamer pipeline. The only format currently supported format is vorbis. More...
 
GnashAudio_audioDevice
 A pointer to the GnashAudio class of the selected hardware device This info should be stored to the GnashAudioPrivate class in the transferToPrivate function. More...
 
gchar * _deviceName
 A gchar* describing the physical input device's name (e.g. HDA Intel or Built-In Microphone) More...
 
GstElement * _pipeline
 A pointer to the main Gstreamer pipeline that all created elements and bins will be dropped into. More...
 
GstElement * _audioMainBin
 
GstElement * _audioSourceBin
 
GstElement * _audioPlaybackBin
 
GstElement * _audioSaveBin
 
GstElement * _mux
 A direct link to the oggmux element in the _audioSaveBin for use with linking up to a video muxer so that audio and video are both muxed out to the same file. More...
 
gboolean _pipelineIsPlaying
 A boolean value which stores whether or not the _pipeline element is currently in it's 'playing' state or not. More...
 

Detailed Description

The main AudioInputGst class, which actually doesn't store too much important information (most of that is stored in the GnashAudio and GnashAudioPrivate classes)

The top part of this class implements the AudioInput interface, which is more or less what is needed to implement the rest, though it lacks any data-fetching methods. I'm not sure what the rest of it does, but it's not anything useful. Anyone implementing this class should start by implementing the interface.

Constructor & Destructor Documentation

§ AudioInputGst()

gnash::media::gst::AudioInputGst::AudioInputGst ( )

This part implements the interface.

§ ~AudioInputGst()

gnash::media::gst::AudioInputGst::~AudioInputGst ( )
virtual

Member Function Documentation

§ activityLevel()

virtual double gnash::media::gst::AudioInputGst::activityLevel ( ) const
inlinevirtual

§ gain()

virtual double gnash::media::gst::AudioInputGst::gain ( ) const
inlinevirtual

Get the input's gain.

Interface range is 0..100, gst range is -60 to 60 TODO: shouldn't we query the value from the input rather than storing it here?

Implements gnash::media::AudioInput.

§ index()

virtual int gnash::media::gst::AudioInputGst::index ( ) const
inlinevirtual

§ muted()

virtual bool gnash::media::gst::AudioInputGst::muted ( )
inlinevirtual

§ name()

virtual const std::string& gnash::media::gst::AudioInputGst::name ( ) const
inlinevirtual

§ rate()

virtual int gnash::media::gst::AudioInputGst::rate ( ) const
inlinevirtual

Supported rates are (maybe hardware-dependent): 5, 8, 11, 16, 22, 44.

TODO: store in device and query that.

Implements gnash::media::AudioInput.

§ setActivityLevel()

virtual void gnash::media::gst::AudioInputGst::setActivityLevel ( double  a)
inlinevirtual

Implements gnash::media::AudioInput.

References gnash::key::a.

§ setGain()

virtual void gnash::media::gst::AudioInputGst::setGain ( double  g)
inlinevirtual

Set the input's gain.

Interface range is 0..100, gst range is -60 to 60 TODO: shouldn't we set the value in the input rather than storing it here?

Implements gnash::media::AudioInput.

References gnash::key::g.

§ setIndex()

virtual void gnash::media::gst::AudioInputGst::setIndex ( int  i)
inlinevirtual

§ setName()

virtual void gnash::media::gst::AudioInputGst::setName ( std::string  name)
inlinevirtual

§ setRate()

virtual void gnash::media::gst::AudioInputGst::setRate ( int  r)
inlinevirtual

Supported rates are (maybe hardware-dependent): 5, 8, 11, 16, 22, 44.

TODO: store in device and query that.

Implements gnash::media::AudioInput.

§ setSilenceLevel()

virtual void gnash::media::gst::AudioInputGst::setSilenceLevel ( double  s)
inlinevirtual

Implements gnash::media::AudioInput.

References gnash::key::s.

§ setSilenceTimeout()

virtual void gnash::media::gst::AudioInputGst::setSilenceTimeout ( int  s)
inlinevirtual

Implements gnash::media::AudioInput.

References gnash::key::s.

§ setUseEchoSuppression()

virtual void gnash::media::gst::AudioInputGst::setUseEchoSuppression ( bool  e)
inlinevirtual

Implements gnash::media::AudioInput.

References gnash::key::e.

§ silenceLevel()

virtual double gnash::media::gst::AudioInputGst::silenceLevel ( ) const
inlinevirtual

§ silenceTimeout()

virtual int gnash::media::gst::AudioInputGst::silenceTimeout ( ) const
inlinevirtual

§ useEchoSuppression()

virtual bool gnash::media::gst::AudioInputGst::useEchoSuppression ( ) const
inlinevirtual

The documentation for this class was generated from the following files: