pulp::audio::SampleStarvationEnvelope Class Reference

#include <sample_starvation_envelope.hpp>

Public Member Functions
bool	prepare (const SampleStarvationEnvelopeConfig &config) noexcept
void	reset () noexcept
void	restart_audio () noexcept
	Restarts the audio gain at unity after an explicit timeline jump while preserving the prepared configuration and lifetime telemetry.
bool	prepared () const noexcept
SampleStarvationMode	mode () const noexcept
std::uint32_t	fade_out_frames () const noexcept
void	begin_predicted_fade (std::uint32_t available_valid_frames) noexcept
float	next_valid_gain () noexcept
void	mark_starved (std::uint64_t frames) noexcept
void	begin_recovery () noexcept
void	cancel_predicted_fade () noexcept
SampleStarvationEnvelopeStats	stats () const noexcept

Member Function Documentation

begin_predicted_fade()

void pulp::audio::SampleStarvationEnvelope::begin_predicted_fade ( std::uint32_t available_valid_frames )

inlinenoexcept

begin_recovery()

void pulp::audio::SampleStarvationEnvelope::begin_recovery ( )

inlinenoexcept

cancel_predicted_fade()

void pulp::audio::SampleStarvationEnvelope::cancel_predicted_fade ( )

inlinenoexcept

fade_out_frames()

std::uint32_t pulp::audio::SampleStarvationEnvelope::fade_out_frames ( ) const

inlinenoexcept

mark_starved()

void pulp::audio::SampleStarvationEnvelope::mark_starved ( std::uint64_t frames )

inlinenoexcept

mode()

SampleStarvationMode pulp::audio::SampleStarvationEnvelope::mode ( ) const

inlinenoexcept

next_valid_gain()

float pulp::audio::SampleStarvationEnvelope::next_valid_gain ( )

inlinenoexcept

prepare()

bool pulp::audio::SampleStarvationEnvelope::prepare ( const SampleStarvationEnvelopeConfig & config )

inlinenoexcept

prepared()

bool pulp::audio::SampleStarvationEnvelope::prepared ( ) const

inlinenoexcept

reset()

void pulp::audio::SampleStarvationEnvelope::reset ( )

inlinenoexcept

restart_audio()

void pulp::audio::SampleStarvationEnvelope::restart_audio ( )

inlinenoexcept

Restarts the audio gain at unity after an explicit timeline jump while preserving the prepared configuration and lifetime telemetry.

stats()

SampleStarvationEnvelopeStats pulp::audio::SampleStarvationEnvelope::stats ( ) const

inlinenoexcept

---

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

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