GstBase::ColorBalance Class Reference

GstBase::ColorBalance — Interface for adjusting color balance settings. More...

#include <colorbalance.h>

List of all members.

Public Member Functions

virtual ~ColorBalance ()
GstColorBalance* gobj ()
 Provides access to the underlying C GObject.
const GstColorBalance* gobj () const
 Provides access to the underlying C GObject.
Glib::ListHandle< Glib::RefPtr
<ColorBalanceChannel >> 
list_channels ()
 Retrieve a list of the available channels.
int get_value (const Glib::RefPtr<ColorBalanceChannel>& channel)
 Retrieve the current value of the indicated channel, between min_value and max_value.
void set_value (const Glib::RefPtr<ColorBalanceChannel>& channel, int value)
 Sets the current value of the channel to the passed value, which must be between min_value and max_value.
void value_changed (const Glib::RefPtr<ColorBalanceChannel>& channel, int value)
 A helper function called by implementations of the GstColorBalance interface.
Glib::SignalProxy2< void,
const Glib::RefPtr
<ColorBalanceChannel >&, int> 
signal_value_changed ()
 Fired when the value of the indicated channel has changed.

Static Public Member Functions

static void add_interface (GType gtype_implementer)

Protected Member Functions

virtual void on_value_changed (const Glib::RefPtr<ColorBalanceChannel>& channel, int value)

Related Functions

(Note that these are not member functions.)

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


Detailed Description

GstBase::ColorBalance — Interface for adjusting color balance settings.

Constructor& Destructor Documentation

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


Member Function Documentation

static void GstBase::ColorBalance::add_interface ( GType  gtype_implementer  )  [static]

int GstBase::ColorBalance::get_value ( const Glib::RefPtr<ColorBalanceChannel>&  channel  ) 

Retrieve the current value of the indicated channel, between min_value and max_value.

See Also: The Gst::ColorBalanceChannel::min_value and Gst::ColorBalanceChannel::max_value members of the Gst::ColorBalanceChannel object.

Parameters:
channel A Gst::ColorBalanceChannel instance.
Returns:
The current value of the channel.

const GstColorBalance* GstBase::ColorBalance::gobj (  )  const [inline]

Provides access to the underlying C GObject.

GstColorBalance* GstBase::ColorBalance::gobj (  )  [inline]

Provides access to the underlying C GObject.

Glib::ListHandle<Glib::RefPtr<ColorBalanceChannel>> GstBase::ColorBalance::list_channels (  ) 

Retrieve a list of the available channels.

Returns:
A GList containing pointers to Gst::ColorBalanceChannel objects. The list is owned by the Gst::ColorBalance instance and must not be freed.

virtual void GstBase::ColorBalance::on_value_changed ( const Glib::RefPtr<ColorBalanceChannel>&  channel,
int  value 
) [protected, virtual]

void GstBase::ColorBalance::set_value ( const Glib::RefPtr<ColorBalanceChannel>&  channel,
int  value 
)

Sets the current value of the channel to the passed value, which must be between min_value and max_value.

See Also: The Gst::ColorBalanceChannel::min_value and Gst::ColorBalanceChannel::max_value members of the Gst::ColorBalanceChannel object.

Parameters:
channel A Gst::ColorBalanceChannel instance.
value The new value for the channel.

Glib::SignalProxy2<void,const Glib::RefPtr<ColorBalanceChannel>&,int> GstBase::ColorBalance::signal_value_changed (  ) 

Fired when the value of the indicated channel has changed.

Prototype:
void on_my_value_changed(const Glib::RefPtr<ColorBalanceChannel>& channel, int value)

void GstBase::ColorBalance::value_changed ( const Glib::RefPtr<ColorBalanceChannel>&  channel,
int  value 
)

A helper function called by implementations of the GstColorBalance interface.

It fires the Gst::ColorBalance::value-changed signal on the instance, and the Gst::ColorBalanceChannel::value-changed signal on the channel object.

Parameters:
channel A Gst::ColorBalanceChannel whose value has changed.
value The new value of the channel.


Friends And Related Function Documentation

Glib::RefPtr<GstBase::ColorBalance> wrap ( GstColorBalance *  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