Struct RealtimeSynth

pub struct RealtimeSynth { /* private fields */ }

A realtime MIDI synthesizer using an audio device for output.

Implementations

impl RealtimeSynth

pub fn open_with_all_defaults() -> Self

Initializes a new realtime synthesizer using the default config and the default audio output.

pub fn open_with_default_output(config: XSynthRealtimeConfig) -> Self

Initializes as new realtime synthesizer using a given config and the default audio output.

See the XSynthRealtimeConfig documentation for the available options.

pub fn open( config: XSynthRealtimeConfig, device: &Device, stream_config: SupportedStreamConfig, ) -> Self

Initializes a new realtime synthesizer using a given config and a specified audio output device.

See the XSynthRealtimeConfig documentation for the available options. See the cpal crate documentation for the device and stream_config parameters.

pub fn send_event(&mut self, event: SynthEvent)

Sends a SynthEvent to the realtime synthesizer.

See the SynthEvent documentation for more information.

pub fn send_event_u32(&mut self, event: u32)

Sends a u32 event to the realtime synthesizer.

pub fn get_sender_ref(&self) -> &RealtimeEventSender

Returns a reference to the event sender of the realtime synthesizer. This can be used to clone the sender so it can be passed in threads.

See the RealtimeEventSender documentation for more information on how to use.

pub fn get_sender_mut(&mut self) -> &mut RealtimeEventSender

Returns a mutable reference the event sender of the realtime synthesizer. This can be used to modify its parameters (eg. ignore range). Please note that each clone will store its own distinct parameters.

See the RealtimeEventSender documentation for more information on how to use.

pub fn get_stats(&self) -> RealtimeSynthStatsReader

Returns the statistics reader of the realtime synthesizer.

See the RealtimeSynthStatsReader documentation for more information on how to use.

pub fn stream_params(&self) -> AudioStreamParams

Returns the stream parameters of the audio output device.

pub fn pause(&mut self) -> Result<(), PauseStreamError>

Pauses the playback of the audio output device.

pub fn resume(&mut self) -> Result<(), PlayStreamError>

Resumes the playback of the audio output device.

pub fn set_buffer(&self, render_window_ms: f64)

Changes the length of the buffer reader.

Trait Implementations

impl Drop for RealtimeSynth

fn drop(&mut self)

Executes the destructor for this type.