Metronome Class Reference

Metronome settings. More...

#include <src/gui/dsp/metronome.h>

Public Types
enum class	Type { None , Emphasis , Normal }
	The type of the metronome sound. More...
using	SampleBufferPtr = std::shared_ptr<zrythm::utils::audio::AudioBuffer>

Public Member Functions
	Metronome (AudioEngine &engine)
	Initializes the Metronome by loading the samples into memory.
void	set_volume (float volume)
void	queue_events (AudioEngine *engine, const nframes_t loffset, const nframes_t nframes)
	Queues metronome events (if any) within the current processing cycle.

Data Fields
fs::path	emphasis_path_
	Absolute path of the "emphasis" sample.
fs::path	normal_path_
	Absolute path of the "normal" sample.
SampleBufferPtr	emphasis_
	The emphasis sample.
SampleBufferPtr	normal_
	The normal sample.
float	volume_

Detailed Description

Metronome settings.

Definition at line 33 of file metronome.h.

Member Typedef Documentation

SampleBufferPtr

using Metronome::SampleBufferPtr = std::shared_ptr<zrythm::utils::audio::AudioBuffer>

Definition at line 55 of file metronome.h.

Member Enumeration Documentation

Type

enum class Metronome::Type

strong

The type of the metronome sound.

Definition at line 39 of file metronome.h.

Constructor & Destructor Documentation

Metronome()

Metronome::Metronome

(

AudioEngine &

engine

)

Initializes the Metronome by loading the samples into memory.

Exceptions

ZrythmException

if loading fails.

Member Function Documentation

queue_events()

void Metronome::queue_events	(	AudioEngine *	engine,
		const nframes_t	loffset,
		const nframes_t	nframes )

Queues metronome events (if any) within the current processing cycle.

Parameters

loffset

Local offset in this cycle.

Field Documentation

emphasis_

SampleBufferPtr Metronome::emphasis_

The emphasis sample.

Definition at line 77 of file metronome.h.

emphasis_path_

fs::path Metronome::emphasis_path_

Absolute path of the "emphasis" sample.

Definition at line 71 of file metronome.h.

normal_

SampleBufferPtr Metronome::normal_

The normal sample.

Definition at line 80 of file metronome.h.

normal_path_

fs::path Metronome::normal_path_

Absolute path of the "normal" sample.

Definition at line 74 of file metronome.h.

volume_

float Metronome::volume_

Definition at line 82 of file metronome.h.

---

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

• src/gui/dsp/metronome.h