VCV Rack API v2
Loading...
Searching...
No Matches
rack::midi::InputQueue Struct Reference

An Input port that stores incoming MIDI messages and releases them when ready according to their frame timestamp. More...

#include <midi.hpp>

Inheritance diagram for rack::midi::InputQueue:
[legend]
Collaboration diagram for rack::midi::InputQueue:
[legend]

Public Member Functions

 InputQueue ()
 
 ~InputQueue ()
 
void onMessage (const Message &message) override
 
bool tryPop (Message *messageOut, int64_t maxFrame)
 Pops and returns the next message (by setting messageOut) if its frame timestamp is maxFrame or earlier.
 
size_t size ()
 
- Public Member Functions inherited from rack::midi::Input
 Input ()
 
 ~Input ()
 
void reset ()
 
std::vector< int > getDeviceIds () override
 
int getDefaultDeviceId () override
 
void setDeviceId (int deviceId) override
 
std::string getDeviceName (int deviceId) override
 
std::vector< int > getChannels () override
 
- Public Member Functions inherited from rack::midi::Port
 Port ()
 
virtual ~Port ()
 
DrivergetDriver ()
 
int getDriverId ()
 
void setDriverId (int driverId)
 
DevicegetDevice ()
 
int getDeviceId ()
 
int getChannel ()
 
void setChannel (int channel)
 
std::string getChannelName (int channel)
 
json_t * toJson ()
 
void fromJson (json_t *rootJ)
 

Public Attributes

Internal * internal
 
- Public Attributes inherited from rack::midi::Input
InputDeviceinputDevice = NULL
 Not owned.
 
- Public Attributes inherited from rack::midi::Port
int channel = -1
 For MIDI output, the channel to automatically set outbound messages.
 
int driverId = -1
 
int deviceId = -1
 
Driverdriver = NULL
 Not owned.
 
Devicedevice = NULL
 
Contextcontext
 

Detailed Description

An Input port that stores incoming MIDI messages and releases them when ready according to their frame timestamp.

Constructor & Destructor Documentation

◆ InputQueue()

rack::midi::InputQueue::InputQueue ( )

◆ ~InputQueue()

rack::midi::InputQueue::~InputQueue ( )

Member Function Documentation

◆ onMessage()

void rack::midi::InputQueue::onMessage ( const Message & message)
overridevirtual

Reimplemented from rack::midi::Input.

◆ tryPop()

bool rack::midi::InputQueue::tryPop ( Message * messageOut,
int64_t maxFrame )

Pops and returns the next message (by setting messageOut) if its frame timestamp is maxFrame or earlier.

Returns whether a message was returned.

◆ size()

size_t rack::midi::InputQueue::size ( )

Member Data Documentation

◆ internal

Internal* rack::midi::InputQueue::internal

The documentation for this struct was generated from the following file: