GstVideo.ColorBalance

Implementations:

None

Methods

	get_balance_type ()
	get_value (channel)
	list_channels ()
	set_value (channel, value)
	value_changed (channel, value)

Virtual Methods

	do_get_balance_type ()
	do_get_value (channel)
	do_list_channels ()
	do_set_value (channel, value)
	do_value_changed (channel, value)

Properties

None

Signals

Name	Short Description
value-changed	Fired when the value of the indicated channel has changed.

Fields

None

Class Details

class GstVideo.ColorBalance

Bases:

GObject.GInterface

Structure:

GstVideo.ColorBalanceInterface

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’

get_balance_type()

Returns:

A the GstVideo.ColorBalanceType.

Return type:

GstVideo.ColorBalanceType

Get the GstVideo.ColorBalanceType of this implementation.

get_value(channel)

Parameters:

channel (GstVideo.ColorBalanceChannel) – A GstVideo.ColorBalanceChannel instance

Returns:

The current value of the channel.

Return type:

int

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

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

list_channels()

Returns:

A GLib.List containing pointers to GstVideo.ColorBalanceChannel objects. The list is owned by the GstVideo.ColorBalance instance and must not be freed.

Return type:

[GstVideo.ColorBalanceChannel]

Retrieve a list of the available channels.

set_value(channel, value)

Parameters:

• channel (GstVideo.ColorBalanceChannel) – A GstVideo.ColorBalanceChannel instance

• value (int) – The new value for the channel.

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

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

value_changed(channel, value)

Parameters:

• channel (GstVideo.ColorBalanceChannel) – A GstVideo.ColorBalanceChannel whose value has changed

• value (int) – The new value of the channel

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

do_get_balance_type() virtual

Returns:

A the GstVideo.ColorBalanceType.

Return type:

GstVideo.ColorBalanceType

Get the GstVideo.ColorBalanceType of this implementation.

do_get_value(channel) virtual

Parameters:

channel (GstVideo.ColorBalanceChannel) – A GstVideo.ColorBalanceChannel instance

Returns:

The current value of the channel.

Return type:

int

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

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

do_list_channels() virtual

Returns:

A GLib.List containing pointers to GstVideo.ColorBalanceChannel objects. The list is owned by the GstVideo.ColorBalance instance and must not be freed.

Return type:

[GstVideo.ColorBalanceChannel]

Retrieve a list of the available channels.

do_set_value(channel, value) virtual

Parameters:

• channel (GstVideo.ColorBalanceChannel) – A GstVideo.ColorBalanceChannel instance

• value (int) – The new value for the channel.

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

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

do_value_changed(channel, value) virtual

Parameters:

• channel (GstVideo.ColorBalanceChannel) – A GstVideo.ColorBalanceChannel whose value has changed

• value (int) – The new value of the channel

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

Signal Details

GstVideo.ColorBalance.signals.value_changed(color_balance, channel, value)

Signal Name:

value-changed

Flags:

RUN_LAST

Parameters:

• color_balance (GstVideo.ColorBalance) – The object which received the signal

• channel (GstVideo.ColorBalanceChannel) – The GstVideo.ColorBalanceChannel

• value (int) – The new value

Fired when the value of the indicated channel has changed.