McSinyx
/
palace
mirror of https://github.com/McSinyx/palace
1
1
Fork 0
Code Issues Releases Activity

Update reference doc

This commit is contained in:
Nguyễn Gia Phong 2020-03-09 17:39:23 +07:00
parent c6c0ab0c91
commit b40cd800b4
15 changed files with 144 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doctrees/environment.pickle
View File

Binary file not shown.

BIN
doctrees/index.doctree
View File

Binary file not shown.

BIN
doctrees/installation.doctree
View File

Binary file not shown.

BIN
doctrees/reference.doctree
View File

Binary file not shown.

2
html/.buildinfo
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7e4c3e644bd6a444b8aaba2ba0af92f3
config: 9128f906c827214aa6231ad483342bf2
tags: 645f666f9bcd5a90fca523b33c5a78b7

2
html/_static/documentation_options.js
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.0.11',
VERSION: '0.0.12',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

36
html/genindex.html
View File

@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Index &#8212; palace 0.0.11 documentation</title>
<title>Index &#8212; palace 0.0.12 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -89,6 +89,8 @@
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.CHANNEL_CONFIG">CHANNEL_CONFIG (in module palace)</a>
</li>
<li><a href="reference.html#palace.Buffer.channel_config">channel_config (palace.Buffer attribute)</a>
<ul>
@ -98,11 +100,11 @@
<li><a href="reference.html#palace.BaseDecoder.channel_config">channel_config() (palace.BaseDecoder property)</a>
</li>
<li><a href="reference.html#palace.channel_configs">channel_configs (in module palace)</a>
</li>
<li><a href="reference.html#palace.Device.clock_time">clock_time (palace.Device attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Device.clock_time">clock_time (palace.Device attribute)</a>
</li>
<li><a href="reference.html#palace.Device.close">close() (palace.Device method)</a>
</li>
<li><a href="reference.html#palace.Source.cone_angles">cone_angles (palace.Source attribute)</a>
@ -164,6 +166,8 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.fade_out_to_stop">fade_out_to_stop() (palace.Source method)</a>
</li>
<li><a href="reference.html#palace.FREQUENCY">FREQUENCY (in module palace)</a>
</li>
<li><a href="reference.html#palace.Buffer.frequency">frequency (palace.Buffer attribute)</a>
@ -176,6 +180,8 @@
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.BaseDecoder.frequency">frequency() (palace.BaseDecoder property)</a>
</li>
<li><a href="reference.html#palace.Buffer.from_decoder">from_decoder() (palace.Buffer static method)</a>
</li>
</ul></td>
</tr></table>
@ -205,10 +211,14 @@
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.HRTF">HRTF (in module palace)</a>
</li>
<li><a href="reference.html#palace.Device.hrtf_enabled">hrtf_enabled (palace.Device attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.HRTF_ID">HRTF_ID (in module palace)</a>
</li>
<li><a href="reference.html#palace.Device.hrtf_names">hrtf_names (palace.Device attribute)</a>
</li>
</ul></td>
@ -263,13 +273,17 @@
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.MAX_AUXILIARY_SENDS">MAX_AUXILIARY_SENDS (in module palace)</a>
</li>
<li><a href="reference.html#palace.Device.max_auxiliary_sends">max_auxiliary_sends (palace.Device attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Context.message_handler">message_handler (palace.Context attribute)</a>, <a href="reference.html#palace.Context.message_handler">[1]</a>
<li><a href="reference.html#palace.Context.message_handler">message_handler (palace.Context attribute)</a>
</li>
<li><a href="reference.html#palace.MessageHandler">MessageHandler (class in palace)</a>
</li>
<li><a href="reference.html#palace.MONO_SOURCES">MONO_SOURCES (in module palace)</a>
</li>
</ul></td>
</tr></table>
@ -298,6 +312,8 @@
<li><a href="reference.html#palace.Source.orientation">orientation (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.outer_cone_gains">outer_cone_gains (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.OUTPUT_LIMITER">OUTPUT_LIMITER (in module palace)</a>
</li>
</ul></td>
</tr></table>
@ -392,6 +408,8 @@
<li><a href="reference.html#palace.sample_length">sample_length() (in module palace)</a>
</li>
<li><a href="reference.html#palace.sample_size">sample_size() (in module palace)</a>
</li>
<li><a href="reference.html#palace.SAMPLE_TYPE">SAMPLE_TYPE (in module palace)</a>
</li>
<li><a href="reference.html#palace.Buffer.sample_type">sample_type (palace.Buffer attribute)</a>
@ -409,12 +427,14 @@
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.send_auto">send_auto() (palace.AuxiliaryEffectSlot property)</a>
</li>
<li><a href="reference.html#palace.Source">Source (class in palace)</a>
<li><a href="reference.html#palace.Buffer.size">size (palace.Buffer attribute)</a>
</li>
<li><a href="reference.html#palace.Buffer.source_count">source_count (palace.Buffer attribute)</a>
<li><a href="reference.html#palace.Source">Source (class in palace)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Buffer.source_count">source_count (palace.Buffer attribute)</a>
</li>
<li><a href="reference.html#palace.MessageHandler.source_force_stopped">source_force_stopped() (palace.MessageHandler method)</a>
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.source_sends">source_sends (palace.AuxiliaryEffectSlot attribute)</a>
@ -432,6 +452,8 @@
<li><a href="reference.html#palace.Source.spatialize">spatialize (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.stereo_angles">stereo_angles (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.STEREO_SOURCES">STEREO_SOURCES (in module palace)</a>
</li>
<li><a href="reference.html#palace.Source.stop">stop() (palace.Source method)</a>
</li>
@ -521,7 +543,7 @@
&copy;2019, 2020 Nguyễn Gia Phong et al.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>

4
html/index.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Welcome to palace’s documentation! &#8212; palace 0.0.11 documentation</title>
<title>Welcome to palace’s documentation! &#8212; palace 0.0.12 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -114,7 +114,7 @@
&copy;2019, 2020 Nguyễn Gia Phong et al.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

4
html/installation.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Installation &#8212; palace 0.0.11 documentation</title>
<title>Installation &#8212; palace 0.0.12 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -126,7 +126,7 @@ pip install palace/
&copy;2019, 2020 Nguyễn Gia Phong et al.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

BIN
html/objects.inv
View File

Binary file not shown.

4
html/py-modindex.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Python Module Index &#8212; palace 0.0.11 documentation</title>
<title>Python Module Index &#8212; palace 0.0.12 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -111,7 +111,7 @@
&copy;2019, 2020 Nguyễn Gia Phong et al.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>

126
html/reference.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Reference &#8212; palace 0.0.11 documentation</title>
<title>Reference &#8212; palace 0.0.12 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -36,6 +36,70 @@
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-palace"></span><p>Pythonic Audio Library and Codecs Environment</p>
<dl class="attribute">
<dt id="palace.CHANNEL_CONFIG">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">CHANNEL_CONFIG</code><a class="headerlink" href="#palace.CHANNEL_CONFIG" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the channel configuration
(either <cite>MONO</cite>, <cite>STEREO</cite>, <cite>QUAD</cite>, <cite>X51</cite>, <cite>X61</cite> or <cite>X71</cite>).</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.SAMPLE_TYPE">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">SAMPLE_TYPE</code><a class="headerlink" href="#palace.SAMPLE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the sample type
(either <cite>[UNSIGNED_]{BYTE,SHORT,INT}</cite> or <cite>FLOAT</cite>).</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.FREQUENCY">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">FREQUENCY</code><a class="headerlink" href="#palace.FREQUENCY" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the frequency in hertz.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.MONO_SOURCES">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">MONO_SOURCES</code><a class="headerlink" href="#palace.MONO_SOURCES" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the number of mono (3D) sources.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.STEREO_SOURCES">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">STEREO_SOURCES</code><a class="headerlink" href="#palace.STEREO_SOURCES" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the number of stereo sources.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.MAX_AUXILIARY_SENDS">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">MAX_AUXILIARY_SENDS</code><a class="headerlink" href="#palace.MAX_AUXILIARY_SENDS" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the maximum number of
auxiliary source sends.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.HRTF">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">HRTF</code><a class="headerlink" href="#palace.HRTF" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify whether to enable HRTF
(either <cite>FALSE</cite>, <cite>TRUE</cite> or <cite>DONT_CARE</cite>).</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.HRTF_ID">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">HRTF_ID</code><a class="headerlink" href="#palace.HRTF_ID" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify the HRTF to be used.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.OUTPUT_LIMITER">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">OUTPUT_LIMITER</code><a class="headerlink" href="#palace.OUTPUT_LIMITER" title="Permalink to this definition"></a></dt>
<dd><p>Context creation key to specify whether to use a gain limiter
(either <cite>FALSE</cite>, <cite>TRUE</cite> or <cite>DONT_CARE</cite>).</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.device_names">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">device_names</code><a class="headerlink" href="#palace.device_names" title="Permalink to this definition"></a></dt>
@ -328,17 +392,6 @@ and components such as sources, buffers and effects.</p>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.Context.message_handler">
<code class="sig-name descname">message_handler</code><a class="headerlink" href="#palace.Context.message_handler" title="Permalink to this definition"></a></dt>
<dd><p>Handler of some certain events.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#palace.MessageHandler" title="palace.MessageHandler">MessageHandler</a></p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>RuntimeError</strong> – If context creation fails.</p>
@ -368,14 +421,9 @@ are supported by the context.</p>
</dd></dl>
<dl class="attribute">
<dt>
<code class="sig-name descname">message_handler</code></dt>
<dd><p>palace.MessageHandler</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>message_handler</p>
</dd>
</dl>
<dt id="palace.Context.message_handler">
<code class="sig-name descname">message_handler</code><a class="headerlink" href="#palace.Context.message_handler" title="Permalink to this definition"></a></dt>
<dd><p>Handler of some certain events.</p>
</dd></dl>
<dl class="method">
@ -388,7 +436,7 @@ are supported by the context.</p>
<dl class="class">
<dt id="palace.Buffer">
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">Buffer</code><span class="sig-paren">(</span><em class="sig-param">Context context: Context</em>, <em class="sig-param">str name: str</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Buffer" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">Buffer</code><span class="sig-paren">(</span><em class="sig-param">Context context: Context</em>, <em class="sig-param">str name: str</em>, <em class="sig-param">existed: bool = False</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Buffer" title="Permalink to this definition"></a></dt>
<dd><p>Buffer of preloaded PCM samples coming from a <cite>Decoder</cite>.</p>
<p>Cached buffers must be freed using <cite>destroy</cite> before destroying
<cite>context</cite>. Alternatively, this can be used as a context manager
@ -400,6 +448,8 @@ even if an error occurs.</p>
<li><p><strong>context</strong> (<a class="reference internal" href="#palace.Context" title="palace.Context"><em>Context</em></a>) – The context from which the buffer is to be created and cached.</p></li>
<li><p><strong>name</strong> (<em>str</em>) – Audio file or resource name. Multiple calls with the same name
will return the same buffer.</p></li>
<li><p><strong>existed</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to require the resource must be cached before,
default to <cite>False</cite>.</p></li>
</ul>
</dd>
</dl>
@ -416,7 +466,8 @@ will return the same buffer.</p></li>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>RuntimeError</strong> – If the buffer can’t be loaded.</p>
<dd class="field-odd"><p><strong>RuntimeError</strong> – If the buffer can neither be loaded
nor be found when <cite>existed</cite> is set.</p>
</dd>
</dl>
<dl class="attribute">
@ -438,6 +489,25 @@ will return the same buffer.</p></li>
<dd><p>Buffer’s frequency in hertz.</p>
</dd></dl>
<dl class="method">
<dt id="palace.Buffer.from_decoder">
<em class="property">static </em><code class="sig-name descname">from_decoder</code><span class="sig-paren">(</span><em class="sig-param">Decoder decoder: Decoder</em>, <em class="sig-param">Context context: Context</em>, <em class="sig-param">str name: str</em><span class="sig-paren">)</span> &#x2192; Buffer<a class="headerlink" href="#palace.Buffer.from_decoder" title="Permalink to this definition"></a></dt>
<dd><p>Return a buffer created by reading the given decoder.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>decoder</strong> (<a class="reference internal" href="#palace.Decoder" title="palace.Decoder"><em>Decoder</em></a>) – The decoder from which the buffer is to be cached.</p></li>
<li><p><strong>context</strong> (<a class="reference internal" href="#palace.Context" title="palace.Context"><em>Context</em></a>) – The context from which the buffer is to be created.</p></li>
<li><p><strong>name</strong> (<em>str</em>) – The name to give to the buffer. It may alias an audio file,
but it must not currently exist in the buffer cache.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>RuntimeError</strong> – If the buffer cannot be created.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.Buffer.length">
<code class="sig-name descname">length</code><a class="headerlink" href="#palace.Buffer.length" title="Permalink to this definition"></a></dt>
@ -484,6 +554,16 @@ create a new one.</p>
<dd><p>Buffer’s sample type.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.Buffer.size">
<code class="sig-name descname">size</code><a class="headerlink" href="#palace.Buffer.size" title="Permalink to this definition"></a></dt>
<dd><p>Storage size used by the buffer, in bytes.</p>
<p class="rubric">Notes</p>
<p>The size in bytes may not be what you expect from the length,
as it may take more space internally than the <cite>channel_config</cite>
and <cite>sample_type</cite> suggest.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.Buffer.source_count">
<code class="sig-name descname">source_count</code><a class="headerlink" href="#palace.Buffer.source_count" title="Permalink to this definition"></a></dt>
@ -1368,7 +1448,7 @@ or stream, which is detected upon a call to <cite>Context.update</cite>.</p>
&copy;2019, 2020 Nguyễn Gia Phong et al.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|

4
html/search.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Search &#8212; palace 0.0.11 documentation</title>
<title>Search &#8212; palace 0.0.12 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -104,7 +104,7 @@
&copy;2019, 2020 Nguyễn Gia Phong et al.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>

2
html/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
src/conf.py
View File

@ -22,7 +22,7 @@ copyright = '2019, 2020 Nguyễn Gia Phong et al'
author = 'Nguyễn Gia Phong et al.'
# The full version, including alpha/beta/rc tags
release = '0.0.11'
release = '0.0.12'
# -- General configuration ---------------------------------------------------