gstcolorbalance

gstcolorbalance — Interface for adjusting color balance settings

Synopsis


#include <gst/interfaces/color.h>


            GstColorBalance;
enum        GstColorBalanceType;
const GList* gst_color_balance_list_channels
                                            (GstColorBalance *balance);
gint        gst_color_balance_get_value     (GstColorBalance *balance,
                                             GstColorBalanceChannel *channel);
void        gst_color_balance_set_value     (GstColorBalance *balance,
                                             GstColorBalanceChannel *channel,
                                             gint value);
void        gst_color_balance_value_changed (GstColorBalance *balance,
                                             GstColorBalanceChannel *channel,
                                             gint value);

Object Hierarchy


  GInterface
   +----GstColorBalance

Prerequisites

GstColorBalance requires GstImplementsInterface and GstElement.

Description

This interface is implemented by elements which can perform some color balance operation on video frames they process. For example, modifying the brightness, contrast, hue or saturation.

Example elements are 'xvimagesink' and 'colorbalance'

Details

GstColorBalance

typedef struct _GstColorBalance GstColorBalance;


enum GstColorBalanceType

typedef enum
{
  GST_COLOR_BALANCE_HARDWARE,
  GST_COLOR_BALANCE_SOFTWARE
} GstColorBalanceType;

An enumeration indicating whether an element implements color balancing operations in software or in dedicated hardware. In general, dedicated hardware implementations (such as those provided by xvimagesink) are preferred.

GST_COLOR_BALANCE_HARDWARE Color balance is implemented with dedicated hardware.
GST_COLOR_BALANCE_SOFTWARE Color balance is implemented via software processing.

gst_color_balance_list_channels ()

const GList* gst_color_balance_list_channels
                                            (GstColorBalance *balance);

Retrieve a list of the available channels.

balance : A GstColorBalance instance
Returns : A GList containing pointers to GstColorBalanceChannel objects. The list is owned by the GstColorBalance instance and must not be freed.

gst_color_balance_get_value ()

gint        gst_color_balance_get_value     (GstColorBalance *balance,
                                             GstColorBalanceChannel *channel);

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

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

balance : A GstColorBalance instance
channel : A GstColorBalanceChannel instance
Returns : The current value of the channel.

gst_color_balance_set_value ()

void        gst_color_balance_set_value     (GstColorBalance *balance,
                                             GstColorBalanceChannel *channel,
                                             gint value);

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

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

balance : A GstColorBalance instance
channel : A GstColorBalanceChannel instance
value : The new value for the channel.

gst_color_balance_value_changed ()

void        gst_color_balance_value_changed (GstColorBalance *balance,
                                             GstColorBalanceChannel *channel,
                                             gint value);

A helper function called by implementations of the GstColorBalance interface. It fires the GstColorBalance::value-changed signal on the instance, and the GstColorBalanceChannel::value-changed signal on the channel object.

balance : A GstColorBalance instance
channel : A GstColorBalanceChannel whose value has changed
value : The new value of the channel