Struct PulseSong 

pub struct PulseSong { /* private fields */ }

A Lua-friendly song container that can be converted to tunes.

Implementations

impl PulseSong

pub fn new() -> Self

Creates an empty song at 120 BPM.

pub fn with_tempo(self, bpm: f32) -> PulseResult<Self>

Sets the song tempo in beats per minute.

pub fn add_sequence(self, sequence: PulseSequence) -> Self

Appends one sequence.

pub fn add_drum_grid(self, grid: PulseDrumGrid) -> Self

Appends one drum grid.

pub fn add_phrase(self, phrase: PulsePhrase) -> Self

Appends one reusable phrase to the song arrangement.

pub fn add_sample_clip(self, sample_clip: PulseSampleClip) -> Self

Appends one sample clip to the song.

pub fn add_midi_clip(self, midi_clip: PulseMidiClip) -> Self

Appends one imported MIDI clip to the song.

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

Appends a master effect to the song.

pub fn to_tunes_composition(&self) -> PulseResult<Composition>

Converts the wrapper DSL into a tunes composition.

pub fn to_mixer(&self) -> PulseResult<Mixer>

Converts the wrapper DSL into a tunes mixer and applies master effects.

pub fn tempo(&self) -> f32

Returns the song tempo in beats per minute.

pub fn sequences(&self) -> &[PulseSequence]

Returns all sequences.

pub fn drum_grids(&self) -> &[PulseDrumGrid]

Returns all drum grids.

pub fn phrases(&self) -> &[PulsePhrase]

Returns all phrases.

pub fn sample_clips(&self) -> &[PulseSampleClip]

Returns all sample clips.

pub fn midi_clips(&self) -> &[PulseMidiClip]

Returns all imported MIDI clips.

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

Returns master effects in insertion order.

Trait Implementations

impl Clone for PulseSong

fn clone(&self) -> PulseSong

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulseSong

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

Formats the value using the given formatter.

impl Default for PulseSong

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PulseSong

fn eq(&self, other: &PulseSong) -> 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 StructuralPartialEq for PulseSong

impl UserData for PulseSong

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.