pulp::audio::PublishedSampleStore Class Reference

#include <published_sample_store.hpp>

Public Member Functions
	PublishedSampleStore ()=default
bool	prepare (const PublishedSampleStoreConfig &config)
void	release () noexcept
bool	prepared () const noexcept
std::uint32_t	slot_count () const noexcept
std::uint32_t	max_channels () const noexcept
std::uint64_t	max_frames_per_slot () const noexcept
bool	load_mono (const float *data, int num_samples, double sample_rate, std::uint64_t audio_safe_generation=0)
bool	load_interleaved_stereo (const float *interleaved, int num_frames, double sample_rate, std::uint64_t audio_safe_generation=0)
bool	publish (BufferView< const float > source, std::uint64_t frames, double sample_rate, std::uint64_t audio_safe_generation=0)
bool	has_sample () const noexcept
int	sample_length () const noexcept
PublishedSampleView	read_published_view () const noexcept
bool	slot_view_valid (const PublishedSampleView &view) const noexcept
const float *	channel_data (const PublishedSampleView &view, std::uint32_t channel) const noexcept
bool	populate_channel_ptrs (const PublishedSampleView &view, const float **channel_ptrs, std::size_t channel_capacity) const noexcept

Constructor & Destructor Documentation

PublishedSampleStore()

pulp::audio::PublishedSampleStore::PublishedSampleStore ( )

default

Member Function Documentation

channel_data()

const float * pulp::audio::PublishedSampleStore::channel_data ( const PublishedSampleView & view, std::uint32_t channel ) const

inlinenoexcept

has_sample()

bool pulp::audio::PublishedSampleStore::has_sample ( ) const

inlinenoexcept

load_interleaved_stereo()

bool pulp::audio::PublishedSampleStore::load_interleaved_stereo	(	const float *	interleaved,
		int	num_frames,
		double	sample_rate,
		std::uint64_t	audio_safe_generation = 0 )

load_mono()

bool pulp::audio::PublishedSampleStore::load_mono	(	const float *	data,
		int	num_samples,
		double	sample_rate,
		std::uint64_t	audio_safe_generation = 0 )

max_channels()

std::uint32_t pulp::audio::PublishedSampleStore::max_channels ( ) const

inlinenoexcept

max_frames_per_slot()

std::uint64_t pulp::audio::PublishedSampleStore::max_frames_per_slot ( ) const

inlinenoexcept

populate_channel_ptrs()

bool pulp::audio::PublishedSampleStore::populate_channel_ptrs ( const PublishedSampleView & view, const float ** channel_ptrs, std::size_t channel_capacity ) const

noexcept

prepare()

bool pulp::audio::PublishedSampleStore::prepare

(

const PublishedSampleStoreConfig &

config

)

prepared()

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

inlinenoexcept

publish()

bool pulp::audio::PublishedSampleStore::publish	(	BufferView< const float >	source,
		std::uint64_t	frames,
		double	sample_rate,
		std::uint64_t	audio_safe_generation = 0 )

read_published_view()

PublishedSampleView pulp::audio::PublishedSampleStore::read_published_view ( ) const

inlinenoexcept

release()

void pulp::audio::PublishedSampleStore::release ( )

noexcept

sample_length()

int pulp::audio::PublishedSampleStore::sample_length ( ) const

noexcept

slot_count()

std::uint32_t pulp::audio::PublishedSampleStore::slot_count ( ) const

inlinenoexcept

slot_view_valid()

bool pulp::audio::PublishedSampleStore::slot_view_valid ( const PublishedSampleView & view ) const

inlinenoexcept

---

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

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