TracktionEngine
Loading...
Searching...
No Matches
Public Attributes | List of all members
engine::AudioAnalysisOptions Struct Reference

Options for the standard analyseAudioFile() convenience overload. More...

#include <tracktion_AudioFileAnalyser.h>

Public Attributes

bool levels = true
 Peak, true peak, RMS, LUFS, clipping, silence ratio.
 
bool spectrum = true
 Banded energies, spectral centroid/rolloff, low/mid/high balance.
 
bool envelope = true
 Downsampled peak/RMS dynamics curve over time.
 
bool stereo = true
 Phase correlation, stereo width/balance, mono compatibility.
 
bool spectrogram = true
 Per-band level over time, with band stats and buildup detection.
 
int envelopePoints = 100
 Number of points in the dynamics curve.
 
int spectrogramSlices = 60
 Maximum number of time slices in the spectrogram.
 
bool spectrogramThirdOctave = false
 31 third-octave bands instead of the 8 broad mixing bands
 
std::function< bool()> shouldAbort
 Checked between blocks while the file streams; return true to abort the analysis, which then fails rather than returning partial results.
 

Detailed Description

Options for the standard analyseAudioFile() convenience overload.

Member Data Documentation

◆ levels

bool engine::AudioAnalysisOptions::levels = true

Peak, true peak, RMS, LUFS, clipping, silence ratio.

◆ spectrum

bool engine::AudioAnalysisOptions::spectrum = true

Banded energies, spectral centroid/rolloff, low/mid/high balance.

◆ envelope

bool engine::AudioAnalysisOptions::envelope = true

Downsampled peak/RMS dynamics curve over time.

◆ stereo

bool engine::AudioAnalysisOptions::stereo = true

Phase correlation, stereo width/balance, mono compatibility.

◆ spectrogram

bool engine::AudioAnalysisOptions::spectrogram = true

Per-band level over time, with band stats and buildup detection.

◆ envelopePoints

int engine::AudioAnalysisOptions::envelopePoints = 100

Number of points in the dynamics curve.

◆ spectrogramSlices

int engine::AudioAnalysisOptions::spectrogramSlices = 60

Maximum number of time slices in the spectrogram.

◆ spectrogramThirdOctave

bool engine::AudioAnalysisOptions::spectrogramThirdOctave = false

31 third-octave bands instead of the 8 broad mixing bands

◆ shouldAbort

std::function<bool()> engine::AudioAnalysisOptions::shouldAbort

Checked between blocks while the file streams; return true to abort the analysis, which then fails rather than returning partial results.

Lets a caller's thread shut down promptly mid-way through a long file.


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