lmms::SampleBuffer Class Reference

#include <SampleBuffer.h>

Public Types
using	value_type = SampleFrame
using	reference = SampleFrame&
using	const_reference = const SampleFrame&
using	iterator = std::vector<SampleFrame>::iterator
using	const_iterator = std::vector<SampleFrame>::const_iterator
using	difference_type = std::vector<SampleFrame>::difference_type
using	size_type = std::vector<SampleFrame>::size_type
using	reverse_iterator = std::vector<SampleFrame>::reverse_iterator
using	const_reverse_iterator = std::vector<SampleFrame>::const_reverse_iterator

Public Member Functions
	SampleBuffer ()=default
	SampleBuffer (std::vector< SampleFrame > data, int sampleRate, const QString &audioFile="")
	SampleBuffer (const SampleFrame *data, size_t numFrames, int sampleRate=Engine::audioEngine() ->outputSampleRate())
auto	toBase64 () const -> QString
auto	audioFile () const -> const QString &
auto	sampleRate () const -> sample_rate_t
auto	begin () -> iterator
auto	end () -> iterator
auto	begin () const -> const_iterator
auto	end () const -> const_iterator
auto	cbegin () const -> const_iterator
auto	cend () const -> const_iterator
auto	rbegin () -> reverse_iterator
auto	rend () -> reverse_iterator
auto	rbegin () const -> const_reverse_iterator
auto	rend () const -> const_reverse_iterator
auto	crbegin () const -> const_reverse_iterator
auto	crend () const -> const_reverse_iterator
auto	data () const -> const SampleFrame *
auto	size () const -> size_type
auto	empty () const -> bool

Static Public Member Functions
static auto	emptyBuffer () -> std::shared_ptr< const SampleBuffer >
static std::shared_ptr< const SampleBuffer >	fromFile (const QString &path)
static std::shared_ptr< const SampleBuffer >	fromBase64 (const QString &str, int sampleRate=Engine::audioEngine() ->outputSampleRate())

Private Attributes
std::vector< SampleFrame >	m_data
QString	m_audioFile
sample_rate_t	m_sampleRate = Engine::audioEngine()->outputSampleRate()

Friends
void	swap (SampleBuffer &first, SampleBuffer &second)

Member Typedef Documentation

const_iterator

using lmms::SampleBuffer::const_iterator = std::vector<SampleFrame>::const_iterator

const_reference

using lmms::SampleBuffer::const_reference = const SampleFrame&

const_reverse_iterator

using lmms::SampleBuffer::const_reverse_iterator = std::vector<SampleFrame>::const_reverse_iterator

difference_type

using lmms::SampleBuffer::difference_type = std::vector<SampleFrame>::difference_type

iterator

using lmms::SampleBuffer::iterator = std::vector<SampleFrame>::iterator

reference

using lmms::SampleBuffer::reference = SampleFrame&

reverse_iterator

using lmms::SampleBuffer::reverse_iterator = std::vector<SampleFrame>::reverse_iterator

size_type

using lmms::SampleBuffer::size_type = std::vector<SampleFrame>::size_type

value_type

using lmms::SampleBuffer::value_type = SampleFrame

Constructor & Destructor Documentation

SampleBuffer() [1/3]

lmms::SampleBuffer::SampleBuffer ( )

default

SampleBuffer() [2/3]

lmms::SampleBuffer::SampleBuffer	(	std::vector< SampleFrame >	data,
		int	sampleRate,
		const QString &	audioFile = "" )

SampleBuffer() [3/3]

lmms::SampleBuffer::SampleBuffer	(	const SampleFrame *	data,
		size_t	numFrames,
		int	sampleRate = Engine::audioEngine()->outputSampleRate() )

Member Function Documentation

audioFile()

auto lmms::SampleBuffer::audioFile ( ) const -> const QString &

inline

begin() [1/2]

auto lmms::SampleBuffer::begin ( ) -> iterator

inline

begin() [2/2]

auto lmms::SampleBuffer::begin ( ) const -> const_iterator

inline

cbegin()

auto lmms::SampleBuffer::cbegin ( ) const -> const_iterator

inline

cend()

auto lmms::SampleBuffer::cend ( ) const -> const_iterator

inline

crbegin()

auto lmms::SampleBuffer::crbegin ( ) const -> const_reverse_iterator

inline

crend()

auto lmms::SampleBuffer::crend ( ) const -> const_reverse_iterator

inline

data()

auto lmms::SampleBuffer::data ( ) const -> const SampleFrame *

inline

empty()

auto lmms::SampleBuffer::empty ( ) const -> bool

inline

emptyBuffer()

auto lmms::SampleBuffer::emptyBuffer ( ) -> std::shared_ptr< const SampleBuffer >

static

end() [1/2]

auto lmms::SampleBuffer::end ( ) -> iterator

inline

end() [2/2]

auto lmms::SampleBuffer::end ( ) const -> const_iterator

inline

fromBase64()

std::shared_ptr< const SampleBuffer > lmms::SampleBuffer::fromBase64 ( const QString & str, int sampleRate = Engine::audioEngine()->outputSampleRate() )

static

fromFile()

std::shared_ptr< const SampleBuffer > lmms::SampleBuffer::fromFile ( const QString & path )

static

rbegin() [1/2]

auto lmms::SampleBuffer::rbegin ( ) -> reverse_iterator

inline

rbegin() [2/2]

auto lmms::SampleBuffer::rbegin ( ) const -> const_reverse_iterator

inline

rend() [1/2]

auto lmms::SampleBuffer::rend ( ) -> reverse_iterator

inline

rend() [2/2]

auto lmms::SampleBuffer::rend ( ) const -> const_reverse_iterator

inline

sampleRate()

auto lmms::SampleBuffer::sampleRate ( ) const -> sample_rate_t

inline

size()

auto lmms::SampleBuffer::size ( ) const -> size_type

inline

toBase64()

QString lmms::SampleBuffer::toBase64

(

)

const -> QString

Friends And Related Symbol Documentation

swap

void swap ( SampleBuffer & first, SampleBuffer & second )

friend

Member Data Documentation

m_audioFile

QString lmms::SampleBuffer::m_audioFile

private

m_data

std::vector<SampleFrame> lmms::SampleBuffer::m_data

private

m_sampleRate

sample_rate_t lmms::SampleBuffer::m_sampleRate = Engine::audioEngine()->outputSampleRate()

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/include/SampleBuffer.h
• /home/runner/work/lmms-fork/lmms-fork/src/core/SampleBuffer.cpp