Class MIDIPort

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

The MIDIPort interface of the 'Web MIDI API' represents a MIDI input or output port.

[Value("MIDIPort")]
public class MIDIPort : EventTarget

Inheritance

object

EventTarget

MIDIPort

Derived

MIDIInput

MIDIOutput

Inherited Members

EventTarget.AddEventListener(string, Action, Union26)

EventTarget.AddEventListener(string, Action<MouseEvent>, Union26)

EventTarget.AddEventListener(string, Action<Event>, Union26)

EventTarget.RemoveEventListener(string, Action, Union27)

EventTarget.AddEventListener(string, EventListener, Union26)

EventTarget.RemoveEventListener(string, EventListener, Union27)

EventTarget.DispatchEvent(Event)

EventTarget.When(string, ObservableEventListenerOptions)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

A MIDIPort instance is created when a new MIDI device is connected. Therefore it has no constructor.

See also on MDN

Constructors

MIDIPort()

public MIDIPort()

Properties

Connection

The connection read-only property of the MIDIPort interface returns the connection state of the port.

[Value("connection")]
public MIDIPortConnectionState Connection { get; }

Property Value

MIDIPortConnectionState

Returns a string containing the connection state of the port, one of:

Remarks

See also on MDN

Id

The id read-only property of the MIDIPort interface returns the unique ID of the port.

[Value("id")]
public string Id { get; }

Property Value

string

A string containing an ID for the port.

Remarks

See also on MDN

Manufacturer

The manufacturer read-only property of the MIDIPort interface returns the manufacturer of the port.

[Value("manufacturer")]
public string? Manufacturer { get; }

Property Value

string

A string containing the manufacturer of the port.

Remarks

See also on MDN

Name

The name read-only property of the MIDIPort interface returns the system name of the port.

[Value("name")]
public string? Name { get; }

Property Value

string

A string containing the system name of the port.

Remarks

See also on MDN

Onstatechange

[Value("onstatechange")]
public EventHandlerNonNull Onstatechange { get; set; }

Property Value

EventHandlerNonNull

State

The state read-only property of the MIDIPort interface returns the state of the port.

[Value("state")]
public MIDIPortDeviceState State { get; }

Property Value

MIDIPortDeviceState

A string containing the state of the port, one of:

Remarks

See also on MDN

Type

The type read-only property of the MIDIPort interface returns the type of the port, indicating whether this is an input or output MIDI port.

[Value("type")]
public MIDIPortType Type { get; }

Property Value

MIDIPortType

A string containing the type of the port, one of:

Remarks

See also on MDN

Version

The version read-only property of the MIDIPort interface returns the version of the port.

[Value("version")]
public string? Version { get; }

Property Value

string

A string containing the version of the port.

Remarks

See also on MDN

Methods

Close()

The close() method of the MIDIPort interface makes the access to the MIDI device connected to this MIDIPort unavailable.

[Value("close")]
public Task<MIDIPort> Close()

Returns

Task<MIDIPort>

Returns a Promise which resolves once the port has been closed.

Remarks

If the port is successfully closed a new MIDIConnectionEvent is queued to the MIDIPort MIDIPort.Statechange and MIDIAccess MIDIAccess.Statechange events, and the Connection property is changed to "closed".

See also on MDN

Open()

The open() method of the MIDIPort interface makes the MIDI device connected to this MIDIPort explicitly available.

[Value("open")]
public Task<MIDIPort> Open()

Returns

Task<MIDIPort>

A Promise which resolves once access to the port has been successfully obtained.

Remarks

If the port is successfully opened a new MIDIConnectionEvent is queued to the MIDIPort MIDIPort.Statechange and MIDIAccess MIDIAccess.Statechange events, and the Connection property is changed to "open".

If the port is already open when this method is called, then the promise will resolve successfully.

See also on MDN