pulp::audio::RealtimeSampleRecorder Class Reference

#include <realtime_sample_recorder.hpp>

Public Member Functions
	RealtimeSampleRecorder ()=default
bool	prepare (const RealtimeSampleRecorderConfig &config)
void	release () noexcept
void	reset () noexcept
bool	enqueue_command (const RealtimeSampleRecorderCommand &command) noexcept
bool	pop_event (RealtimeSampleRecorderEvent &event) noexcept
void	process (BufferView< const float > source, std::uint32_t frames, bool transport_jumped=false) noexcept
void	process (BufferView< float > source, std::uint32_t frames, bool transport_jumped=false) noexcept
bool	materialize_snapshot_quiescent (const RollingAudioCaptureBuffer &capture, const RollingAudioCaptureSnapshot &snapshot) noexcept
bool	materialize_held_snapshot (const RollingAudioCaptureBuffer &capture, const RollingAudioCaptureSnapshot &snapshot) noexcept
bool	materialize_snapshot (const RollingAudioCaptureBuffer &capture, const RollingAudioCaptureSnapshot &snapshot) noexcept
bool	consume_completed_recording () noexcept
RealtimeSampleRecorderState	state () const noexcept
std::uint32_t	num_channels () const noexcept
std::uint64_t	max_frames () const noexcept
std::uint64_t	frames_recorded () const noexcept
double	sample_rate () const noexcept
const float *	channel_data (std::uint32_t channel) const noexcept
RealtimeSampleRecorderStats	stats () const noexcept

Static Public Attributes
static constexpr std::size_t	kCommandQueueCapacity = 32
static constexpr std::size_t	kEventQueueCapacity = 64

Constructor & Destructor Documentation

RealtimeSampleRecorder()

pulp::audio::RealtimeSampleRecorder::RealtimeSampleRecorder ( )

default

Member Function Documentation

channel_data()

const float * pulp::audio::RealtimeSampleRecorder::channel_data ( std::uint32_t channel ) const

noexcept

consume_completed_recording()

bool pulp::audio::RealtimeSampleRecorder::consume_completed_recording ( )

noexcept

enqueue_command()

bool pulp::audio::RealtimeSampleRecorder::enqueue_command ( const RealtimeSampleRecorderCommand & command )

noexcept

frames_recorded()

std::uint64_t pulp::audio::RealtimeSampleRecorder::frames_recorded ( ) const

noexcept

materialize_held_snapshot()

bool pulp::audio::RealtimeSampleRecorder::materialize_held_snapshot ( const RollingAudioCaptureBuffer & capture, const RollingAudioCaptureSnapshot & snapshot )

noexcept

materialize_snapshot()

bool pulp::audio::RealtimeSampleRecorder::materialize_snapshot ( const RollingAudioCaptureBuffer & capture, const RollingAudioCaptureSnapshot & snapshot )

noexcept

materialize_snapshot_quiescent()

bool pulp::audio::RealtimeSampleRecorder::materialize_snapshot_quiescent ( const RollingAudioCaptureBuffer & capture, const RollingAudioCaptureSnapshot & snapshot )

noexcept

max_frames()

std::uint64_t pulp::audio::RealtimeSampleRecorder::max_frames ( ) const

inlinenoexcept

num_channels()

std::uint32_t pulp::audio::RealtimeSampleRecorder::num_channels ( ) const

inlinenoexcept

pop_event()

bool pulp::audio::RealtimeSampleRecorder::pop_event ( RealtimeSampleRecorderEvent & event )

noexcept

prepare()

bool pulp::audio::RealtimeSampleRecorder::prepare

(

const RealtimeSampleRecorderConfig &

config

)

process() [1/2]

void pulp::audio::RealtimeSampleRecorder::process ( BufferView< const float > source, std::uint32_t frames, bool transport_jumped = false )

noexcept

process() [2/2]

void pulp::audio::RealtimeSampleRecorder::process ( BufferView< float > source, std::uint32_t frames, bool transport_jumped = false )

noexcept

release()

void pulp::audio::RealtimeSampleRecorder::release ( )

noexcept

reset()

void pulp::audio::RealtimeSampleRecorder::reset ( )

noexcept

sample_rate()

double pulp::audio::RealtimeSampleRecorder::sample_rate ( ) const

inlinenoexcept

state()

RealtimeSampleRecorderState pulp::audio::RealtimeSampleRecorder::state ( ) const

noexcept

stats()

RealtimeSampleRecorderStats pulp::audio::RealtimeSampleRecorder::stats ( ) const

noexcept

Member Data Documentation

kCommandQueueCapacity

std::size_t pulp::audio::RealtimeSampleRecorder::kCommandQueueCapacity = 32

staticconstexpr

kEventQueueCapacity

std::size_t pulp::audio::RealtimeSampleRecorder::kEventQueueCapacity = 64

staticconstexpr

---

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

• /home/runner/work/pulp/pulp/core/audio/include/pulp/audio/realtime_sample_recorder.hpp