Jump to content

MMProgRef - Real-Time MIDI Functions

From EDM2
Revision as of 00:45, 9 June 2025 by Martini (talk | contribs) (Created page with "{{MMProgRef}} The real-time MIDI subsystem (RTMIDI) provides support for handling real-time MIDI operations for applications. The following table describes the RTMIDI functions that are currently supported. All of the RTMIDI functions have MIDIERR_INTERNAL_SYSTEM and MIDIERR_INVALID_PARAMETER as possible returns (with the exception of TimerGetPointer and TimerSleep, which have TIMERERR_INTERNAL_SYSTEM and TIMERERR_INVALID_PARAMETER as possible returns). If MIDIERR_INTER...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Reprint Courtesy of International Business Machines Corporation, © International Business Machines Corporation

Multimedia Programming Reference
  1. Introduction
  2. What's New...
  3. MCI Functions
  4. High-Level Macro Service Functions
  5. Subsystem Messages
  6. Notification Messages
  7. MCI Command Messages
  8. String Commands
  9. Memory Playlist Commands
  10. Graphic Button Control
  11. Secondary Window Functions
  12. MMIO Functions
  13. MMIO Messages
  14. CODEC Messages
  15. DIVE Functions
  16. Real-Time MIDI Functions
  17. SPI Functions
  18. Data Stream State Table
  19. SMH Messages
  20. DDCMD Messages
  21. VSD Commands
  22. SHD Messages
  23. SHC Messages
  24. Data Types
  25. Types of MIDI Messages
  26. Multimedia Specification Overview
  27. Resource Interchange File Format
  28. Multimedia File Formats
  29. RIFF Compound Files and Elements - Sharing and Access
  30. Return Codes
  31. Notices
  32. Glossary

The real-time MIDI subsystem (RTMIDI) provides support for handling real-time MIDI operations for applications. The following table describes the RTMIDI functions that are currently supported.

All of the RTMIDI functions have MIDIERR_INTERNAL_SYSTEM and MIDIERR_INVALID_PARAMETER as possible returns (with the exception of TimerGetPointer and TimerSleep, which have TIMERERR_INTERNAL_SYSTEM and TIMERERR_INVALID_PARAMETER as possible returns). If MIDIERR_INTERNAL_SYSTEM or TIMERERR_INTERNAL_SYSTEM is returned, the application should shut down immediately and not attempt any further calls to RTMIDI.

Function Description
MIDIAddLink Creates a link from the source instance to a target instance.
MIDICreateInstance Creates an instance.
MIDIDeleteInstance Deletes an instance.
MIDIDisableInstance Disables an instance from sending or receiving messages.
MIDIEnableInstance Enables an instance for sending or receiving messages.
MIDIQueryClassList Returns the names of all valid current classes.
MIDIQueryInstanceList Returns a sequential list of relevant instance data for all instances in the chain.
MIDIQueryInstanceName Returns the name of an instance.
MIDIQueryNumClasses Returns the number of classes currently registered.
MIDIQueryNumInstances Returns the number of instances.
MIDIQueryVersion Returns the current RTMIDI device driver and DLL version numbers.
MIDIRemoveLink Removes a link from the source instance to a target instance.
MIDISendMessages Sends a block of MIDI messages.
MIDISetup Provides a generic setup for an application.
MIDITimer Starts or stops the RTMIDI timer.
TimerGetPointer Obtains a pointer to the RTMIDI timer.
TimerSleep Sets the duration in milliseconds to trigger an event originated by the application.