Skip to content

Commit

Permalink
Added detailed usage description of the getInputReport and getFeature…
Browse files Browse the repository at this point in the history
…Report
  • Loading branch information
JoergAtGithub committed Feb 21, 2021
1 parent 706ea80 commit 953da3f
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/controllers/hid/hidcontroller.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,22 @@ class HidController final : public Controller {
void sendBytesReport(QByteArray data, unsigned int reportID);
void sendFeatureReport(const QList<int>& dataList, unsigned int reportID);

// getInputReport receives an input report on request.
// This can be used on startup, to initialize the knob positions in Mixxx
// to the physical position of the hardware knobs on the controller.
// The returned data structure for the input reports is the same,
// as in the polling functionality (incl. ReportID in first byte).
// The returned list can be used, to call the incomingData
// function of the common-hid-packet-parser.
QList<int> getInputReport(unsigned int reportID);

// getFeatureReport receives a feature reports on request.
// HID doesn't support polling feature reports, therefore this is the
// only method to get this information.
// Usually single bits in a feature report need to be set without
// changeing the other bits. The returned list matches the input
// format of sendFeatureReport, this allows it to read, modify
// and send it back to the controller.
QList<int> getFeatureReport(unsigned int reportID);

const mixxx::hid::DeviceInfo m_deviceInfo;
Expand Down

0 comments on commit 953da3f

Please sign in to comment.