Struct kira::metronome::MetronomeSettings

pub struct MetronomeSettings {
    pub id: Option<MetronomeId>,
    pub tempo: Value<Tempo>,
    pub interval_events_to_emit: Vec<f64>,
    pub event_queue_capacity: usize,
}

Settings for the metronome.

Fields

id: Option<MetronomeId>

The unique identifier for the metronome.

tempo: Value<Tempo>

The tempo of the metronome (in beats per minute).

interval_events_to_emit: Vec<f64>

Which intervals (in beats) the metronome should emit events for.

For example, if this is set to vec![0.25, 0.5, 1.0], then the audio manager will receive MetronomeIntervalPassed events every quarter of a beat, half of a beat, and beat.

event_queue_capacity: usize

How many interval events can be queued at a time.

Implementations

impl MetronomeSettings

pub fn new() -> Self

Creates a new MetronomeSettings with the default settings.

pub fn id(self, id: impl Into<MetronomeId>) -> Self

Sets the ID of the metronome.

pub fn tempo(self, tempo: impl Into<Value<Tempo>>) -> Self

Sets the tempo of the metronome.

pub fn interval_events_to_emit(
    self,
    interval_events_to_emit: impl Into<Vec<f64>>
) -> Self

Sets which intervals (in beats) the metronome should emit events for.

pub fn event_queue_capacity(self, event_queue_capacity: usize) -> Self

Sets how many interval events can be queued at a time.

Trait Implementations

impl Clone for MetronomeSettings

fn clone(&self) -> MetronomeSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetronomeSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetronomeSettings

fn default() -> Self

Returns the “default value” for a type.