juce::AudioProcessLoadMeasurer Class Reference

Maintains an ongoing measurement of the proportion of time which is being spent inside an audio callback. More...

#include "juce_AudioProcessLoadMeasurer.h"

Classes
struct	ScopedTimer
	This class measures the time between its construction and destruction and adds it to an AudioProcessLoadMeasurer. More...

Public Member Functions
	~AudioProcessLoadMeasurer ()
	Destructor.
void	reset ()
	Resets the state.
void	reset (double sampleRate, int blockSize)
	Resets the counter, in preparation for use with the given sample rate and block size.
double	getLoadAsProportion () const
	Returns the current load as a proportion 0 to 1.0.
double	getLoadAsPercentage () const
	Returns the current load as a percentage 0 to 100.0.
int	getXRunCount () const
	Returns the number of over- (or under-) runs recorded since the state was reset.
void	registerBlockRenderTime (double millisecondsTaken)
	Can be called manually to add the time of a callback to the stats.
void	registerRenderTime (double millisecondsTaken, int numSamples)
	Can be called manually to add the time of a callback to the stats.

Detailed Description

Maintains an ongoing measurement of the proportion of time which is being spent inside an audio callback.

@tags{Audio}

Definition at line 33 of file juce_AudioProcessLoadMeasurer.h.

Member Function Documentation

getLoadAsPercentage()

double juce::AudioProcessLoadMeasurer::getLoadAsPercentage

(

)

const

Returns the current load as a percentage 0 to 100.0.

Definition at line 77 of file juce_AudioProcessLoadMeasurer.cpp.

getLoadAsProportion()

double juce::AudioProcessLoadMeasurer::getLoadAsProportion

(

)

const

Returns the current load as a proportion 0 to 1.0.

Definition at line 76 of file juce_AudioProcessLoadMeasurer.cpp.

getXRunCount()

int juce::AudioProcessLoadMeasurer::getXRunCount

(

)

const

Returns the number of over- (or under-) runs recorded since the state was reset.

Definition at line 79 of file juce_AudioProcessLoadMeasurer.cpp.

registerBlockRenderTime()

void juce::AudioProcessLoadMeasurer::registerBlockRenderTime

(

double

millisecondsTaken

)

Can be called manually to add the time of a callback to the stats.

Normally you probably would never call this - it's simpler and more robust to use a ScopedTimer to measure the time using an RAII pattern.

Definition at line 45 of file juce_AudioProcessLoadMeasurer.cpp.

registerRenderTime()

void juce::AudioProcessLoadMeasurer::registerRenderTime	(	double	millisecondsTaken,
		int	numSamples
	)

Can be called manually to add the time of a callback to the stats.

Normally you probably would never call this - it's simpler and more robust to use a ScopedTimer to measure the time using an RAII pattern.

Definition at line 53 of file juce_AudioProcessLoadMeasurer.cpp.

reset() [1/2]

void juce::AudioProcessLoadMeasurer::reset

(

)

Resets the state.

Definition at line 29 of file juce_AudioProcessLoadMeasurer.cpp.

reset() [2/2]

void juce::AudioProcessLoadMeasurer::reset	(	double	sampleRate,
		int	blockSize
	)

Resets the counter, in preparation for use with the given sample rate and block size.

Definition at line 34 of file juce_AudioProcessLoadMeasurer.cpp.

---

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

• juce_audio_basics/buffers/juce_AudioProcessLoadMeasurer.h
• juce_audio_basics/buffers/juce_AudioProcessLoadMeasurer.cpp