Skip to main content

ParameterNumberMessage

Struct ParameterNumberMessage 

Source
pub struct ParameterNumberMessage {
    pub channel: MidiChannel,
    pub kind: ParameterNumberKind,
    pub parameter: u16,
    pub value: f32,
    pub is_increment: bool,
    pub is_decrement: bool,
}
Expand description

A complete RPN or NRPN message with its 14-bit value.

This represents a fully-decoded RPN/NRPN sequence after the RpnTracker has assembled all the CC messages.

§Example

use beamer_core::{RpnTracker, ControlChange, cc, rpn};

let mut tracker = RpnTracker::new();

// Simulate receiving CC sequence for Pitch Bend Sensitivity = 12 semitones
tracker.process_cc(&ControlChange { channel: 0, controller: cc::RPN_MSB, value: 0.0 });
tracker.process_cc(&ControlChange { channel: 0, controller: cc::RPN_LSB, value: 0.0 });
let msg = tracker.process_cc(&ControlChange { channel: 0, controller: cc::DATA_ENTRY_MSB, value: 12.0/127.0 });

if let Some(msg) = msg {
    assert!(msg.is_pitch_bend_sensitivity());
    let (semitones, cents) = msg.pitch_bend_sensitivity();
    assert_eq!(semitones, 12);
}

Fields§

§channel: MidiChannel

MIDI channel (0-15).

§kind: ParameterNumberKind

RPN or NRPN.

§parameter: u16

14-bit parameter number (MSB << 7 | LSB).

§value: f32

14-bit data value, normalized to 0.0-1.0.

§is_increment: bool

Whether this was a data increment (+1 to current value).

§is_decrement: bool

Whether this was a data decrement (-1 from current value).

Implementations§

Source§

impl ParameterNumberMessage

Source

pub const fn rpn(channel: MidiChannel, parameter: u16, value: f32) -> Self

Create a new RPN message.

Source

pub const fn nrpn(channel: MidiChannel, parameter: u16, value: f32) -> Self

Create a new NRPN message.

Source

pub const fn is_rpn(&self) -> bool

Check if this is an RPN.

Source

pub const fn is_nrpn(&self) -> bool

Check if this is an NRPN.

Source

pub fn is_pitch_bend_sensitivity(&self) -> bool

Check if this is the Pitch Bend Sensitivity RPN.

Source

pub fn is_null(&self) -> bool

Check if this is the RPN Null message.

Source

pub fn raw_value(&self) -> u16

Get the raw 14-bit value (0-16383).

Source

pub fn pitch_bend_sensitivity(&self) -> (u8, u8)

For Pitch Bend Sensitivity: get semitones and cents.

Returns (semitones, cents) where MSB = semitones (0-127) and LSB = cents (0-127).

Trait Implementations§

Source§

impl Clone for ParameterNumberMessage

Source§

fn clone(&self) -> ParameterNumberMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParameterNumberMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ParameterNumberMessage

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ParameterNumberMessage

Source§

impl StructuralPartialEq for ParameterNumberMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.