Update doc for 0.0.10

This commit is contained in:
Huy Ngo 2020-02-26 20:32:20 +07:00
parent 7ba858387e
commit a7ccc8a317
5 changed files with 1712 additions and 10 deletions

View File

@ -35,8 +35,435 @@
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#B"><strong>B</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <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>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#U"><strong>U</strong></a>
| <a href="#V"><strong>V</strong></a>
</div>
<h2 id="A">A</h2>
<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.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>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.BaseDecoder">BaseDecoder (class in palace)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Buffer">Buffer (class in palace)</a>
</li>
<li><a href="reference.html#palace.MessageHandler.buffer_loading">buffer_loading() (palace.MessageHandler method)</a>
</li>
</ul></td>
</tr></table>
<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">channel_config (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.channel_config">(palace.Decoder attribute)</a>
</li>
</ul></li>
<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.close">close() (palace.Device method)</a>
</li>
<li><a href="reference.html#palace.Source.cone_angles">cone_angles (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Context">Context (class in palace)</a>
</li>
<li><a href="reference.html#palace.current_context">current_context() (in module palace)</a>
</li>
<li><a href="reference.html#palace.Device.current_hrtf">current_hrtf (palace.Device attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<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.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>
</li>
<li><a href="reference.html#palace.SourceGroup.destroy">(palace.SourceGroup method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
<li><a href="reference.html#palace.device_names">device_names (in module palace)</a>
</li>
<li><a href="reference.html#palace.Source.distance_range">distance_range (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.doppler_factor">doppler_factor (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Device.efx_version">efx_version (palace.Device attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="F">F</h2>
<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.Buffer.frequency">frequency (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.frequency">(palace.Decoder attribute)</a>
</li>
<li><a href="reference.html#palace.Device.frequency">(palace.Device attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.BaseDecoder.frequency">frequency() (palace.BaseDecoder property)</a>
</li>
</ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.gain">gain (palace.Source attribute)</a>
<ul>
<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>
</li>
<li><a href="reference.html#palace.Source.gain_range">gain_range (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.group">group (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
<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.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.Device.hrtf_names">hrtf_names (palace.Device attribute)</a>
</li>
</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>
<li><a href="reference.html#palace.Source.latency">latency (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.latency_seconds">latency_seconds (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Buffer.length">length (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.length">(palace.Decoder attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.BaseDecoder.length">length() (palace.BaseDecoder property)</a>
</li>
<li><a href="reference.html#palace.Buffer.length_seconds">length_seconds (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.length_seconds">(palace.Decoder attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
<ul>
<li><a href="reference.html#palace.Decoder.loop_points">(palace.Decoder attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.BaseDecoder.loop_points">loop_points() (palace.BaseDecoder property)</a>
</li>
<li><a href="reference.html#palace.Source.looping">looping (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
<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.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>
<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.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>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.offset">offset (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.offset_seconds">offset_seconds (palace.Source attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
</ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#module-palace">palace (module)</a>
</li>
<li><a href="reference.html#palace.SourceGroup.parent_group">parent_group (palace.SourceGroup attribute)</a>
</li>
<li><a href="reference.html#palace.Source.pause">pause() (palace.Source method)</a>
</li>
<li><a href="reference.html#palace.SourceGroup.pause_all">pause_all() (palace.SourceGroup method)</a>
</li>
<li><a href="reference.html#palace.Device.pause_dsp">pause_dsp() (palace.Device method)</a>
</li>
<li><a href="reference.html#palace.Source.paused">paused (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.pending">pending (palace.Source attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.pitch">pitch (palace.Source attribute)</a>
<ul>
<li><a href="reference.html#palace.SourceGroup.pitch">(palace.SourceGroup attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.Buffer.play">play() (palace.Buffer method)</a>
<ul>
<li><a href="reference.html#palace.Decoder.play">(palace.Decoder method)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.Source.playing">playing (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.playing_or_pending">playing_or_pending (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.position">position (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.priority">priority (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.query_extension">query_extension() (in module palace)</a>
<ul>
<li><a href="reference.html#palace.Device.query_extension">(palace.Device method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.radius">radius (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.BaseDecoder.read">read (palace.BaseDecoder attribute)</a>
</li>
<li><a href="reference.html#palace.Decoder.read">read() (palace.Decoder method)</a>
</li>
<li><a href="reference.html#palace.Source.relative">relative (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.resampler_index">resampler_index (palace.Source attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Device.reset">reset() (palace.Device method)</a>
</li>
<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>
</li>
<li><a href="reference.html#palace.Device.resume_dsp">resume_dsp() (palace.Device method)</a>
</li>
<li><a href="reference.html#palace.Source.rolloff_factors">rolloff_factors (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
<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.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.Buffer.sample_type">sample_type (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.Decoder.sample_type">(palace.Decoder attribute)</a>
</li>
</ul></li>
<li><a href="reference.html#palace.BaseDecoder.sample_type">sample_type() (palace.BaseDecoder property)</a>
</li>
<li><a href="reference.html#palace.sample_types">sample_types (in module palace)</a>
</li>
<li><a href="reference.html#palace.BaseDecoder.seek">seek (palace.BaseDecoder attribute)</a>
</li>
<li><a href="reference.html#palace.Decoder.seek">seek() (palace.Decoder method)</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">Source (class in palace)</a>
</li>
<li><a href="reference.html#palace.Buffer.source_count">source_count (palace.Buffer attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
</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>
<li><a href="reference.html#palace.Buffer.sources">sources (palace.Buffer attribute)</a>
<ul>
<li><a href="reference.html#palace.SourceGroup.sources">(palace.SourceGroup attribute)</a>
</li>
</ul></li>
<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.Source.stop">stop() (palace.Source method)</a>
</li>
<li><a href="reference.html#palace.SourceGroup.stop_all">stop_all() (palace.SourceGroup method)</a>
</li>
<li><a href="reference.html#palace.SourceGroup.sub_groups">sub_groups (palace.SourceGroup attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Context.update">update() (palace.Context method)</a>
</li>
</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>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference.html#palace.Source.velocity">velocity (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
</div>

Binary file not shown.

View File

@ -4,14 +4,14 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Python Module Index &#8212; palace 0.0.9 documentation</title>
<title>Python Module Index &#8212; palace 0.0.10 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>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script 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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@ -22,7 +22,7 @@
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script type="text/javascript">
<script>
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>
@ -93,7 +93,7 @@
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>
@ -110,7 +110,7 @@
&copy;2019, 2020 Nguyễn Gia Phong & contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</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>

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long