pulp::playback::AutomationRecorder Class Reference

Captures parameter gestures into a bounded point stream. More...

#include <automation_recording.hpp>

Public Member Functions
bool	prepare (std::size_t maximum_points)
void	release () noexcept
bool	begin (AutomationRecordMode mode) noexcept
AutomationRecordError	record (timebase::TickPosition position, float value, bool gesture_active) noexcept
bool	end () noexcept
std::span< const RecordedAutomationPoint >	points () const noexcept
bool	recording () const noexcept
std::uint64_t	dropped_points () const noexcept
runtime::Result< MaterializedAutomationCurve, AutomationCurveMaterializationError >	materialize_curve (std::uint64_t next_item_id) const

Static Public Attributes
static constexpr audio::RtSafetyClass	record_rt_safety_class

Detailed Description

Captures parameter gestures into a bounded point stream.

All state-mutating methods belong to one callback thread; materialize_curve() runs only after end() while that owner is quiescent.

Member Function Documentation

begin()

bool pulp::playback::AutomationRecorder::begin ( AutomationRecordMode mode )

noexcept

dropped_points()

std::uint64_t pulp::playback::AutomationRecorder::dropped_points ( ) const

noexcept

end()

bool pulp::playback::AutomationRecorder::end ( )

noexcept

materialize_curve()

runtime::Result< MaterializedAutomationCurve, AutomationCurveMaterializationError > pulp::playback::AutomationRecorder::materialize_curve

(

std::uint64_t

next_item_id

)

const

points()

std::span< const RecordedAutomationPoint > pulp::playback::AutomationRecorder::points ( ) const

noexcept

prepare()

bool pulp::playback::AutomationRecorder::prepare

(

std::size_t

maximum_points

)

record()

AutomationRecordError pulp::playback::AutomationRecorder::record ( timebase::TickPosition position, float value, bool gesture_active )

noexcept

recording()

bool pulp::playback::AutomationRecorder::recording ( ) const

noexcept

release()

void pulp::playback::AutomationRecorder::release ( )

noexcept

Member Data Documentation

record_rt_safety_class

audio::RtSafetyClass pulp::playback::AutomationRecorder::record_rt_safety_class

staticconstexpr

Initial value:

=
        audio::RtSafetyClass::AudioCallbackSafeAfterPrepare

---

The documentation for this class was generated from the following file:

• /home/runner/work/pulp/pulp/core/playback/include/pulp/playback/automation_recording.hpp