Skip to content

Commit 0bb31eb

Browse files
committed
Update README.md HOWTO
Add more information and SAR Configuration tool from start menu when using v0.13.99.1 or later. Also add a note for prereleases and testsigning.
1 parent 2825fcf commit 0bb31eb

1 file changed

Lines changed: 36 additions & 13 deletions

File tree

README.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,40 @@ Discord server at [https://discord.gg/9rwFdMW](https://discord.gg/9rwFdMW).
3838

3939
## HOWTO
4040

41-
Once you've installed SAR, nothing will immediately happen. To configure it,
42-
first start your DAW (for beta: as admin!) and open its audio configuration
43-
settings. Select the Synchronous Audio Router ASIO driver and open the ASIO
44-
configuration dialog. Under Hardware Interface, select the ASIO driver for
45-
your physical audio device.
41+
Once you've installed SAR, nothing will immediately happen.
42+
To configure it, either:
43+
* Start your DAW (for beta: as admin!) and open its audio configuration settings.
44+
Select the Synchronous Audio Router ASIO driver and open the ASIO
45+
configuration dialog.
46+
* Start `SAR Configuration` tool from Windows' start menu (0.13.99.1 or later).
47+
48+
The SAR Configuration dialog will open.
49+
50+
![SAR Endpoints Configuration image](https://raw.githubusercontent.com/eiz/SynchronousAudioRouter/master/SarWeb/images/sar_endpoints.png)
51+
52+
Under Hardware Interface, select the ASIO driver for your physical audio
53+
device.
4654

4755
You can add an unlimited number of Windows audio endpoints from the SAR
48-
configuration dialog. "Playback" endpoints will allow Windows applications
49-
to play sound and show up as corresponding input channels on your ASIO device,
50-
while "Recording" endpoints allow Windows apps to record output sound and
51-
correspond to ASIO output channels. Once you've added your channels, make sure
52-
they're enabled in your DAW -- most have a dialog or dropdown where you can
53-
select which channels are to be used.
56+
configuration dialog.
57+
* `Playback` endpoints allow Windows applications to play sound and show up
58+
as corresponding input channels on your ASIO device.
59+
* `Recording` endpoints allow Windows apps to record output sound and
60+
correspond to ASIO output channels.
61+
62+
Once you've added your channels, make sure they're enabled in your DAW --
63+
most have a dialog or dropdown where you can select which channels are to
64+
be used.
65+
66+
SAR will expose more ASIO channels than the underlaying ASIO driver, like this:
67+
* The first ASIO channels are the physical ones from the underlaying ASIO
68+
driver.
69+
* Then, the remaining ASIO channels are mapped to virtual endpoints.
5470

5571
If you receive errors initializing the SAR ASIO driver, make sure you are
56-
running your DAW as admin. This is a requirement of the SAR beta build and
57-
will be relaxed eventually.
72+
running your DAW as admin. This is a requirement of the SAR beta build or
73+
if you choose `Require Administrator privileges to access SAR` option in the
74+
SAR installer.
5875

5976
Note that the endpoints created by SAR are only active while your DAW is
6077
running and has started ASIO. They are automatically disconnected when the
@@ -68,4 +85,10 @@ Make sure you have Windows update [KB3033929](https://technet.microsoft.com/en-u
6885
installed prior to installing SAR, otherwise you will receive an error about
6986
an unsigned driver.
7087

88+
## Unsigned prereleased drivers note
7189

90+
Prereleases of SAR are unsigned. That means that it is required to enable
91+
`testsigning` boot option to make Windows load the driver. Else the driver
92+
won't be loaded.
93+
For more information about `testsigning` option, see here:
94+
https://docs.microsoft.com/en-us/windows-hardware/drivers/install/the-testsigning-boot-configuration-option#enable-or-disable-use-of-test-signed-code

0 commit comments

Comments
 (0)