Struct portmidi::InputPort

pub struct InputPort<'a> { /* private fields */ }

Represents the input port of a PortMidi device.

Implementations

impl<'a> InputPort<'a>

pub fn new( context: &'a PortMidi, device: DeviceInfo, buffer_size: usize ) -> Result<InputPort<'_>>

Construct a new InputPort for the given device and buffer size.

If the device is not an input device an Error::NotAnInputDevice is returned.

pub fn read_n(&self, cnt: usize) -> Result<Option<Vec<MidiEvent>>>

Returns a Vec<MidiEvent> with at most cnt elements. If there was no Midi event available, None is returned. If PortMidi fails to read from the device an Error::PortMidi(_) is returned.

pub fn read(&mut self) -> Result<Option<MidiEvent>>

Reads a single MidiEvent if one is avaible.

A Result of None means no event was available.

pub fn poll(&self) -> Result<bool>

Polls for available Midi events. Returns true if there are events available, otherwise false is returned. If the polling fails an Error::PortMidi(_) is returned.

pub fn device(&self) -> DeviceInfo

Returns the DeviceInfo of the Midi device that owns this port.

Trait Implementations

impl<'a> Drop for InputPort<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Send for InputPort<'a>