Skip to content
This repository was archived by the owner on Jan 28, 2025. It is now read-only.

Documentation #3

Open
Ulrira2k opened this issue Jun 8, 2022 · 1 comment
Open

Documentation #3

Ulrira2k opened this issue Jun 8, 2022 · 1 comment

Comments

@Ulrira2k
Copy link

Ulrira2k commented Jun 8, 2022

First of all: Great and useful project, thank you for this.

But: Please expand the documentation a bit.

  • A minimal functioning example apparently needs MIDI.openDevice(deviceOptions) which is not mentioned here in your Readme.
  • Why do we need to import these DeviceOptions? What do they do? It seems to me that what we're doing is really opening the first available device with MIDI.openDevice(0)
  • How do we destroy a listener or disconnect from the device?
  • A minimal example for a disconnectedListener would be great too so we know we lost the connection
@Dante1349
Copy link
Owner

@Ulrira2k Hey, no problem, thanks for using. I will adjust the documentation when the library has a stable state, but currently i have no idea how the interfaces will change with the ios release. To answer some of your questions:

  • You can look up in the example for how to actually use the code.
  • The Device Options are the interface to get the different plugin parts in sync, currently its just used for the typing
  • Currently its not possible to disconnect from a listener, if you open a new one, the old one will be disconnected, at least for android

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants