GstController.TimedValueControlSource

g GObject.InitiallyUnowned GObject.InitiallyUnowned Gst.Object Gst.Object GObject.InitiallyUnowned->Gst.Object GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gst.ControlSource Gst.ControlSource GstController.TimedValueControlSource GstController.TimedValueControlSource Gst.ControlSource->GstController.TimedValueControlSource Gst.Object->Gst.ControlSource

Subclasses:

GstController.InterpolationControlSource, GstController.TriggerControlSource

Methods

Inherited:

Gst.ControlSource (2), Gst.Object (27), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

find_control_point_iter (timestamp)

get_all ()

get_count ()

set (timestamp, value)

set_from_list (timedvalues)

unset (timestamp)

unset_all ()

Virtual Methods

Inherited:

Gst.Object (1), GObject.Object (7)

Properties

Inherited:

Gst.Object (2)

Signals

Inherited:

Gst.Object (1), GObject.Object (1)

Name

Short Description

value-added

Emitted right after the new value has been added to self

value-changed

Emitted right after the new value has been set on timed_signals

value-removed

Emitted when timed_value is removed from self

Fields

Inherited:

Gst.Object (1), GObject.Object (1)

Name

Type

Access

Description

lock

GLib.Mutex

r

nvalues

int

r

parent

Gst.ControlSource

r

valid_cache

bool

r

values

GLib.Sequence

r

Class Details

class GstController.TimedValueControlSource(**kwargs)
Bases:

Gst.ControlSource

Abstract:

Yes

Structure:

GstController.TimedValueControlSourceClass

Base class for Gst.ControlSource that use time-stamped values.

When overriding bind, chain up first to give this bind implementation a chance to setup things.

All functions are MT-safe.

find_control_point_iter(timestamp)
Parameters:

timestamp (int) – the search key

Returns:

the found GLib.SequenceIter or None

Return type:

GLib.SequenceIter or None

Find last value before given timestamp in control point list. If all values in the control point list come after the given timestamp or no values exist, None is returned.

For use in control source implementations.

get_all()
Returns:

a copy of the list, or None if the property isn’t handled by the controller

Return type:

[Gst.TimedValue]

Returns a read-only copy of the list of Gst.TimedValue for the given property. Free the list after done with it.

get_count()
Returns:

the number of control points that are set.

Return type:

int

Get the number of control points that are set.

set(timestamp, value)
Parameters:
  • timestamp (int) – the time the control-change is scheduled for

  • value (float) – the control-value

Returns:

False if the values couldn’t be set, True otherwise.

Return type:

bool

Set the value of given controller-handled property at a certain time.

set_from_list(timedvalues)
Parameters:

timedvalues ([Gst.TimedValue]) – a list with Gst.TimedValue items

Returns:

False if the values couldn’t be set, True otherwise.

Return type:

bool

Sets multiple timed values at once.

unset(timestamp)
Parameters:

timestamp (int) – the time the control-change should be removed from

Returns:

False if the value couldn’t be unset (i.e. not found, True otherwise.

Return type:

bool

Used to remove the value of given controller-handled property at a certain time.

unset_all()

Used to remove all time-stamped values of given controller-handled property

Signal Details

GstController.TimedValueControlSource.signals.value_added(timed_value_control_source, timed_value)
Signal Name:

value-added

Flags:

RUN_FIRST

Parameters:

Emitted right after the new value has been added to self

New in version 1.6.

GstController.TimedValueControlSource.signals.value_changed(timed_value_control_source, timed_value)
Signal Name:

value-changed

Flags:

RUN_FIRST

Parameters:

Emitted right after the new value has been set on timed_signals

New in version 1.6.

GstController.TimedValueControlSource.signals.value_removed(timed_value_control_source, timed_value)
Signal Name:

value-removed

Flags:

RUN_FIRST

Parameters:

Emitted when timed_value is removed from self

New in version 1.6.