hs.midi

Таблица, содержащая числовое значение возможных флагов, возвращаемых параметром commandType функции обратного вызова.

Обратный вызов, который срабатывает при добавлении или удалении физического или виртуального устройства MIDI из системы.

• callbackFn - функция обратного вызова.

• Ничего

• Функция обратного вызова должна принимать 2 аргумента и ничего не возвращать:
  • devices - Таблица, содержащая имена всех физически подключенных устройств MIDI в виде строк.
  • virtualDevices - Таблица, содержащая имена всех виртуальных устройств MIDI в виде строк.
• Пример использования:

  hs.midi.deviceCallback(function(devices, virtualDevices)
       print(hs.inspect(devices))
       print(hs.inspect(virtualDevices))
  end)```
  

Возвращает таблицу текущих подключенных физических устройств MIDI.

• Нет

• Таблица, содержащая имена всех физически подключенных устройств MIDI в виде строк.

Возвращает таблицу доступных виртуальных источников MIDI. Это включает устройства, такие как контроллеры Native Instruments, которые отображаются как виртуальные конечные точки, а не физические устройства.

• Нет

• Таблица, содержащая имена всех виртуальных источников MIDI в виде строк.

Создает новый hs.midi объект.

• deviceName - Строка, содержащая имя устройства MIDI. Действительное имя устройства можно найти, проверив hs.midi.devices() и/или hs.midi.virtualSources().

• Объект hs.midi или nil в случае ошибки.

• Пример использования: hs.midi.new(hs.midi.devices()[1])

Создает новый hs.midi объект.

• virtualSource - Строка, содержащая имя виртуального источника MIDI. Действительное имя виртуального источника можно найти, проверив hs.midi.virtualSources().

• Объект hs.midi или nil в случае ошибки.

• Пример использования: hs.midi.new(hs.midi.virtualSources()[1])

Устанавливает или удаляет функцию обратного вызова для объекта hs.midi.

• callbackFn - функция, устанавливаемая в качестве функции обратного вызова для этого объекта hs.midi. Если предоставленное значение равно nil, любая существующая функция обратного вызова удаляется.

• Объект hs.midi

• Большинство MIDI-клавиатур генерируют noteOn при нажатии клавиши, затем noteOff при отпускании. Однако некоторые MIDI-клавиатуры возвращают noteOn с 0 velocity вместо noteOff, поэтому вы будете получать две команды noteOn для каждого нажатия/отпускания клавиши.

• Функция обратного вызова должна ожидать 5 аргументов и не должна ничего возвращать:

  • object - Объект hs.midi.
  • deviceName - Имя устройства в виде строки.
  • commandType - Тип сообщения MIDI, определенный как строка. См. hs.midi.commandTypes[] для списка возможных вариантов.
  • description - Описание события в виде строки. Это действительно полезно только для отладки.
  • metadata - таблица данных для команды MIDI (см. ниже).

• Таблица metadata будет возвращать следующее, в зависимости от commandType для обратного вызова:

  • noteOff - Команда отключения ноты:

    • note - Номер ноты для команды. Должен быть в диапазоне от 0 до 127.
    • velocity - Скорость для команды. Должна быть в диапазоне от 0 до 127.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • noteOn - Команда включения ноты:

    • note - Номер ноты для команды. Должен быть в диапазоне от 0 до 127.
    • velocity - Скорость для команды. Должна быть в диапазоне от 0 до 127.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • polyphonicKeyPressure - Команда полифонического послекасания:

    • note - Номер ноты для команды. Должен быть в диапазоне от 0 до 127.
    • pressure - Нажим клавиши сообщения полифонического послекасания. В диапазоне 0-127.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • controlChange - Команда изменения контроллера. Это наиболее распространенная команда, отправляемая MIDI-контроллерами:

    • controllerNumber - Номер MIDI-контроллера для команды.
    • controllerValue - Значение контроллера команды. Используются только младшие 7 бит.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • fourteenBitValue - 14-битное значение команды.
    • fourteenBitCommand - true если команда содержит 14-битные данные, иначе false.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • programChange - Команда изменения программы:

    • programNumber - Номер программы (также известный как патч). От 0 до 127.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • channelPressure - Команда послекасания канала:

    • pressure - Нажим клавиши сообщения послекасания канала. В диапазоне 0-127.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • pitchWheelChange - Команда изменения высоты тона:

    • pitchChange - 14-битное значение, указывающее на изменение высоты тона. Центр - 0x2000 (8192). Допустимый диапазон - от 0 до 16383.
    • channel - Канал для команды. Должен быть числом от 1 до 15.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemMessage - Команда системного сообщения:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemExclusive - Команда системного сообщения:

    • manufacturerID - Идентификатор производителя для команды. Используется устройствами для определения, поддерживают ли они сообщение.
    • sysexChannel - Канал сообщения. Допустимо только для универсальных эксклюзивных сообщений, всегда будет 0 для неуниверсальных сообщений.
    • sysexData - Системные эксклюзивные данные для сообщения. Для универсальных сообщений subID включены в sysexData, для неуниверсальных сообщений любая специфичная для устройства информация (например, modelID, versionID или что-либо еще, что решают включить производители) будет включена в sysexData.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemTimecodeQuarterFrame - Системная эксклюзивная (SysEx) команда:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemSongPositionPointer - Команда указателя системной позиции песни:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemSongSelect - Команда выбора системной песни:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemTuneRequest - Команда системного запроса настройки:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemTimingClock - Команда системных тактовых импульсов:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemStartSequence - Команда системных тактовых импульсов:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemContinueSequence - Команда запуска системной последовательности:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemStopSequence - Команда продолжения системной последовательности:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

  • systemKeepAlive - Системное сообщение о поддержании активности:

    • dataByte1 - Первый байт данных как целое число.
    • dataByte2 - Второй байт данных как целое число.
    • timestamp - Отметка времени для команды в виде строки.
    • data - Сырые данные MIDI в виде шестнадцатеричной строки.
    • isVirtual - true если виртуальный MIDI-источник, иначе false.

• Пример использования:

  midiDevice = hs.midi.new(hs.midi.devices()[3])
  midiDevice:callback(function(object, deviceName, commandType, description, metadata)
             print("object: " .. tostring(object))
             print("deviceName: " .. deviceName)
             print("commandType: " .. commandType)
             print("description: " .. description)
             print("metadata: " .. hs.inspect(metadata))
             end)```
  

