Struct SynthSourceImpl 

pub struct SynthSourceImpl<Generator>
where
    Generator: SynthSourceGenerator + Send + Sync,
{ /* private fields */ }

A synth source which runs an externally defined synth source generator.

Implementations

impl<Generator> SynthSourceImpl<Generator>

where Generator: SynthSourceGenerator + Send + Sync,

pub fn new( generator_name: &str, generator: Generator, options: SynthPlaybackOptions, sample_rate: u32, ) -> Result<Self, Error>

Trait Implementations

impl<Generator> Source for SynthSourceImpl<Generator>

where Generator: SynthSourceGenerator + Send + Sync + 'static,

fn channel_count(&self) -> usize

The source’s output channel count.

fn sample_rate(&self) -> u32

The source’s output sample rate.

fn is_exhausted(&self) -> bool

Returns whether the source finished playback. Exhausted sources should only return 0 on write and may be removed from a source render graph.

fn weight(&self) -> usize

Return a rough estimate of the processing costs for this source in range ~1..10, where 1 means pretty lightweight and 10 very CPU intensive. This is used in parallel processing to distribute work loads evenly before or without actual CPU measurements.

fn write(&mut self, output: &mut [f32], time: &SourceTime) -> usize

Write at most output.len() samples into the interleaved output The given SourceTime parameter specifies which absolute time this buffer in the final output stream refers to. It can be used to schedule and apply real-time events. Returns the number of written samples (not frames).

fn into_box(self) -> Box<dyn Source>

where Self: Sized,

Convert the Source impl into a boxed dyn Source.

impl<Generator> SynthSource for SynthSourceImpl<Generator>

where Generator: SynthSourceGenerator + Send + Sync + 'static,

fn synth_name(&self) -> String

Name of the synth for debugging or display purposes.

fn playback_id(&self) -> PlaybackId

A unique ID, which can be used to identify sources in PlaybackStatusEvents

fn playback_options(&self) -> &SynthPlaybackOptions

The synth source’s playback options

fn playback_message_queue(&self) -> Arc<ArrayQueue<SynthPlaybackMessage>>

Message queue to control this sources’s playback.

fn playback_status_sender(&self) -> Option<SyncSender<PlaybackStatusEvent>>

Channel to receive file playback status from the synth.

fn set_playback_status_sender( &mut self, sender: Option<SyncSender<PlaybackStatusEvent>>, )

fn playback_status_context(&self) -> Option<PlaybackStatusContext>

Optional context passed along with the playback status.

fn set_playback_status_context( &mut self, context: Option<PlaybackStatusContext>, )