rob
/
cpal
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README for ASIO v2.3.3

This commit is contained in:
mitchmindtree 2019-06-29 05:48:18 +10:00
parent 191b90909a
commit 76fab4f982
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -13,7 +13,7 @@ This library currently supports the following:
- Get the current default input and output stream formats for a device. - Get the current default input and output stream formats for a device.
- Build and run input and output PCM streams on a chosen device with a given stream format. - Build and run input and output PCM streams on a chosen device with a given stream format.
Currently supported backends include: Currently supported hosts include:
- Linux (via ALSA) - Linux (via ALSA)
- Windows (via WASAPI by default, see ASIO instructions below) - Windows (via WASAPI by default, see ASIO instructions below)
@ -39,10 +39,11 @@ WASAPI. To do so, follow these steps:
1. **Download the ASIO SDK** `.zip` from [this 1. **Download the ASIO SDK** `.zip` from [this
link](https://www.steinberg.net/en/company/developers.html). The version as link](https://www.steinberg.net/en/company/developers.html). The version as
of writing this is 2.3.1. of writing this is 2.3.1.
2. Extract the files and place the `ASIOSDK2.3.1` directory somewhere you are 2. Extract the files and place the directory somewhere you are happy for it to stay
happy for it to stay (e.g. `~/.asio`). (e.g. `~/.asio`).
3. Assign the full path of the `ASIOSDK2.3.1` directory to the `CPAL_ASIO_DIR` 3. Assign the full path of the directory (that contains the `readme`, `changes`,
environment variable. [How to set persisting Environment Variables on `ASIO SDK 2.3` pdf, etc) to the `CPAL_ASIO_DIR` environment variable. [How to
set persisting Environment Variables on
Windows](https://gist.github.com/mitchmindtree/92c8e37fa80c8dddee5b94fc88d1288b#file-windows_environment_variables-md). Windows](https://gist.github.com/mitchmindtree/92c8e37fa80c8dddee5b94fc88d1288b#file-windows_environment_variables-md).
The existence of the `CPAL_ASIO_DIR` environment variable determines whether The existence of the `CPAL_ASIO_DIR` environment variable determines whether
or not CPAL will attempt to build the ASIO SDK and generate bindings to it. or not CPAL will attempt to build the ASIO SDK and generate bindings to it.
@ -83,5 +84,8 @@ WASAPI. To do so, follow these steps:
If you run into an error along the lines of "no variant `Asio` in `HostId`", If you run into an error along the lines of "no variant `Asio` in `HostId`",
make sure that `CPAL_ASIO_DIR` is set correctly and try `cargo clean`. make sure that `CPAL_ASIO_DIR` is set correctly and try `cargo clean`.
In the future we would like to work on automating this process to make it In the future we would like to work on automating this process to make it
easier, but we are not familiar enough with the ASIO license to do so yet. easier, but we are not familiar enough with the ASIO license to do so yet.
*Updated as of ASIO version 2.3.3.*