TimedValueControlSource#
Superclasses: ControlSource, Object, InitiallyUnowned, Object
Subclasses: InterpolationControlSource, TriggerControlSource
Base class for 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.
Methods#
- class TimedValueControlSource
- find_control_point_iter(timestamp: int) SequenceIter | 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,
Noneis returned.For use in control source implementations.
- Parameters:
timestamp – the search key
- get_all() list[ControlPoint]#
Returns a read-only copy of the list of
ControlPointfor the given property. Free the list after done with it.Deprecated since version 1.28: Use
list_control_points()instead.
- list_control_points() list[TimedValue] | None#
Returns an array of
TimedValuerepresenting the control points that have been set on this control source. To modify the value of a control point, usegst_timed_value_control_source_set.Added in version 1.28.
- set(timestamp: int, value: float) bool#
Set the value of given controller-handled property at a certain time.
- Parameters:
timestamp – the time the control-change is scheduled for
value – the control-value
- set_from_list(timedvalues: list[TimedValue]) bool#
Sets multiple timed values at once.
- Parameters:
timedvalues – a list with
TimedValueitems
Signals#
- class TimedValueControlSource.signals
- value_added(timed_value: ControlPoint) None#
Emitted right after the new value has been added to
selfAdded in version 1.6.
- Parameters:
timed_value – The newly added
TimedValue
- value_changed(timed_value: ControlPoint) None#
Emitted right after the new value has been set on
timed_signalsAdded in version 1.6.
- Parameters:
timed_value – The
TimedValuewhere the value changed
- value_removed(timed_value: ControlPoint) None#
Emitted when
timed_valueis removed fromselfAdded in version 1.6.
- Parameters:
timed_value – The removed
TimedValue