pulp::audio::PlanarAudioRingBuffer Class Reference

#include <planar_audio_ring_buffer.hpp>

Public Member Functions
	PlanarAudioRingBuffer ()=default
bool	prepare (std::uint32_t num_channels, std::uint64_t usable_capacity_frames)
void	release () noexcept
void	reset () noexcept
std::uint32_t	num_channels () const noexcept
std::uint64_t	capacity_frames () const noexcept
std::uint64_t	available_frames () const noexcept
std::uint64_t	free_frames () const noexcept
PlanarAudioRingBufferStats	stats () const noexcept
std::uint64_t	write (BufferView< const float > source, std::uint64_t frames) noexcept
std::uint64_t	write (BufferView< float > source, std::uint64_t frames) noexcept
bool	read (BufferView< float > destination, std::uint64_t frames) noexcept
std::uint64_t	drain (std::uint64_t max_frames) noexcept

Constructor & Destructor Documentation

PlanarAudioRingBuffer()

pulp::audio::PlanarAudioRingBuffer::PlanarAudioRingBuffer ( )

default

Member Function Documentation

available_frames()

std::uint64_t pulp::audio::PlanarAudioRingBuffer::available_frames ( ) const

noexcept

capacity_frames()

std::uint64_t pulp::audio::PlanarAudioRingBuffer::capacity_frames ( ) const

inlinenoexcept

drain()

std::uint64_t pulp::audio::PlanarAudioRingBuffer::drain ( std::uint64_t max_frames )

noexcept

free_frames()

std::uint64_t pulp::audio::PlanarAudioRingBuffer::free_frames ( ) const

noexcept

num_channels()

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

inlinenoexcept

prepare()

bool pulp::audio::PlanarAudioRingBuffer::prepare	(	std::uint32_t	num_channels,
		std::uint64_t	usable_capacity_frames )

read()

bool pulp::audio::PlanarAudioRingBuffer::read ( BufferView< float > destination, std::uint64_t frames )

noexcept

release()

void pulp::audio::PlanarAudioRingBuffer::release ( )

noexcept

reset()

void pulp::audio::PlanarAudioRingBuffer::reset ( )

noexcept

stats()

PlanarAudioRingBufferStats pulp::audio::PlanarAudioRingBuffer::stats ( ) const

noexcept

write() [1/2]

std::uint64_t pulp::audio::PlanarAudioRingBuffer::write ( BufferView< const float > source, std::uint64_t frames )

inlinenoexcept

write() [2/2]

std::uint64_t pulp::audio::PlanarAudioRingBuffer::write ( BufferView< float > source, std::uint64_t frames )

inlinenoexcept

---

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

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