palace/docs/source/index.rst

46 lines
1.3 KiB
ReStructuredText

Overview
========
Pythonic Audio Library and Codecs Environment provides common higher-level API
for audio rendering using OpenAL:
* 3D positional rendering, with HRTF_ support for stereo systems
* Environmental effects: reverb, atmospheric air absorption,
sound occlusion and obstruction
* Out-of-the-box codec support: FLAC, MP3, Ogg Vorbis, Opus, WAV, AIFF, etc.
Palace wraps around the C++ interface alure_ using Cython_ for a safe and
convenient interface with type hinting, data descriptors and context managers,
following :pep:`8#naming-conventions` (``PascalCase.snake_case``).
.. toctree::
:caption: Table of Contents
:maxdepth: 2
installation
tutorial/index
reference/index
design
contributing
copying
.. toctree::
:caption: Quick Navigation
:hidden:
Python Package Index <https://pypi.org/project/palace/>
Travis CI Build <https://travis-ci.com/github/McSinyx/palace>
AppVeyor Build <https://ci.appveyor.com/project/McSinyx/palace>
GitHub Repository <https://github.com/McSinyx/palace>
Matrix Chat Room <https://matrix.to/#/#palace-dev:matrix.org>
Indices and Tables
------------------
* :ref:`genindex`
* :ref:`search`
.. _HRTF: https://en.wikipedia.org/wiki/Head-related_transfer_function
.. _alure: https://github.com/kcat/alure
.. _Cython: https://cython.org