Возвращает отображаемое имя объекта hs.midi.

• Нет

• Имя в виде строки.

Отправляет сообщение запроса идентификации устройству hs.midi. Вы можете использовать hs.midi:callback() для получения ответа systemExclusive.

• Никаких

• Никаких

• Пример использования:

midiDevice = hs.midi.new(hs.midi.devices()[3])
midiDevice:callback(function(object, deviceName, commandType, description, metadata)
                      print("object: " .. tostring(object))
                      print("deviceName: " .. deviceName)
                      print("commandType: " .. commandType)
                      print("description: " .. description)
                      print("metadata: " .. hs.inspect(metadata))
                    end)
midiDevice:identityRequest()```

Возвращает статус подключения к сети объекта hs.midi.

• Никаких

• true если подключен, в противном случае false

Возвращает true если объект hs.midi виртуальный, в противном случае false.

• Никаких

• true если виртуальный, в противном случае false

Возвращает имя производителя объекта hs.midi.

• Никаких

• Имя производителя в виде строки.

Возвращает имя модели объекта hs.midi.

• Никаких

• Имя модели в виде строки.

Возвращает имя объекта hs.midi.

• Никаких

• Имя в виде строки.

Отправляет команду объекту hs.midi.

• commandType - Тип команды для отправки в виде строки. См. hs.midi.commandTypes[].
• metadata - Таблица данных для MIDI команды (см. примечания ниже).

• true в случае успеха, в противном случае false

• Таблица metadata может принимать следующие значения в зависимости от предоставленной commandType.

  • noteOff - Команда отключения ноты:

    • note - Номер ноты для команды. Должно быть между 0 и 127. По умолчанию 0.
    • velocity - Скорость для команды. Должно быть между 0 и 127. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.

  • noteOn - Команда включения ноты:

    • note - Номер ноты для команды. Должно быть между 0 и 127. По умолчанию 0.
    • velocity - Скорость для команды. Должно быть между 0 и 127. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.

  • polyphonicKeyPressure - Команда полифонического давления клавиши:

    • note - Номер ноты для команды. Должно быть между 0 и 127. По умолчанию 0.
    • pressure - Давление клавиши сообщения полифонического давления клавиши. В диапазоне от 0 до 127. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.

  • controlChange - Команда изменения управления. Это самая распространённая команда, отправляемая MIDI контроллерами:

    • controllerNumber - Номер MIDI управления для команды. По умолчанию 0.
    • controllerValue - Значение контроллера команды. Используются только младшие 7 бит. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.
    • fourteenBitValue - 14-битовое значение команды. Должно быть между 0 и 16383. По умолчанию 0. fourteenBitCommand должно быть true.
    • fourteenBitCommand - true если команда содержит данные с 14-битным значением, иначе false. controllerValue будет проигнорировано, если это установлено на true.

  • programChange - Команда смены программы:

    • programNumber - Номер программы (также патч). От 0 до 127. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.

  • channelPressure - Команда давления канала:

    • pressure - Давление клавиши сообщения давления канала. В диапазоне от 0 до 127. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.

  • pitchWheelChange - Команда изменения высоты тона:

    • pitchChange - 14-битовое значение, указывающее на изменение высоты тона. Центр - 0x2000 (8192). Допустимый диапазон - от 0 до 16383. По умолчанию 0.
    • channel - Канал для команды. Должен быть числом от 0 до 16. По умолчанию 0, что отправляет команду на все каналы.

• Пример использования:

  midiDevice = hs.midi.new(hs.midi.devices()[1])
  midiDevice:sendCommand("noteOn", {
      ["note"] = 72,
      ["velocity"] = 50,
      ["channel"] = 0,
  })
  hs.timer.usleep(500000)
  midiDevice:sendCommand("noteOn", {
      ["note"] = 74,
      ["velocity"] = 50,
      ["channel"] = 0,
  })
  hs.timer.usleep(500000)
  midiDevice:sendCommand("noteOn", {
      ["note"] = 76,
      ["velocity"] = 50,
      ["channel"] = 0,
  })
  midiDevice:sendCommand("pitchWheelChange", {
      ["pitchChange"] = 1000,
      ["channel"] = 0,
  })
  hs.timer.usleep(100000)
  midiDevice:sendCommand("pitchWheelChange", {
      ["pitchChange"] = 2000,
      ["channel"] = 0,
  })
  hs.timer.usleep(100000)
  midiDevice:sendCommand("pitchWheelChange", {
      ["pitchChange"] = 3000,
      ["channel"] = 0,
  })```
  

Отправляет системную эксклюзивную команду объекту hs.midi.

• command - Системная эксклюзивная команда, которую вы хотите отправить, в виде строки. Пробелы в строке будут проигнорированы.

• Никаких

• Пример использования:

  midiDevice:sendSysex("f07e7f06 01f7")```
  

Устанавливает или отображает, нужно ли устройству MIDI синтезировать аудио на вашем компьютере.

• [value] - true если вы хотите синтезировать звук, в противном случае false.

• true если включено, в противном случае false