Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::audio::LoopPlaybackCursor Class Reference

Allocation-free loop traversal state independent of sample storage. More...

#include <loop_playback_cursor.hpp>

Public Member Functions

bool set_region (const LoopRegion &region, std::uint64_t source_frames) noexcept
void reset () noexcept
void start () noexcept
void stop () noexcept
void set_playback_rate (double rate) noexcept
 Sets the finite nonzero source-frame step value.
void set_playback_mode (LoopPlaybackMode mode) noexcept
bool active () const noexcept
double position () const noexcept
double step () const noexcept
const LoopRegion & region () const noexcept
LoopFrameReadPlan frame_read_plan () const noexcept
LoopPlaybackAdvanceResult advance () noexcept

Detailed Description

Allocation-free loop traversal state independent of sample storage.

Member Function Documentation

◆ active()

bool pulp::audio::LoopPlaybackCursor::active ( ) const
inlinenoexcept

◆ advance()

LoopPlaybackAdvanceResult pulp::audio::LoopPlaybackCursor::advance ( )
noexcept

◆ frame_read_plan()

LoopFrameReadPlan pulp::audio::LoopPlaybackCursor::frame_read_plan ( ) const
noexcept

◆ position()

double pulp::audio::LoopPlaybackCursor::position ( ) const
inlinenoexcept

◆ region()

const LoopRegion & pulp::audio::LoopPlaybackCursor::region ( ) const
inlinenoexcept

◆ reset()

void pulp::audio::LoopPlaybackCursor::reset ( )
noexcept

◆ set_playback_mode()

void pulp::audio::LoopPlaybackCursor::set_playback_mode ( LoopPlaybackMode mode)
inlinenoexcept

◆ set_playback_rate()

void pulp::audio::LoopPlaybackCursor::set_playback_rate ( double rate)
noexcept

Sets the finite nonzero source-frame step value.

Negative values are retained for compatibility with LoopRenderer's historical signed-rate API; new traversal policies should normally encode direction in LoopRegion.

◆ set_region()

bool pulp::audio::LoopPlaybackCursor::set_region ( const LoopRegion & region,
std::uint64_t source_frames )
noexcept

◆ start()

void pulp::audio::LoopPlaybackCursor::start ( )
noexcept

◆ step()

double pulp::audio::LoopPlaybackCursor::step ( ) const
noexcept

◆ stop()

void pulp::audio::LoopPlaybackCursor::stop ( )
inlinenoexcept

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