Navigator: метод requestMIDIAccess()

Метод requestMIDIAccess() интерфейса Navigator возвращает Promise, представляющий запрос на доступ к MIDI-устройствам на системе пользователя. Этот метод является частью API Web MIDI, который предоставляет средства для доступа, перечисления и управления MIDI-устройствами.

Этот метод может запросить у пользователя разрешение на доступ к MIDI-устройствам, доступным на его системе, или может использовать ранее установленное предпочтение для предоставления или отказа в доступе. Если разрешение предоставлено, то Promise разрешается, и возвращается объект MIDIAccess.

MIDIOptions Необязательно

Объект Object, представляющий параметры для передачи в метод. Эти параметры:

sysex

Значение Boolean, которое, если установлено в значение true, позволяет отправлять и получать сообщения системного исключения (sysex). Значение по умолчанию — false.

software

Значение Boolean, которое, если установлено в значение true, позволяет системе использовать любые установленные программные синтезаторы. Значение по умолчанию — false.

Promise, который разрешается с объектом MIDIAccess.

AbortError DOMException

Выбрасывается, если документ или страница закрываются из-за перехода пользователя.

InvalidStateError DOMException

Выбрасывается, если основная система генерирует какие-либо ошибки.

NotSupportedError DOMException

Выбрасывается, если функция или параметры не поддерживаются системой.

SecurityError DOMException

Выбрасывается, если пользователь или система запрещают применению создание объекта MIDIAccess с запрошенными параметрами, или если документ не имеет разрешения на использование функции (например, из-за Политики разрешений, или если пользователь ранее отказал в запросе на разрешение).

Доступ к API ограничен следующими условиями:

• Метод должен вызываться в безопасном контексте.
• Доступ может быть ограничен midi HTTP Политики разрешений.
• Пользователь должен явно предоставить разрешение на использование API через механизм, специфичный для браузера, или ранее предоставил разрешение. Обратите внимание, что если доступ запрещен политикой разрешений, он не может быть предоставлен разрешением пользователя.

Статус разрешения можно запросить с помощью метода API разрешений navigator.permissions.query(), передавая описатель разрешения с параметром midi и (необязательным) свойством sysex:

navigator.permissions.query({ name: "midi", sysex: true }).then((result) => {
  if (result.state === "granted") {
    // Access granted.
  } else if (result.state === "prompt") {
    // Using API will prompt for permission
  }
  // Permission was denied by user prompt or permission policy
});

В следующем примере метод Navigator.requestMIDIAccess() возвращает объект MIDIAccess, который предоставляет доступ к информации о входных и выходных портах MIDI.

navigator.requestMIDIAccess().then((access) => {
  // Get lists of available MIDI controllers
  const inputs = access.inputs.values();
  const outputs = access.outputs.values();
  // …
});

• Web MIDI API
• Введение в Web MIDI