Interface ColorBalance

All Superinterfaces:
Proxy
All Known Implementing Classes:
ColorBalance.ColorBalance$Impl
@Generated("org.javagi.JavaGI") public interface ColorBalance extends Proxy

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'

  • Method Details

    • getType

      static @Nullable Type getType()
      Get the GType of the ColorBalance class.
      Returns:
      the GType

    • getBalanceType

      default ColorBalanceType getBalanceType()
      Get the GstColorBalanceType of this implementation.
      Returns:
      A the GstColorBalanceType.

    • getValue

      default int getValue(ColorBalanceChannel 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.

      Parameters:
      channel - A GstColorBalanceChannel instance
      Returns:
      The current value of the channel.

    • listChannels

      default List<ColorBalanceChannel> listChannels()
      Retrieve a list of the available channels.
      Returns:
      A GList containing pointers to GstColorBalanceChannel objects. The list is owned by the GstColorBalance instance and must not be freed.

    • setValue

      default void setValue(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 GstColorBalanceChannel.min_value and GstColorBalanceChannel.max_value members of the GstColorBalanceChannel object.

      Parameters:
      channel - A GstColorBalanceChannel instance
      value - The new value for the channel.

    • valueChanged

      default void valueChanged(ColorBalanceChannel channel, int 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.
      Parameters:
      channel - A GstColorBalanceChannel whose value has changed
      value - The new value of the channel

    • onValueChanged

      default SignalConnection<ColorBalance.ValueChangedCallback> onValueChanged(ColorBalance.ValueChangedCallback handler)
      Fired when the value of the indicated channel has changed.
      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitValueChanged

      default void emitValueChanged(@Nullable ColorBalanceChannel channel, int value)
      Emits the "value-changed" signal. See onValueChanged(ColorBalance.ValueChangedCallback).