MIDIPort: open() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The open()
method of the MIDIPort
interface makes the MIDI device connected to this MIDIPort
explicitly available.
If the port is successfully opened a new MIDIConnectionEvent
is queued to the MIDIPort
statechange
and MIDIAccess
statechange
events, and the MIDIPort.connection
property is changed to "open"
.
If the port is already open when this method is called, then the promise will resolve successfully.
Syntax
open()
Parameters
None.
Return value
A Promise
which resolves once access to the port has been successfully obtained.
Exceptions
InvalidAccessError
DOMException
-
The promise is rejected with this error if the port is unavailable and cannot be opened.
Examples
The following example shows an output port being opened.
const output = midiAccess.outputs.get(portID);
output.open(); // opens the port
Specifications
Specification |
---|
Web MIDI API # dom-midiport-open |
Browser compatibility
BCD tables only load in the browser