dspark::OfflineEnergyAnalyzer< T >::Analysis Class Reference

Read-only source-bound energy map; owns bins, never source samples. More...

#include <OfflineEnergyAnalyzer.h>

Public Member Functions
	Analysis ()=default
	Analysis (Analysis &&) noexcept=default
Analysis &	operator= (Analysis &&) noexcept=default
bool	isValid () const noexcept
	False for a failed or moved-from result.
std::span< const Bin >	bins () const noexcept
	Returned spans remain valid only while this analysis is alive and unmoved.
OfflineAudioSpec	getSpec () const noexcept
OfflineFingerprint	fingerprint () const noexcept
std::int64_t	binFrames () const noexcept
double	samplePeak () const noexcept
std::size_t	retainedBytes () const noexcept

Friends
class	OfflineEnergyAnalyzer

Detailed Description

template<FloatType T>
class dspark::OfflineEnergyAnalyzer< T >::Analysis

Read-only source-bound energy map; owns bins, never source samples.

Definition at line 56 of file OfflineEnergyAnalyzer.h.

Constructor & Destructor Documentation

Analysis() [1/2]

template<FloatType T>

dspark::OfflineEnergyAnalyzer< T >::Analysis::Analysis ( )

default

Analysis() [2/2]

template<FloatType T>

dspark::OfflineEnergyAnalyzer< T >::Analysis::Analysis ( Analysis &&  )

defaultnoexcept

Member Function Documentation

binFrames()

template<FloatType T>

std::int64_t dspark::OfflineEnergyAnalyzer< T >::Analysis::binFrames ( ) const

inlinenoexcept

Definition at line 81 of file OfflineEnergyAnalyzer.h.

bins()

template<FloatType T>

std::span< const Bin > dspark::OfflineEnergyAnalyzer< T >::Analysis::bins ( ) const

inlinenoexcept

Returned spans remain valid only while this analysis is alive and unmoved.

Definition at line 69 of file OfflineEnergyAnalyzer.h.

fingerprint()

template<FloatType T>

OfflineFingerprint dspark::OfflineEnergyAnalyzer< T >::Analysis::fingerprint ( ) const

inlinenoexcept

Definition at line 77 of file OfflineEnergyAnalyzer.h.

getSpec()

template<FloatType T>

OfflineAudioSpec dspark::OfflineEnergyAnalyzer< T >::Analysis::getSpec ( ) const

inlinenoexcept

Definition at line 73 of file OfflineEnergyAnalyzer.h.

isValid()

template<FloatType T>

bool dspark::OfflineEnergyAnalyzer< T >::Analysis::isValid ( ) const

inlinenoexcept

False for a failed or moved-from result.

Definition at line 63 of file OfflineEnergyAnalyzer.h.

operator=()

template<FloatType T>

Analysis & dspark::OfflineEnergyAnalyzer< T >::Analysis::operator= ( Analysis &&  )

defaultnoexcept

retainedBytes()

template<FloatType T>

std::size_t dspark::OfflineEnergyAnalyzer< T >::Analysis::retainedBytes ( ) const

inlinenoexcept

Definition at line 89 of file OfflineEnergyAnalyzer.h.

samplePeak()

template<FloatType T>

double dspark::OfflineEnergyAnalyzer< T >::Analysis::samplePeak ( ) const

inlinenoexcept

Definition at line 85 of file OfflineEnergyAnalyzer.h.

Friends And Related Symbol Documentation

OfflineEnergyAnalyzer

template<FloatType T>

friend class OfflineEnergyAnalyzer

friend

Definition at line 95 of file OfflineEnergyAnalyzer.h.

---

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

• OfflineEnergyAnalyzer.h