Interface

GstVideo-1.0 ▶ GstVideo ▶ ColorBalance ▶ Interface

Interface for implementing ColorBalance. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_get_balance_type(): GstVideo.ColorBalanceType;
    vfunc_get_value(channel: GstVideo.ColorBalanceChannel): number;
    vfunc_list_channels(): GstVideo.ColorBalanceChannel[];
    vfunc_set_value(channel: GstVideo.ColorBalanceChannel, value: number): void;
    vfunc_value_changed(
        channel: GstVideo.ColorBalanceChannel,
        value: number,
    ): void;
}

Hierarchy (View Summary)

Interface
- GstVideo.ColorBalance

Index

Methods

vfunc_get_balance_type vfunc_get_value vfunc_list_channels vfunc_set_value vfunc_value_changed

Methods

`Virtual`vfunc_get_balance_type

vfunc_get_balance_type(): GstVideo.ColorBalanceType
Get the GstVideo.ColorBalanceType of this implementation.

Returns GstVideo.ColorBalanceType
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9342

`Virtual`vfunc_get_value

vfunc_get_value(channel: GstVideo.ColorBalanceChannel): number
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.
Parameters
- channel: GstVideo.ColorBalanceChannel
  A GstVideo.ColorBalanceChannel instance
Returns number
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9353

`Virtual`vfunc_list_channels

vfunc_list_channels(): GstVideo.ColorBalanceChannel[]
Retrieve a list of the available channels.

Returns GstVideo.ColorBalanceChannel[]
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9358

`Virtual`vfunc_set_value

vfunc_set_value(channel: GstVideo.ColorBalanceChannel, value: number): void
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.
Parameters
- channel: GstVideo.ColorBalanceChannel
  A GstVideo.ColorBalanceChannel instance
- value: number
  The new value for the channel.
Returns void
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9370

`Virtual`vfunc_value_changed

vfunc_value_changed(channel: GstVideo.ColorBalanceChannel, value: number): void
A helper function called by implementations of the GstColorBalance interface. It fires the GstVideo.ColorBalance.SignalSignatures.value_changed | GstVideo.ColorBalance::value-changed signal on the instance, and the GstVideo.ColorBalanceChannel.SignalSignatures.value_changed | GstVideo.ColorBalanceChannel::value-changed signal on the channel object.
Parameters
- channel: GstVideo.ColorBalanceChannel
  A GstVideo.ColorBalanceChannel whose value has changed
- value: number
  The new value of the channel
Returns void
- Defined in gstvideo-1.0/gstvideo-1.0.d.ts:9380