Skip to content

Commit 028a0c2

Browse files
committed
DOC: Describe how to use a custom so/dylib/dll
1 parent bb65479 commit 028a0c2

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

doc/installation.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ manager (the package might be called ``libportaudio2`` or similar).
3333
.. note::
3434

3535
If you install PortAudio with a package manager (including ``conda``),
36-
it will override the version installed with ``pip``.
36+
it will likely override the version installed with ``pip``.
3737

3838
The NumPy_ library is only needed if you want to play back and record NumPy arrays.
3939
The classes `sounddevice.RawStream`, `sounddevice.RawInputStream` and
@@ -44,6 +44,19 @@ If needed -- and not installed already -- NumPy can be installed like this::
4444
python -m pip install numpy
4545

4646

47+
Custom PortAudio Library
48+
------------------------
49+
50+
If you have a custom PortAudio library
51+
(maybe a development version or a version with different features selected),
52+
you can rename the library to ``libportaudio.so`` (Linux)
53+
or ``libportaudio.dylib`` (macOS) and move it to ``/usr/local/lib``.
54+
On Linux, you might have to run ``sudo ldconfig`` after that,
55+
for the library to be found.
56+
On Windows, you can rename the library to ``portaudio.dll``
57+
and move it to ``%SystemRoot%\system32``.
58+
59+
4760
Alternative Packages
4861
--------------------
4962

0 commit comments

Comments
 (0)