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

Build documentation for version 0.0.9

This commit is contained in:
Nguyễn Gia Phong 2020-02-15 14:42:38 +07:00
parent 538b1a4f93
commit d15649dad0
18 changed files with 342 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -5,7 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
SOURCEDIR = src
BUILDDIR = .
# Put it first so that "make" without argument is like "make help".

BIN
doctrees/environment.pickle
View File

Binary file not shown.

BIN
doctrees/index.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: 4cc0c27bdc7cedaf2be4fea2666d6a5a
config: cf9e10b1aff73ac9fe16df638fe0622c
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.8',
VERSION: '0.0.9',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

77
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.8 documentation</title>
<title>Index &#8212; palace 0.0.9 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -43,6 +43,7 @@
| <a href="#F"><strong>F</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
@ -59,10 +60,14 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.air_absorption_factor">air_absorption_factor (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Device.alc_version">alc_version (palace.Device attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Device.alc_version">alc_version (palace.Device attribute)</a>
<li><a href="reference.html#palace.Source.auxiliary_send">auxiliary_send() (palace.Source property)</a>
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot">AuxiliaryEffectSlot (class in palace)</a>
</li>
</ul></td>
</tr></table>
@ -71,6 +76,10 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Buffer">Buffer (class in palace)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.MessageHandler.buffer_loading">buffer_loading() (palace.MessageHandler method)</a>
</li>
</ul></td>
</tr></table>
@ -78,12 +87,14 @@
<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.Buffer.channel_config_name">channel_config_name (palace.Buffer attribute)</a>
<li><a href="reference.html#palace.Buffer.channel_config">channel_config (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.channel_config_name">(palace.Decoder attribute)</a>
<li><a href="reference.html#palace.Decoder.channel_config">(palace.Decoder attribute)</a>
</li>
</ul></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>
@ -104,9 +115,11 @@
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Decoder">Decoder (class in palace)</a>
</li>
<li><a href="reference.html#palace.Buffer.destroy">destroy() (palace.Buffer method)</a>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.destroy">destroy() (palace.AuxiliaryEffectSlot method)</a>
<ul>
<li><a href="reference.html#palace.Buffer.destroy">(palace.Buffer method)</a>
</li>
<li><a href="reference.html#palace.Context.destroy">(palace.Context method)</a>
</li>
<li><a href="reference.html#palace.Source.destroy">(palace.Source method)</a>
@ -119,6 +132,8 @@
<li><a href="reference.html#palace.Device">Device (class in palace)</a>
</li>
<li><a href="reference.html#palace.Context.device">device (palace.Context attribute)</a>
</li>
<li><a href="reference.html#palace.MessageHandler.device_disconnected">device_disconnected() (palace.MessageHandler method)</a>
</li>
<li><a href="reference.html#palace.device_name_default">device_name_default (in module palace)</a>
</li>
@ -164,6 +179,8 @@
<li><a href="reference.html#palace.SourceGroup.gain">(palace.SourceGroup attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.gain">gain() (palace.AuxiliaryEffectSlot property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.gain_auto">gain_auto (palace.Source attribute)</a>
@ -187,6 +204,14 @@
</ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Context.is_supported">is_supported() (palace.Context method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
@ -208,6 +233,8 @@
<li><a href="reference.html#palace.Decoder.length_seconds">(palace.Decoder attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.Context.listener">listener (palace.Context attribute)</a>
</li>
<li><a href="reference.html#palace.Buffer.loop_points">loop_points (palace.Buffer attribute)</a>
</li>
<li><a href="reference.html#palace.Source.looping">looping (palace.Source attribute)</a>
@ -219,6 +246,12 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
<li><a href="reference.html#palace.MessageHandler">MessageHandler (class in palace)</a>
</li>
</ul></td>
</tr></table>
@ -226,8 +259,12 @@
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Device.name">name (palace.Device attribute)</a>
<li><a href="reference.html#palace.Buffer.name">name (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Device.name">(palace.Device attribute)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
@ -314,6 +351,8 @@
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.MessageHandler.resource_not_found">resource_not_found() (palace.MessageHandler method)</a>
</li>
<li><a href="reference.html#palace.Source.resume">resume() (palace.Source method)</a>
</li>
<li><a href="reference.html#palace.SourceGroup.resume_all">resume_all() (palace.SourceGroup method)</a>
@ -328,15 +367,33 @@
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Buffer.sample_type_name">sample_type_name (palace.Buffer attribute)</a>
<li><a href="reference.html#palace.Buffer.sample_type">sample_type (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.sample_type_name">(palace.Decoder attribute)</a>
<li><a href="reference.html#palace.Decoder.sample_type">(palace.Decoder attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.sample_types">sample_types (in module palace)</a>
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.send_auto">send_auto() (palace.AuxiliaryEffectSlot property)</a>
</li>
<li><a href="reference.html#palace.Source.set_auxiliary_send">set_auxiliary_send() (palace.Source method)</a>
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.set_gain">set_gain() (palace.AuxiliaryEffectSlot method)</a>
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.set_send_auto">set_send_auto() (palace.AuxiliaryEffectSlot method)</a>
</li>
<li><a href="reference.html#palace.Source">Source (class in palace)</a>
</li>
<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>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.source_sends">source_sends (palace.AuxiliaryEffectSlot attribute)</a>
</li>
<li><a href="reference.html#palace.MessageHandler.source_stopped">source_stopped() (palace.MessageHandler method)</a>
</li>
<li><a href="reference.html#palace.SourceGroup">SourceGroup (class in palace)</a>
</li>
@ -346,8 +403,6 @@
<li><a href="reference.html#palace.SourceGroup.sources">(palace.SourceGroup attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
@ -369,6 +424,8 @@
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.use_context">use_context() (in module palace)</a>
</li>
<li><a href="reference.html#palace.AuxiliaryEffectSlot.use_count">use_count (palace.AuxiliaryEffectSlot attribute)</a>
</li>
</ul></td>
</tr></table>

2
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.8 documentation</title>
<title>Welcome to palace’s documentation! &#8212; palace 0.0.9 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

BIN
html/objects.inv
View File

Binary file not shown.

2
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.8 documentation</title>
<title>Python Module Index &#8212; palace 0.0.9 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

286
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.8 documentation</title>
<title>Reference &#8212; palace 0.0.9 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -58,6 +58,28 @@
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.sample_types">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">sample_types</code><a class="headerlink" href="#palace.sample_types" title="Permalink to this definition"></a></dt>
<dd><p>Set of sample types.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>FrozenSet[str]</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.channel_configs">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">channel_configs</code><a class="headerlink" href="#palace.channel_configs" title="Permalink to this definition"></a></dt>
<dd><p>Set of channel configurations.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>FrozenSet[str]</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="palace.query_extension">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">query_extension</code><span class="sig-paren">(</span><em class="sig-param">str name: str</em><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#palace.query_extension" title="Permalink to this definition"></a></dt>
@ -86,7 +108,7 @@
<dl class="class">
<dt id="palace.Device">
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">Device</code><span class="sig-paren">(</span><em class="sig-param">str name: str = ''</em>, <em class="sig-param">fail_safe: bool = False</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Device" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">Device</code><span class="sig-paren">(</span><em class="sig-param">name: Optional[str] = ''</em>, <em class="sig-param">fail_safe: bool = False</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Device" title="Permalink to this definition"></a></dt>
<dd><p>Audio mix output, which is either a system audio output stream
or an actual audio port.</p>
<p>This can be used as a context manager that calls <cite>close</cite> upon
@ -94,7 +116,8 @@ completion of the block, even if an error occurs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The name of the playback device.</p></li>
<li><p><strong>name</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – The name of the playback device. If it is <cite>None</cite>,
the object is left uninitialized.</p></li>
<li><p><strong>fail_safe</strong> (<em>bool</em><em>, </em><em>optional</em>) – On failure, fallback to the default device if this is <cite>True</cite>,
otherwise <cite>RuntimeError</cite> is raised. Default to <cite>False</cite>.</p></li>
</ul>
@ -152,7 +175,7 @@ must first be destroyed.</p>
<dt id="palace.Device.efx_version">
<code class="sig-name descname">efx_version</code><a class="headerlink" href="#palace.Device.efx_version" title="Permalink to this definition"></a></dt>
<dd><p>EFX version supported by this device.</p>
<p>If the ALC_EXT_EFX extension is unsupported,
<p>If the <cite>ALC_EXT_EFX</cite> extension is unsupported,
this will be <cite>(0, 0)</cite>.</p>
</dd></dl>
@ -176,7 +199,7 @@ HRTF applied at a lower hardware level.</p>
<code class="sig-name descname">hrtf_names</code><a class="headerlink" href="#palace.Device.hrtf_names" title="Permalink to this definition"></a></dt>
<dd><p>List of available HRTF names, sorted as OpenAL gives them,
such that the index of a given name is the ID to use with
ALC_HRTF_ID_SOFT.</p>
<cite>ALC_HRTF_ID_SOFT</cite>.</p>
<p>If the <cite>ALC_SOFT_HRTF</cite> extension is unavailable,
this will be an empty list.</p>
</dd></dl>
@ -185,7 +208,7 @@ this will be an empty list.</p>
<dt id="palace.Device.max_auxiliary_sends">
<code class="sig-name descname">max_auxiliary_sends</code><a class="headerlink" href="#palace.Device.max_auxiliary_sends" title="Permalink to this definition"></a></dt>
<dd><p>Maximum number of auxiliary source sends.</p>
<p>If ALC_EXT_EFX is unsupported, this will be 0.</p>
<p>If <cite>ALC_EXT_EFX</cite> is unsupported, this will be 0.</p>
</dd></dl>
<dl class="attribute">
@ -271,6 +294,28 @@ and components such as sources, buffers and effects.</p>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.Context.listener">
<code class="sig-name descname">listener</code><a class="headerlink" href="#palace.Context.listener" title="Permalink to this definition"></a></dt>
<dd><p>The listener instance of this context.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Listener</p>
</dd>
</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>
@ -283,6 +328,33 @@ and components such as sources, buffers and effects.</p>
when this is called.</p>
</dd></dl>
<dl class="method">
<dt id="palace.Context.is_supported">
<code class="sig-name descname">is_supported</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">str channel_config: str</em>, <em class="sig-param">str sample_type: str</em><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#palace.Context.is_supported" title="Permalink to this definition"></a></dt>
<dd><p>Return if the channel configuration and sample type
are supported by the context.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#palace.sample_types" title="palace.sample_types"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sample_types()</span></code></a></dt><dd><p>Set of sample types</p>
</dd>
<dt><a class="reference internal" href="#palace.channel_configs" title="palace.channel_configs"><code class="xref py py-meth docutils literal notranslate"><span class="pre">channel_configs()</span></code></a></dt><dd><p>Set of channel configurations</p>
</dd>
</dl>
</div>
</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>
</dd></dl>
<dl class="method">
<dt id="palace.Context.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Context.update" title="Permalink to this definition"></a></dt>
@ -307,14 +379,27 @@ even if an error occurs.</p>
will return the same buffer.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>RuntimeError</strong> – If the buffer can’t be loaded.</p>
</dl>
<dl class="attribute">
<dt id="palace.Buffer.name">
<code class="sig-name descname">name</code><a class="headerlink" href="#palace.Buffer.name" title="Permalink to this definition"></a></dt>
<dd><p>Audio file or resource name.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</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 the buffer can’t be loaded.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="palace.Buffer.channel_config_name">
<code class="sig-name descname">channel_config_name</code><a class="headerlink" href="#palace.Buffer.channel_config_name" title="Permalink to this definition"></a></dt>
<dd><p>Buffer’s sample configuration name.</p>
<dt id="palace.Buffer.channel_config">
<code class="sig-name descname">channel_config</code><a class="headerlink" href="#palace.Buffer.channel_config" title="Permalink to this definition"></a></dt>
<dd><p>Buffer’s sample configuration.</p>
</dd></dl>
<dl class="method">
@ -371,9 +456,9 @@ may be played from multiple sources simultaneously.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.Buffer.sample_type_name">
<code class="sig-name descname">sample_type_name</code><a class="headerlink" href="#palace.Buffer.sample_type_name" title="Permalink to this definition"></a></dt>
<dd><p>Buffer’s sample type name.</p>
<dt id="palace.Buffer.sample_type">
<code class="sig-name descname">sample_type</code><a class="headerlink" href="#palace.Buffer.sample_type" title="Permalink to this definition"></a></dt>
<dd><p>Buffer’s sample type.</p>
</dd></dl>
<dl class="attribute">
@ -417,6 +502,13 @@ a nominal -0.05 dB per meter, with higher values simulating
foggy air and lower values simulating dryer air; default to 0.</p>
</dd></dl>
<dl class="method">
<dt id="palace.Source.auxiliary_send">
<em class="property">property </em><code class="sig-name descname">auxiliary_send</code><a class="headerlink" href="#palace.Source.auxiliary_send" title="Permalink to this definition"></a></dt>
<dd><p>Connect the effect slot to the given send path.
Any filter properties on the send path remain as they were.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.Source.cone_angles">
<code class="sig-name descname">cone_angles</code><a class="headerlink" href="#palace.Source.cone_angles" title="Permalink to this definition"></a></dt>
@ -740,6 +832,11 @@ apply a more realistic room decay based on the reverb decay
time and distance.</p>
</dd></dl>
<dl class="method">
<dt id="palace.Source.set_auxiliary_send">
<code class="sig-name descname">set_auxiliary_send</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">AuxiliaryEffectSlot slot: AuxiliaryEffectSlot</em>, <em class="sig-param">send: int</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Source.set_auxiliary_send" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="palace.Source.spatialize">
<code class="sig-name descname">spatialize</code><a class="headerlink" href="#palace.Source.spatialize" title="Permalink to this definition"></a></dt>
@ -860,6 +957,73 @@ including sub-groups.</p>
</dd></dl>
<dl class="class">
<dt id="palace.AuxiliaryEffectSlot">
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">AuxiliaryEffectSlot</code><span class="sig-paren">(</span><em class="sig-param">Context context: Context</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.AuxiliaryEffectSlot" title="Permalink to this definition"></a></dt>
<dd><p>An effect processor.</p>
<p>It takes the output mix of zero or more sources,
applies DSP for the desired effect (as configured
by a given <cite>Effect</cite> object), then adds to the output mix.</p>
<p>This can be used as a context manager that calls <cite>destroy</cite>
upon completion of the block, even if an error occurs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>context</strong> (<a class="reference internal" href="#palace.Context" title="palace.Context"><em>Context</em></a>) – The context from which the auxiliary effect slot is to be created.</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>RuntimeError</strong> – If the effect slot can’t be created.</p>
</dd>
</dl>
<dl class="method">
<dt id="palace.AuxiliaryEffectSlot.destroy">
<code class="sig-name descname">destroy</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.AuxiliaryEffectSlot.destroy" title="Permalink to this definition"></a></dt>
<dd><p>Destroy the effect slot, returning it to the system.
If the effect slot is currently set on a source send,
it will be removed first.</p>
</dd></dl>
<dl class="method">
<dt id="palace.AuxiliaryEffectSlot.gain">
<em class="property">property </em><code class="sig-name descname">gain</code><a class="headerlink" href="#palace.AuxiliaryEffectSlot.gain" title="Permalink to this definition"></a></dt>
<dd><p>Gain of the effect slot.</p>
</dd></dl>
<dl class="method">
<dt id="palace.AuxiliaryEffectSlot.send_auto">
<em class="property">property </em><code class="sig-name descname">send_auto</code><a class="headerlink" href="#palace.AuxiliaryEffectSlot.send_auto" title="Permalink to this definition"></a></dt>
<dd><p>If set to <cite>True</cite>, the reverb effect will automatically
apply adjustments to the source’s send slot gains based
on the effect properties.</p>
<p>Has no effect when using non-reverb effects. Default is <cite>True</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="palace.AuxiliaryEffectSlot.set_gain">
<code class="sig-name descname">set_gain</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">double value: float</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.AuxiliaryEffectSlot.set_gain" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="palace.AuxiliaryEffectSlot.set_send_auto">
<code class="sig-name descname">set_send_auto</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">value: bool</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.AuxiliaryEffectSlot.set_send_auto" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="palace.AuxiliaryEffectSlot.source_sends">
<code class="sig-name descname">source_sends</code><a class="headerlink" href="#palace.AuxiliaryEffectSlot.source_sends" title="Permalink to this definition"></a></dt>
<dd><p>Iterator of each <cite>Source</cite> object and its pairing
send this effect slot is set on.</p>
</dd></dl>
<dl class="attribute">
<dt id="palace.AuxiliaryEffectSlot.use_count">
<code class="sig-name descname">use_count</code><a class="headerlink" href="#palace.AuxiliaryEffectSlot.use_count" title="Permalink to this definition"></a></dt>
<dd><p>Number of source sends the effect slot
is used by. This is equivalent to calling
<cite>len(tuple(self.source_sends))</cite>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="palace.Decoder">
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">Decoder</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.Decoder" title="Permalink to this definition"></a></dt>
@ -880,9 +1044,9 @@ including sub-groups.</p>
</dl>
</div>
<dl class="attribute">
<dt id="palace.Decoder.channel_config_name">
<code class="sig-name descname">channel_config_name</code><a class="headerlink" href="#palace.Decoder.channel_config_name" title="Permalink to this definition"></a></dt>
<dd><p>Name of the channel configuration of the audio being decoded.</p>
<dt id="palace.Decoder.channel_config">
<code class="sig-name descname">channel_config</code><a class="headerlink" href="#palace.Decoder.channel_config" title="Permalink to this definition"></a></dt>
<dd><p>Channel configuration of the audio being decoded.</p>
</dd></dl>
<dl class="attribute">
@ -931,9 +1095,91 @@ a new one will be created.</p></li>
</dd></dl>
<dl class="attribute">
<dt id="palace.Decoder.sample_type_name">
<code class="sig-name descname">sample_type_name</code><a class="headerlink" href="#palace.Decoder.sample_type_name" title="Permalink to this definition"></a></dt>
<dd><p>Name of the sample type of the audio being decoded.</p>
<dt id="palace.Decoder.sample_type">
<code class="sig-name descname">sample_type</code><a class="headerlink" href="#palace.Decoder.sample_type" title="Permalink to this definition"></a></dt>
<dd><p>Sample type of the audio being decoded.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="palace.MessageHandler">
<em class="property">class </em><code class="sig-prename descclassname">palace.</code><code class="sig-name descname">MessageHandler</code><a class="headerlink" href="#palace.MessageHandler" title="Permalink to this definition"></a></dt>
<dd><p>Message handler interface.</p>
<p>Applications may derive from this and set an instance on a context
to receive messages. The base methods are no-ops, so subclasses
only need to implement methods for relevant messages.</p>
<p>Methods of MessageHandler must not raise any exception.</p>
<dl class="method">
<dt id="palace.MessageHandler.buffer_loading">
<code class="sig-name descname">buffer_loading</code><span class="sig-paren">(</span><em class="sig-param">self, str name: str, str channel_config: str, str sample_type: str, sample_rate: int, data: List[int]</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.MessageHandler.buffer_loading" title="Permalink to this definition"></a></dt>
<dd><p>Handle messages from Buffer initialization.</p>
<p>This is called when a new buffer is about to be created
and loaded. which may be called asynchronously for buffers
being loaded asynchronously.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) – Resource name passed to <cite>Buffer</cite>.</p></li>
<li><p><strong>channel_config</strong> (<em>str</em>) – Channel configuration of the given audio data.</p></li>
<li><p><strong>sample_type</strong> (<em>str</em>) – Sample type of the given audio data.</p></li>
<li><p><strong>sample_rate</strong> (<em>int</em>) – Sample rate of the given audio data.</p></li>
<li><p><strong>data</strong> (<em>List</em><em>[</em><em>int</em><em>]</em>) – The audio data that is about to be fed to the OpenAL buffer.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="palace.MessageHandler.device_disconnected">
<code class="sig-name descname">device_disconnected</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">Device device: Device</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.MessageHandler.device_disconnected" title="Permalink to this definition"></a></dt>
<dd><p>Handle disconnected device messages.</p>
<p>This is called when the given device has been disconnected and
is no longer usable for output. As per the <cite>ALC_EXT_disconnect</cite>
specification, disconnected devices remain valid, however all
playing sources are automatically stopped, any sources that are
attempted to play will immediately stop, and new contexts may
not be created on the device.</p>
<p class="rubric">Notes</p>
<p>Connection status is checked during <cite>Context.update</cite> calls, so
method must be called regularly to be notified when a device is
disconnected. This method may not be called if the device lacks
support for the <cite>ALC_EXT_disconnect</cite> extension.</p>
</dd></dl>
<dl class="method">
<dt id="palace.MessageHandler.resource_not_found">
<code class="sig-name descname">resource_not_found</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">str name: str</em><span class="sig-paren">)</span> &#x2192; str<a class="headerlink" href="#palace.MessageHandler.resource_not_found" title="Permalink to this definition"></a></dt>
<dd><p>Return the fallback resource for the one of the given name.</p>
<p>This is called when <cite>name</cite> is not found, allowing substitution
of a different resource until the returned string either points
to a valid resource or is empty (default).</p>
<p>For buffers being cached, the original name will still be used
for the cache entry so one does not have to keep track of
substituted resource names.</p>
</dd></dl>
<dl class="method">
<dt id="palace.MessageHandler.source_force_stopped">
<code class="sig-name descname">source_force_stopped</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">Source source: Source</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.MessageHandler.source_force_stopped" title="Permalink to this definition"></a></dt>
<dd><p>Handle forcefully stopped sources.</p>
<p>This is called when the given source was forced to stop,
because of one of the following reasons:</p>
<ul class="simple">
<li><p>There were no more mixing sources and a higher-priority source
preempted it.</p></li>
<li><p><cite>source</cite> is part of a <cite>SourceGroup</cite> (or sub-group thereof)
that had its <cite>SourceGroup.stop_all</cite> method called.</p></li>
<li><p><cite>source</cite> was playing a buffer that’s getting removed.</p></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="palace.MessageHandler.source_stopped">
<code class="sig-name descname">source_stopped</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">Source source: Source</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.MessageHandler.source_stopped" title="Permalink to this definition"></a></dt>
<dd><p>Handle end-of-buffer/stream messages.</p>
<p>This is called when the given source reaches the end of buffer
or stream, which is detected upon a call to <cite>Context.update</cite>.</p>
</dd></dl>
</dd></dl>

2
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.8 documentation</title>
<title>Search &#8212; palace 0.0.9 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

2
html/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
make.bat
View File

@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set SOURCEDIR=src
set BUILDDIR=.
if "%1" == "" goto help

0
source/_static/.empty → src/_static/.empty
View File

2
source/conf.py → src/conf.py
View File

@ -22,7 +22,7 @@ copyright = '2019, 2020 Nguyễn Gia Phong & contributors'
author = 'Nguyễn Gia Phong & contributors'
# The full version, including alpha/beta/rc tags
release = '0.0.8'
release = '0.0.9'
# -- General configuration ---------------------------------------------------

0
source/index.rst → src/index.rst
View File

0
source/reference.rst → src/reference.rst
View File