Skip to content

Commit

Permalink
Documentation update to clarify that isPortOpen() does not report sta…
Browse files Browse the repository at this point in the history
…tus of virtual ports.
  • Loading branch information
garyscavone committed Aug 31, 2017
1 parent b0cacfd commit 81e31f9
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions RtMidi.h
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,10 @@ class RtMidi
virtual void closePort( void ) = 0;

//! Returns true if a port is open and false if not.
/*!
Note that this only applies to connections made with the openPort()
function, not to virtual ports.
*/
virtual bool isPortOpen( void ) const = 0;

//! Set an error callback function to be invoked when an error has occured.
Expand Down Expand Up @@ -282,6 +286,10 @@ class RtMidiIn : public RtMidi
void closePort( void );

//! Returns true if a port is open and false if not.
/*!
Note that this only applies to connections made with the openPort()
function, not to virtual ports.
*/
virtual bool isPortOpen() const;

//! Return the number of available MIDI input ports.
Expand Down Expand Up @@ -380,6 +388,10 @@ class RtMidiOut : public RtMidi
void closePort( void );

//! Returns true if a port is open and false if not.
/*!
Note that this only applies to connections made with the openPort()
function, not to virtual ports.
*/
virtual bool isPortOpen() const;

//! Create a virtual output port, with optional name, to allow software connections (OS X, JACK and ALSA only).
Expand Down

0 comments on commit 81e31f9

Please sign in to comment.