Struct PulseMidiClip 

pub struct PulseMidiClip { /* private fields */ }

A MIDI file arranged as a reusable song or phrase clip.

Implementations

impl PulseMidiClip

pub fn new(mixer: Mixer) -> Self

Creates a MIDI clip from a tunes mixer.

pub fn with_start_at(self, start_at: f32) -> PulseResult<Self>

Sets the clip start offset relative to its song or phrase placement.

pub fn with_track(self, track_name: impl Into<String>) -> Self

Sets the track-name prefix used when imported MIDI tracks are merged.

pub fn with_volume(self, volume: f32) -> PulseResult<Self>

Sets a clip-level volume multiplier for all imported MIDI tracks.

pub fn with_pan(self, pan: f32) -> PulseResult<Self>

Overrides the stereo pan for all imported MIDI tracks.

pub fn with_repeat_times(self, repeat_times: usize) -> PulseResult<Self>

Sets how many total times the imported MIDI material should play inside this clip.

pub fn with_effect(self, effect: PulseEffect) -> Self

Appends one track-level effect to every imported MIDI track.

pub fn start_at(&self) -> f32

Returns the clip start offset.

pub fn track_name(&self) -> Option<&str>

Returns the explicit track-name prefix, if one was set.

pub fn volume(&self) -> f32

Returns the clip-level volume multiplier.

pub fn pan(&self) -> Option<f32>

Returns the pan override, if one was set.

pub fn repeat_times(&self) -> usize

Returns how many total times the imported MIDI material plays inside this clip.

pub fn effects(&self) -> &[PulseEffect]

Returns track-level effects in insertion order.

pub fn duration(&self) -> PulseResult<f32>

Returns clip duration including start offset and internal repeats.

Trait Implementations

impl Clone for PulseMidiClip

fn clone(&self) -> PulseMidiClip

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulseMidiClip

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

Formats the value using the given formatter.

impl PartialEq for PulseMidiClip

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UserData for PulseMidiClip

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.