GstBase::Volume Class Reference
[gstreamerbasemm Plugins]

GstBase::Volume — volume plugin. More...

#include <volume.h>

Inheritance diagram for GstBase::Volume:

GstBase::AudioFilter Gst::BaseTransform Gst::Element Gst::Object

List of all members.

Public Member Functions

virtual ~Volume ()
GstVolume* gobj ()
 Provides access to the underlying C GObject.
const GstVolume* gobj () const
 Provides access to the underlying C GObject.
GstVolume* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy<bool> property_mute ()
 mute channel.
Glib::PropertyProxy_ReadOnly
<bool> 
property_mute () const
 mute channel.
Glib::PropertyProxy<double> property_volume ()
 volume factor.
Glib::PropertyProxy_ReadOnly
<double> 
property_volume () const
 volume factor.

Static Public Member Functions

static Glib::RefPtr<Volumecreate ()
 Creates a new volume plugin with a unique name.
static Glib::RefPtr<Volumecreate (const Glib::ustring& name)
 Creates a new volume plugin with the given name.

Protected Member Functions

 Volume ()
 Volume (const Glib::ustring& name)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<GstBase::Volumewrap (GstVolume* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Detailed Description

GstBase::Volume — volume plugin.

Please include <gstreamerbasemm/volume.h> to use. Also, though using the underlying GObject is fine, using its C type is not guaranteed to be API stable across releases because it is not guaranteed to always remain the same.


Constructor& Destructor Documentation

virtual GstBase::Volume::~Volume (  )  [virtual]

GstBase::Volume::Volume (  )  [protected]

GstBase::Volume::Volume ( const Glib::ustring &  name  )  [protected]


Member Function Documentation

static Glib::RefPtr<Volume> GstBase::Volume::create ( const Glib::ustring &  name  )  [static]

Creates a new volume plugin with the given name.

static Glib::RefPtr<Volume> GstBase::Volume::create (  )  [static]

Creates a new volume plugin with a unique name.

const GstVolume* GstBase::Volume::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from GstBase::AudioFilter.

GstVolume* GstBase::Volume::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from GstBase::AudioFilter.

GstVolume* GstBase::Volume::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from GstBase::AudioFilter.

Glib::PropertyProxy_ReadOnly<bool> GstBase::Volume::property_mute (  )  const

mute channel.

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.

Glib::PropertyProxy<bool> GstBase::Volume::property_mute (  ) 

mute channel.

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.

Glib::PropertyProxy_ReadOnly<double> GstBase::Volume::property_volume (  )  const

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.

Glib::PropertyProxy<double> GstBase::Volume::property_volume (  ) 

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.


Friends And Related Function Documentation

Glib::RefPtr<GstBase::Volume> wrap ( GstVolume *  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 Thu Jan 15 09:33:14 2009 for gstreamermm by  doxygen 1.5.7.1