2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
2020-08-24 16:51:28 +02:00
<!DOCTYPE html>
2020-10-04 09:29:06 +02:00
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > Overview — palace 0.2.1 documentation< / title >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script src = "_static/language_data.js" > < / script >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Installation" href = "installation.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "#" class = "icon icon-home" alt = "Documentation Home" > palace
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Table of Contents< / span > < / p >
2020-08-24 16:51:28 +02:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "installation.html" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial/index.html" > Tutorial< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "reference/index.html" > Reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "design.html" > Design Principles< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "contributing.html" > Getting Involved< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "copying.html" > Copying< / a > < / li >
< / ul >
2020-10-04 09:29:06 +02:00
< p class = "caption" > < span class = "caption-text" > Quick Navigation< / span > < / p >
2020-08-24 16:51:28 +02:00
< ul >
2020-10-04 09:29:06 +02:00
< li class = "toctree-l1" > < a class = "reference external" href = "https://pypi.org/project/palace/" > Python Package Index< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://travis-ci.com/github/McSinyx/palace" > Travis CI Build< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://ci.appveyor.com/project/McSinyx/palace" > AppVeyor Build< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/McSinyx/palace" > GitHub Repository< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://matrix.to/#/#palace-dev:matrix.org" > Matrix Chat Room< / a > < / li >
2020-08-24 16:51:28 +02:00
< / ul >
2020-10-04 09:29:06 +02:00
2020-08-24 16:51:28 +02:00
< / div >
2020-10-04 09:29:06 +02:00
2020-08-24 16:51:28 +02:00
< / div >
2020-10-04 09:29:06 +02:00
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "#" > palace< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "#" class = "icon icon-home" > < / a > » < / li >
< li > Overview< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/index.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2020-08-24 16:51:28 +02:00
< div class = "section" id = "overview" >
< h1 > Overview< a class = "headerlink" href = "#overview" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Pythonic Audio Library and Codecs Environment provides common higher-level API
for audio rendering using OpenAL:< / p >
< ul class = "simple" >
< li > < p > 3D positional rendering, with < a class = "reference external" href = "https://en.wikipedia.org/wiki/Head-related_transfer_function" > HRTF< / a > support for stereo systems< / p > < / li >
< li > < p > Environmental effects: reverb, atmospheric air absorption,
sound occlusion and obstruction< / p > < / li >
< li > < p > Out-of-the-box codec support: FLAC, MP3, Ogg Vorbis, Opus, WAV, AIFF, etc.< / p > < / li >
< / ul >
< p > Palace wraps around the C++ interface < a class = "reference external" href = "https://github.com/kcat/alure" > alure< / a > using < a class = "reference external" href = "https://cython.org" > Cython< / a > for a safe and
convenient interface with type hinting, data descriptors and context managers,
following < span class = "target" id = "index-0" > < / span > < a class = "pep reference external" href = "https://www.python.org/dev/peps/pep-0008#naming-conventions" > < strong > PEP 8#naming-conventions< / strong > < / a > (< code class = "docutils literal notranslate" > < span class = "pre" > PascalCase.snake_case< / span > < / code > ).< / p >
< div class = "toctree-wrapper compound" >
2020-10-04 09:29:06 +02:00
< p class = "caption" > < span class = "caption-text" > Table of Contents< / span > < / p >
2020-08-24 16:51:28 +02:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "installation.html" > Installation< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation.html#prerequisites" > Prerequisites< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation.html#via-pypi" > Via PyPI< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "installation.html#from-source" > From source< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial/index.html" > Tutorial< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial/context.html" > Context Creation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial/play-audio.html" > Play an Audio< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial/source.html" > Source Manipulation< / a > < / li >
2020-10-06 15:42:47 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial/effect.html" > Adding an Effect< / a > < / li >
2020-08-24 16:51:28 +02:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "reference/index.html" > Reference< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/device.html" > Audio Devices< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/context.html" > Audio Library Contexts< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/buffer.html" > Resource Caching< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/source.html" > Sources & Source Groups< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/effect.html" > Environmental Effects< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/decoder.html" > Audio Streams< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "reference/file-io.html" > File I/O Interface< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "design.html" > Design Principles< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "design.html#the-impl-idiom" > The Impl Idiom< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "design.html#the-modern-python" > The Modern Python< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "design.html#the-double-reference" > The Double Reference< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "contributing.html" > Getting Involved< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "contributing.html#reporting-a-bug" > Reporting a Bug< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "contributing.html#requesting-a-feature" > Requesting a Feature< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "contributing.html#submitting-a-patch" > Submitting a Patch< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "contributing.html#making-a-release" > Making a Release< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "contributing.html#style-guidelines" > Style Guidelines< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "copying.html" > Copying< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "copying.html#license" > License< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "copying.html#credits" > Credits< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
2020-10-04 09:29:06 +02:00
< div class = "toctree-wrapper compound" >
2020-08-24 16:51:28 +02:00
< / div >
< div class = "section" id = "indices-and-tables" >
< h2 > Indices and Tables< a class = "headerlink" href = "#indices-and-tables" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "genindex.html" > < span class = "std std-ref" > Index< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "search.html" > < span class = "std std-ref" > Search Page< / span > < / a > < / p > < / li >
< / ul >
< / div >
< / div >
2020-10-04 09:29:06 +02:00
< / div >
2020-08-24 16:51:28 +02:00
< / div >
2020-10-04 09:29:06 +02:00
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "installation.html" class = "btn btn-neutral float-right" title = "Installation" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2020-08-24 16:51:28 +02:00
< / div >
2020-10-04 09:29:06 +02:00
< hr / >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
< div role = "contentinfo" >
< p >
© Copyright 2019, 2020 Nguyễn Gia Phong et al
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
2020-08-24 16:51:28 +02:00
2020-10-04 09:29:06 +02:00
< / body >
2020-08-24 16:51:28 +02:00
< / html >