Gst::StreamVolume Class Reference
[gstreamermm Interfaces]

Gst::StreamVolume - Interface for elements that provide a stream volume. More...

Inherits Glib::Interface.

Inherited by Gst::PlayBin2, and Gst::Volume.

Collaboration diagram for Gst::StreamVolume:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~StreamVolume ()
GstStreamVolume* gobj ()
 Provides access to the underlying C GObject.
const GstStreamVolume* gobj () const
 Provides access to the underlying C GObject.
double get_volume (Gst::StreamVolumeFormat format)
void set_volume (Gst::StreamVolumeFormat format, double val)
bool get_mute ()
void set_mute (bool mute)
Glib::PropertyProxy< bool > property_mute ()
 Mute the audio channel without changing the volume.
Glib::PropertyProxy_ReadOnly
< bool > 
property_mute () const
 Mute the audio channel without changing the volume.
Glib::PropertyProxy< double > property_volume ()
 Linear volume factor.
Glib::PropertyProxy_ReadOnly
< double > 
property_volume () const
 Linear volume factor.

Static Public Member Functions

static void add_interface (GType gtype_implementer)
static double convert_volume (Gst::StreamVolumeFormat from, Gst::StreamVolumeFormat to, double val)

Related Functions

(Note that these are not member functions.)



Glib::RefPtr< Gst::StreamVolumewrap (GstStreamVolume* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

Gst::StreamVolume - Interface for elements that provide a stream volume.


Constructor & Destructor Documentation

virtual Gst::StreamVolume::~StreamVolume (  )  [virtual]

Member Function Documentation

static void Gst::StreamVolume::add_interface ( GType  gtype_implementer  )  [static]
static double Gst::StreamVolume::convert_volume ( Gst::StreamVolumeFormat  from,
Gst::StreamVolumeFormat  to,
double  val 
) [static]
bool Gst::StreamVolume::get_mute (  ) 
double Gst::StreamVolume::get_volume ( Gst::StreamVolumeFormat  format  ) 
const GstStreamVolume* Gst::StreamVolume::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gst::PlayBin2, and Gst::Volume.

GstStreamVolume* Gst::StreamVolume::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gst::PlayBin2, and Gst::Volume.

Glib::PropertyProxy_ReadOnly<bool> Gst::StreamVolume::property_mute (  )  const

Mute the audio channel without changing the volume.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Reimplemented in Gst::PlayBin2, and Gst::Volume.

Glib::PropertyProxy<bool> Gst::StreamVolume::property_mute (  ) 

Mute the audio channel without changing the volume.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Reimplemented in Gst::PlayBin2, and Gst::Volume.

Glib::PropertyProxy_ReadOnly<double> Gst::StreamVolume::property_volume (  )  const

Linear volume factor.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Reimplemented in Gst::PlayBin2, and Gst::Volume.

Glib::PropertyProxy<double> Gst::StreamVolume::property_volume (  ) 

Linear volume factor.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Reimplemented in Gst::PlayBin2, and Gst::Volume.

void Gst::StreamVolume::set_mute ( bool  mute  ) 
void Gst::StreamVolume::set_volume ( Gst::StreamVolumeFormat  format,
double  val 
)

Friends And Related Function Documentation

Glib::RefPtr< Gst::StreamVolume > wrap ( GstStreamVolume *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

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

Generated on Sun Dec 27 18:38:51 2009 for gstreamermm by  doxygen 1.6.1