Skip to content

Commit

Permalink
Mention the existence of third-party GUIs.
Browse files Browse the repository at this point in the history
Closes #77.
  • Loading branch information
dechamps committed Sep 4, 2020
1 parent ecabb9a commit f0d6354
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONFIGURATION.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# FlexASIO Configuration

FlexASIO does not provide a graphical interface ([GUI][]) to adjust its
settings. This is because developing a GUI typically requires a
**Tip: instead of editing the FlexASIO configuration file directly, you might
find it easier to use a third-party tool such as flipswitchingmonkey's
[FlexASIO GUI][FlexASIO_GUI].**

FlexASIO does not provide an official graphical interface ([GUI][]) to adjust
its settings. This is because developing a GUI typically requires a
significant amount of developer time that FlexASIO, sadly, doesn't have.
This explains why nothing happens when you click on the ASIO driver
"configure" or "settings" button in your application.
Expand Down Expand Up @@ -383,6 +387,7 @@ automatic conversion mechanism as the one this option controls.)
[issue87]: https://github.com/dechamps/FlexASIO/issues/87
[issue88]: https://github.com/dechamps/FlexASIO/issues/88
[logging]: README.md#logging
[FlexASIO_GUI]: https://github.com/flipswitchingmonkey/FlexASIO_GUI
[official TOML documentation]: https://github.com/toml-lang/toml#toml
[portaudio287]: https://app.assembla.com/spaces/portaudio/tickets/287-wasapi-interprets-a-zero-suggestedlatency-in-surprising-ways
[PortAudioDevices]: README.md#device-list-program
Expand Down
10 changes: 10 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ The reason for the lack of a proper control panel is because developing a
graphical user interface requires a lot of time and resources, which FlexASIO
currently doesn't have.

That said, third-party FlexASIO GUIs do exist:

- flipswitchingmonkey's [FlexASIO GUI][FlexASIO_GUI]
- Nam-K's [FlexASIO configuration helper][FlexASIO_ConfigGUI]
- [Room EQ Wizard][REW] provides a custom control
panel when FlexASIO is used as the ASIO driver

## Why does FlexASIO fail to initialize?

There are many reasons why FlexASIO might refuse to initialize. Sadly, the ASIO
Expand Down Expand Up @@ -261,12 +268,15 @@ available but then fail to initialize when that sample rate is selected.
[channels]: CONFIGURATION.md#option-channels
[device]: CONFIGURATION.md#option-device
[CONFIGURATION]: CONFIGURATION.md
[FlexASIO_GUI]: https://github.com/flipswitchingmonkey/FlexASIO_GUI
[FlexASIO_ConfigGUI]: https://github.com/Nam-K/FlexASIO_ConfigGUI
[logging]: README.md#logging
[issue #3]: https://github.com/dechamps/FlexASIO/issues/3
[issue66]: https://github.com/dechamps/FlexASIO/issues/66
[issue87]: https://github.com/dechamps/FlexASIO/issues/87
[PortAudio]: http://www.portaudio.com/
[report]: README.md#reporting-issues-feedback-feature-requests
[REW]: https://www.roomeqwizard.com/
[sampleType]: CONFIGURATION.md#option-sampleType
[suggestedLatencySeconds]: CONFIGURATION.md#option-suggestedLatencySeconds
[wasapiAutoConvert]: CONFIGURATION.md#option-wasapiAutoConvert
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ The default settings are as follows:
- 20 ms "preferred" buffer size

All of the above can be customized using a [configuration file][CONFIGURATION].
You might want to use a third-party tool such as flipswitchingmonkey's
[FlexASIO GUI][FlexASIO_GUI] to make this easier.

For more advanced use cases, such as low-latency operation and bit-perfect
streaming, see the [FAQ][].
Expand Down Expand Up @@ -133,6 +135,7 @@ while the problem is occurring, and attach it to your report. The output of
[DirectSound]: https://en.wikipedia.org/wiki/DirectSound
[Etienne Dechamps]: mailto:[email protected]
[FAQ]: FAQ.md
[FlexASIO_GUI]: https://github.com/flipswitchingmonkey/FlexASIO_GUI
[file an issue]: https://github.com/dechamps/FlexASIO/issues/new
[GitHub]: https://github.com/dechamps/FlexASIO
[GitHub issue tracker]: https://github.com/dechamps/FlexASIO/issues
Expand Down

0 comments on commit f0d6354

Please sign in to comment.