Enum ClockMode 

#[non_exhaustive]
pub enum ClockMode {
    Master {
        tempo_bpm: f64,
        send_transport: bool,
    },
    Slave {
        clock_input_port: String,
        timeout_ns: u64,
    },
    Passthrough {
        clock_input_port: String,
        timeout_ns: u64,
        multiply: u8,
        divide: u8,
    },
}

Selects how the RT thread generates or tracks MIDI clock.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Master

This system is the clock master: it generates clock ticks at the specified tempo and optionally sends MIDI transport messages.

Fields

tempo_bpm: f64

Initial tempo in beats per minute.

send_transport: bool

Whether to send MIDI Start/Stop/Continue messages on the output ports.

Slave

This system tracks an external MIDI clock source on the given input port, using a PLL to smooth jitter.

Fields

clock_input_port: String

Name (or substring) of the MIDI input port carrying the external clock.

timeout_ns: u64

Timeout in nanoseconds: if no clock tick is received within this window, the slave reports RtErrorCode::ClockDropout.

Passthrough

This system receives an external MIDI clock and re-emits it on all output ports, optionally multiplied or divided.

Unlike Slave, passthrough mode does not apply PLL smoothing or oscillator interpolation. It forwards clock ticks directly, making it suitable for deterministic clock distribution chains where jitter smoothing is undesirable.

Fields

clock_input_port: String

Name (or substring) of the MIDI input port carrying the external clock.

timeout_ns: u64

Timeout in nanoseconds: if no clock tick is received within this window, a RtErrorCode::ClockDropout event is emitted.

multiply: u8

Clock multiplication factor (1 = forward unchanged). For each input tick, multiply / divide output ticks are emitted.

divide: u8

Clock division factor (1 = forward unchanged). For each input tick, multiply / divide output ticks are emitted.

Trait Implementations

impl Clone for ClockMode

fn clone(&self) -> ClockMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClockMode

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

Formats the value using the given formatter.