pulp::audio::SampleStreamWindow Class Reference

#include <sample_stream_window.hpp>

Public Member Functions
	SampleStreamWindow ()=default
bool	prepare (const SampleStreamWindowConfig &config)
void	release () noexcept
void	reset_when_quiescent () noexcept
bool	prepared () const noexcept
std::uint32_t	channels () const noexcept
std::uint32_t	page_count () const noexcept
std::uint64_t	page_frames () const noexcept
SampleStreamPageState	page_state (std::uint32_t page_index) const noexcept
bool	begin_fill_page (std::uint32_t page_index, std::uint64_t completed_audio_generation=0) noexcept
float *	writable_channel_data (std::uint32_t page_index, std::uint32_t channel) noexcept
bool	copy_to_filling_page (std::uint32_t page_index, BufferView< const float > source, std::uint64_t frames) noexcept
bool	copy_to_filling_page (std::uint32_t page_index, BufferView< float > source, std::uint64_t frames) noexcept
bool	publish_page (std::uint32_t page_index, const SampleStreamPageDescriptor &descriptor) noexcept
bool	cancel_fill_page (std::uint32_t page_index) noexcept
bool	retire_page (std::uint32_t page_index, std::uint64_t retire_after_audio_generation) noexcept
SampleStreamPageView	ready_page_for_frame (std::uint64_t stream_generation, std::uint64_t source_frame) const noexcept
const float *	ready_channel_data (const SampleStreamPageView &view, std::uint32_t channel) const noexcept
SampleStreamWindowReadResult	read_frames (BufferView< float > destination, const SampleStreamWindowReadRequest &request) noexcept
SampleStreamWindowStats	stats () const noexcept

Constructor & Destructor Documentation

SampleStreamWindow()

pulp::audio::SampleStreamWindow::SampleStreamWindow ( )

default

Member Function Documentation

begin_fill_page()

bool pulp::audio::SampleStreamWindow::begin_fill_page ( std::uint32_t page_index, std::uint64_t completed_audio_generation = 0 )

noexcept

cancel_fill_page()

bool pulp::audio::SampleStreamWindow::cancel_fill_page ( std::uint32_t page_index )

noexcept

channels()

std::uint32_t pulp::audio::SampleStreamWindow::channels ( ) const

inlinenoexcept

copy_to_filling_page() [1/2]

bool pulp::audio::SampleStreamWindow::copy_to_filling_page ( std::uint32_t page_index, BufferView< const float > source, std::uint64_t frames )

noexcept

copy_to_filling_page() [2/2]

bool pulp::audio::SampleStreamWindow::copy_to_filling_page ( std::uint32_t page_index, BufferView< float > source, std::uint64_t frames )

noexcept

page_count()

std::uint32_t pulp::audio::SampleStreamWindow::page_count ( ) const

inlinenoexcept

page_frames()

std::uint64_t pulp::audio::SampleStreamWindow::page_frames ( ) const

inlinenoexcept

page_state()

SampleStreamPageState pulp::audio::SampleStreamWindow::page_state ( std::uint32_t page_index ) const

noexcept

prepare()

bool pulp::audio::SampleStreamWindow::prepare

(

const SampleStreamWindowConfig &

config

)

prepared()

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

inlinenoexcept

publish_page()

bool pulp::audio::SampleStreamWindow::publish_page ( std::uint32_t page_index, const SampleStreamPageDescriptor & descriptor )

noexcept

read_frames()

SampleStreamWindowReadResult pulp::audio::SampleStreamWindow::read_frames ( BufferView< float > destination, const SampleStreamWindowReadRequest & request )

noexcept

ready_channel_data()

const float * pulp::audio::SampleStreamWindow::ready_channel_data ( const SampleStreamPageView & view, std::uint32_t channel ) const

noexcept

ready_page_for_frame()

SampleStreamPageView pulp::audio::SampleStreamWindow::ready_page_for_frame ( std::uint64_t stream_generation, std::uint64_t source_frame ) const

noexcept

release()

void pulp::audio::SampleStreamWindow::release ( )

noexcept

reset_when_quiescent()

void pulp::audio::SampleStreamWindow::reset_when_quiescent ( )

noexcept

retire_page()

bool pulp::audio::SampleStreamWindow::retire_page ( std::uint32_t page_index, std::uint64_t retire_after_audio_generation )

noexcept

stats()

SampleStreamWindowStats pulp::audio::SampleStreamWindow::stats ( ) const

noexcept

writable_channel_data()

float * pulp::audio::SampleStreamWindow::writable_channel_data ( std::uint32_t page_index, std::uint32_t channel )

noexcept

---

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

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