openshot-audio  0.1.2
Public Member Functions | Static Public Member Functions | List of all members
MidiInput Class Reference

#include <juce_MidiInput.h>

Public Member Functions

 ~MidiInput ()
 
const StringgetName () const noexcept
 
void setName (const String &newName) noexcept
 
void start ()
 
void stop ()
 

Static Public Member Functions

static StringArray getDevices ()
 
static int getDefaultDeviceIndex ()
 
static MidiInputopenDevice (int deviceIndex, MidiInputCallback *callback)
 

Detailed Description

Represents a midi input device.

To create one of these, use the static getDevices() method to find out what inputs are available, and then use the openDevice() method to try to open one.

See also
MidiOutput

Constructor & Destructor Documentation

MidiInput::~MidiInput ( )

Destructor.

Member Function Documentation

int MidiInput::getDefaultDeviceIndex ( )
static

Returns the index of the default midi input device to use.

This refers to the index in the list returned by getDevices().

StringArray MidiInput::getDevices ( )
static

Returns a list of the available midi input devices.

You can open one of the devices by passing its index into the openDevice() method.

See also
getDefaultDeviceIndex, openDevice
const String& MidiInput::getName ( ) const
inlinenoexcept

Returns the name of this device.

MidiInput * MidiInput::openDevice ( int  deviceIndex,
MidiInputCallback callback 
)
static

Tries to open one of the midi input devices.

This will return a MidiInput object if it manages to open it. You can then call start() and stop() on this device, and delete it when no longer needed.

If the device can't be opened, this will return a null pointer.

Parameters
deviceIndexthe index of a device from the list returned by getDevices()
callbackthe object that will receive the midi messages from this device.
See also
MidiInputCallback, getDevices
void MidiInput::setName ( const String newName)
inlinenoexcept

Allows you to set a custom name for the device, in case you don't like the name it was given when created.

void MidiInput::start ( )

Starts the device running.

After calling this, the device will start sending midi messages to the MidiInputCallback object that was specified when the openDevice() method was called.

See also
stop
void MidiInput::stop ( )

Stops the device running.

See also
start

The documentation for this class was generated from the following files: