Deploying to gh-pages from @ sclu1034/lua-libpulse-glib@12dd08f13a 🚀
This commit is contained in:
parent
ba76ca2df8
commit
1a065a98d6
5 changed files with 79 additions and 55 deletions
46
index.html
46
index.html
|
@ -18,10 +18,10 @@
|
||||||
</ul>
|
</ul>
|
||||||
<p class="menu-label">Modules</p>
|
<p class="menu-label">Modules</p>
|
||||||
<ul class="menu-list">
|
<ul class="menu-list">
|
||||||
<li><a href="modules/pulseaudio.context.html">pulseaudio.context</a></li>
|
<li><a href="modules/lua_libpulse_glib.context.html">lua_libpulse_glib.context</a></li>
|
||||||
<li><a href="modules/pulseaudio.proplist.html">pulseaudio.proplist</a></li>
|
<li><a href="modules/lua_libpulse_glib.proplist.html">lua_libpulse_glib.proplist</a></li>
|
||||||
<li><a href="modules/pulseaudio.html">pulseaudio</a></li>
|
<li><a href="modules/lua_libpulse_glib.html">lua_libpulse_glib</a></li>
|
||||||
<li><a href="modules/pulseaudio.volume.html">pulseaudio.volume</a></li>
|
<li><a href="modules/lua_libpulse_glib.volume.html">lua_libpulse_glib.volume</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</aside>
|
</aside>
|
||||||
|
@ -31,7 +31,7 @@
|
||||||
<h1 class="title is-1">lua-libpulse-glib</h1>
|
<h1 class="title is-1">lua-libpulse-glib</h1>
|
||||||
<h2 class="subtitle is-3">Lua bindings for PulseAudio’s libpulse, using the GLib Main Loop.</h2>
|
<h2 class="subtitle is-3">Lua bindings for PulseAudio’s libpulse, using the GLib Main Loop.</h2>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<p>While libpulse provides different event loop implementations, these bindings focus on the GLib comaptibility only.
|
<p><p>While libpulse provides different event loop implementations, these bindings focus on the GLib comaptibility only.
|
||||||
Therefore, all asynchronous functions need to be executed inside a running GLib Main Loop.
|
Therefore, all asynchronous functions need to be executed inside a running GLib Main Loop.
|
||||||
For now, this loop has to run on GLib’s default main context. Custom loop contexts are currently not supported.</p>
|
For now, this loop has to run on GLib’s default main context. Custom loop contexts are currently not supported.</p>
|
||||||
|
|
||||||
|
@ -40,8 +40,32 @@ first parameter, usually just the error message as string, or <code>nil</code> w
|
||||||
may either be just a boolean, for operations that don’t return data, or the actual queried data.</p>
|
may either be just a boolean, for operations that don’t return data, or the actual queried data.</p>
|
||||||
|
|
||||||
<p>All numeric indices (such as sink or source indices) are adjusted to be 1-based in typical Lua fashion.
|
<p>All numeric indices (such as sink or source indices) are adjusted to be 1-based in typical Lua fashion.
|
||||||
This means that when comparing the output of calls like <a href="modules/pulseaudio.context.html#Context:get_sinks">Context:get_sinks</a> to the output of tools like <code>pactl</code>,
|
This means that when comparing the output of calls like <a href="modules/lua_libpulse_glib.context.html#Context:get_sinks">Context:get_sinks</a> to the output of tools like <code>pactl</code>,
|
||||||
indices will be off by one.</p>
|
indices will be off by one.</p>
|
||||||
|
|
||||||
|
<pre><code>local lgi = require("lgi")
|
||||||
|
local pulseaudio = require("lua_libpulse_glib")
|
||||||
|
local ppretty = require("pl.pretty")
|
||||||
|
|
||||||
|
local pa = pulseaudio.new()
|
||||||
|
local ctx = pa:context()
|
||||||
|
|
||||||
|
local loop = lgi.GLib.MainLoop.new()
|
||||||
|
|
||||||
|
ctx:connect(nil, function(state)
|
||||||
|
if state == 4 then
|
||||||
|
print("Connection is ready")
|
||||||
|
|
||||||
|
ctx:get_sinks(function(sinks)
|
||||||
|
ppretty.dump(sinks)
|
||||||
|
loop:quit()
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
loop:run()
|
||||||
|
</code></pre>
|
||||||
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
@ -52,19 +76,19 @@ indices will be off by one.</p>
|
||||||
<table class="table is-fullwidth is-striped">
|
<table class="table is-fullwidth is-striped">
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name"><a href="modules/pulseaudio.context.html">pulseaudio.context</a></td>
|
<td class="name"><a href="modules/lua_libpulse_glib.context.html">lua_libpulse_glib.context</a></td>
|
||||||
<td class="summary">Bindings for libpulse’s connection context.</td>
|
<td class="summary">Bindings for libpulse’s connection context.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name"><a href="modules/pulseaudio.proplist.html">pulseaudio.proplist</a></td>
|
<td class="name"><a href="modules/lua_libpulse_glib.proplist.html">lua_libpulse_glib.proplist</a></td>
|
||||||
<td class="summary">Bindings for PulseAudio’s property lists.</td>
|
<td class="summary">Bindings for PulseAudio’s property lists.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name"><a href="modules/pulseaudio.html">pulseaudio</a></td>
|
<td class="name"><a href="modules/lua_libpulse_glib.html">lua_libpulse_glib</a></td>
|
||||||
<td class="summary">Bindings for PulseAudio’s libpulse, using the GLib Main Loop.</td>
|
<td class="summary">Bindings for PulseAudio’s libpulse, using the GLib Main Loop.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name"><a href="modules/pulseaudio.volume.html">pulseaudio.volume</a></td>
|
<td class="name"><a href="modules/lua_libpulse_glib.volume.html">lua_libpulse_glib.volume</a></td>
|
||||||
<td class="summary">Bindings for libpulse’s <code>pa_cvolume</code>.</td>
|
<td class="summary">Bindings for libpulse’s <code>pa_cvolume</code>.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -75,7 +99,7 @@ indices will be off by one.</p>
|
||||||
|
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
<div class="content has-text-centered">
|
<div class="content has-text-centered">
|
||||||
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 20:53:32.
|
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 21:08:52.
|
||||||
</div>
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
|
|
||||||
|
|
|
@ -19,25 +19,25 @@
|
||||||
<p class="menu-label">Modules</p>
|
<p class="menu-label">Modules</p>
|
||||||
<ul class="menu-list">
|
<ul class="menu-list">
|
||||||
<li>
|
<li>
|
||||||
<a class="is-active">pulseaudio.context</a>
|
<a class="is-active">lua_libpulse_glib.context</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#toc">Table of contents</a></li>
|
<li><a href="#toc">Table of contents</a></li>
|
||||||
<li><a href="#Class_Context">Class Context </a></li>
|
<li><a href="#Class_Context">Class Context </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="../modules/pulseaudio.proplist.html">pulseaudio.proplist</a></li>
|
<li><a href="../modules/lua_libpulse_glib.proplist.html">lua_libpulse_glib.proplist</a></li>
|
||||||
<li><a href="../modules/pulseaudio.html">pulseaudio</a></li>
|
<li><a href="../modules/lua_libpulse_glib.html">lua_libpulse_glib</a></li>
|
||||||
<li><a href="../modules/pulseaudio.volume.html">pulseaudio.volume</a></li>
|
<li><a href="../modules/lua_libpulse_glib.volume.html">lua_libpulse_glib.volume</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</aside>
|
</aside>
|
||||||
<div id="content" class="content__wrapper">
|
<div id="content" class="content__wrapper">
|
||||||
<section class="section section__module-description">
|
<section class="section section__module-description">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<h1 class="title is-1">Module <em>pulseaudio.context</em></h1>
|
<h1 class="title is-1">Module <em>lua_libpulse_glib.context</em></h1>
|
||||||
<h3 class="subtitle is-3">Bindings for libpulse’s connection context.</h3>
|
<h3 class="subtitle is-3">Bindings for libpulse’s connection context.</h3>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<p> The connection <a href="../modules/pulseaudio.context.html#Context">Context</a> provides introspection calls to query state from the server and various commands to
|
<p> The connection <a href="../modules/lua_libpulse_glib.context.html#Context">Context</a> provides introspection calls to query state from the server and various commands to
|
||||||
change this state.</p>
|
change this state.</p>
|
||||||
|
|
||||||
<p> In many cases, sinks and sources may be addressed by either their name or their numeric index.
|
<p> In many cases, sinks and sources may be addressed by either their name or their numeric index.
|
||||||
|
@ -401,7 +401,7 @@
|
||||||
|
|
||||||
<div class="block content section__item__description">Gets information about all sinks. </p>
|
<div class="block content section__item__description">Gets information about all sinks. </p>
|
||||||
|
|
||||||
<p> This returns the same information as <a href="../modules/pulseaudio.context.html#Context:get_sink_info">Context:get_sink_info</a> would have returned for every sink
|
<p> This returns the same information as <a href="../modules/lua_libpulse_glib.context.html#Context:get_sink_info">Context:get_sink_info</a> would have returned for every sink
|
||||||
that’s currently registered at the server.</p>
|
that’s currently registered at the server.</p>
|
||||||
|
|
||||||
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__sink__info.html">pa_sink_info</a>
|
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__sink__info.html">pa_sink_info</a>
|
||||||
|
@ -778,7 +778,7 @@
|
||||||
|
|
||||||
<div class="block content section__item__description">Gets information about all sink inputs. </p>
|
<div class="block content section__item__description">Gets information about all sink inputs. </p>
|
||||||
|
|
||||||
<p> This returns the same information as <a href="../modules/pulseaudio.context.html#Context:get_sink_input_info">Context:get_sink_input_info</a> would have returned for every sink input
|
<p> This returns the same information as <a href="../modules/lua_libpulse_glib.context.html#Context:get_sink_input_info">Context:get_sink_input_info</a> would have returned for every sink input
|
||||||
that’s currently registered at the server.</p>
|
that’s currently registered at the server.</p>
|
||||||
|
|
||||||
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__sink_input__info.html">pa_sink_input_info</a>
|
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__sink_input__info.html">pa_sink_input_info</a>
|
||||||
|
@ -1219,7 +1219,7 @@
|
||||||
|
|
||||||
<div class="block content section__item__description">Gets information about all sources. </p>
|
<div class="block content section__item__description">Gets information about all sources. </p>
|
||||||
|
|
||||||
<p> This returns the same information as <a href="../modules/pulseaudio.context.html#Context:get_source_info">Context:get_source_info</a> would have returned for every source
|
<p> This returns the same information as <a href="../modules/lua_libpulse_glib.context.html#Context:get_source_info">Context:get_source_info</a> would have returned for every source
|
||||||
that’s currently registered at the server.</p>
|
that’s currently registered at the server.</p>
|
||||||
|
|
||||||
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__source__info.html">pa_source_info</a>
|
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__source__info.html">pa_source_info</a>
|
||||||
|
@ -1594,7 +1594,7 @@
|
||||||
|
|
||||||
<div class="block content section__item__description">Gets information about all source outputs. </p>
|
<div class="block content section__item__description">Gets information about all source outputs. </p>
|
||||||
|
|
||||||
<p> This returns the same information as <a href="../modules/pulseaudio.context.html#Context:get_source_output_info">Context:get_source_output_info</a> would have returned for every source output
|
<p> This returns the same information as <a href="../modules/lua_libpulse_glib.context.html#Context:get_source_output_info">Context:get_source_output_info</a> would have returned for every source output
|
||||||
that’s currently registered at the server.</p>
|
that’s currently registered at the server.</p>
|
||||||
|
|
||||||
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__source_output__info.html">pa_source_output_info</a>
|
<p> See <a href="https://freedesktop.org/software/pulseaudio/doxygen/structpa__source_output__info.html">pa_source_output_info</a>
|
||||||
|
@ -1962,7 +1962,7 @@
|
||||||
|
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
<div class="content has-text-centered">
|
<div class="content has-text-centered">
|
||||||
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 20:53:32.
|
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 21:08:52.
|
||||||
</div>
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
|
|
|
@ -18,24 +18,24 @@
|
||||||
</ul>
|
</ul>
|
||||||
<p class="menu-label">Modules</p>
|
<p class="menu-label">Modules</p>
|
||||||
<ul class="menu-list">
|
<ul class="menu-list">
|
||||||
<li><a href="../modules/pulseaudio.context.html">pulseaudio.context</a></li>
|
<li><a href="../modules/lua_libpulse_glib.context.html">lua_libpulse_glib.context</a></li>
|
||||||
<li><a href="../modules/pulseaudio.proplist.html">pulseaudio.proplist</a></li>
|
<li><a href="../modules/lua_libpulse_glib.proplist.html">lua_libpulse_glib.proplist</a></li>
|
||||||
<li>
|
<li>
|
||||||
<a class="is-active">pulseaudio</a>
|
<a class="is-active">lua_libpulse_glib</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#toc">Table of contents</a></li>
|
<li><a href="#toc">Table of contents</a></li>
|
||||||
<li><a href="#Functions">Functions</a></li>
|
<li><a href="#Functions">Functions</a></li>
|
||||||
<li><a href="#Class_PulseAudio">Class PulseAudio </a></li>
|
<li><a href="#Class_PulseAudio">Class PulseAudio </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="../modules/pulseaudio.volume.html">pulseaudio.volume</a></li>
|
<li><a href="../modules/lua_libpulse_glib.volume.html">lua_libpulse_glib.volume</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</aside>
|
</aside>
|
||||||
<div id="content" class="content__wrapper">
|
<div id="content" class="content__wrapper">
|
||||||
<section class="section section__module-description">
|
<section class="section section__module-description">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<h1 class="title is-1">Module <em>pulseaudio</em></h1>
|
<h1 class="title is-1">Module <em>lua_libpulse_glib</em></h1>
|
||||||
<h3 class="subtitle is-3">Bindings for PulseAudio’s libpulse, using the GLib Main Loop.</h3>
|
<h3 class="subtitle is-3">Bindings for PulseAudio’s libpulse, using the GLib Main Loop.</h3>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<p>
|
<p>
|
||||||
|
@ -86,7 +86,7 @@
|
||||||
<div class="control">
|
<div class="control">
|
||||||
<div class="tags has-addons">
|
<div class="tags has-addons">
|
||||||
<span class="tag is-dark">type</span>
|
<span class="tag is-dark">type</span>
|
||||||
<span class="tag return-value__type"><span><a class="type" href="../modules/pulseaudio.html#PulseAudio">PulseAudio</a></span></span>
|
<span class="tag return-value__type"><span><a class="type" href="../modules/lua_libpulse_glib.html#PulseAudio">PulseAudio</a></span></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -154,7 +154,7 @@
|
||||||
|
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
<div class="content has-text-centered">
|
<div class="content has-text-centered">
|
||||||
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 20:53:32.
|
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 21:08:52.
|
||||||
</div>
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
|
|
|
@ -18,9 +18,9 @@
|
||||||
</ul>
|
</ul>
|
||||||
<p class="menu-label">Modules</p>
|
<p class="menu-label">Modules</p>
|
||||||
<ul class="menu-list">
|
<ul class="menu-list">
|
||||||
<li><a href="../modules/pulseaudio.context.html">pulseaudio.context</a></li>
|
<li><a href="../modules/lua_libpulse_glib.context.html">lua_libpulse_glib.context</a></li>
|
||||||
<li>
|
<li>
|
||||||
<a class="is-active">pulseaudio.proplist</a>
|
<a class="is-active">lua_libpulse_glib.proplist</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#toc">Table of contents</a></li>
|
<li><a href="#toc">Table of contents</a></li>
|
||||||
<li><a href="#Tables">Tables</a></li>
|
<li><a href="#Tables">Tables</a></li>
|
||||||
|
@ -29,15 +29,15 @@
|
||||||
<li><a href="#Class_PropList">Class PropList </a></li>
|
<li><a href="#Class_PropList">Class PropList </a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="../modules/pulseaudio.html">pulseaudio</a></li>
|
<li><a href="../modules/lua_libpulse_glib.html">lua_libpulse_glib</a></li>
|
||||||
<li><a href="../modules/pulseaudio.volume.html">pulseaudio.volume</a></li>
|
<li><a href="../modules/lua_libpulse_glib.volume.html">lua_libpulse_glib.volume</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</aside>
|
</aside>
|
||||||
<div id="content" class="content__wrapper">
|
<div id="content" class="content__wrapper">
|
||||||
<section class="section section__module-description">
|
<section class="section section__module-description">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<h1 class="title is-1">Module <em>pulseaudio.proplist</em></h1>
|
<h1 class="title is-1">Module <em>lua_libpulse_glib.proplist</em></h1>
|
||||||
<h3 class="subtitle is-3">Bindings for PulseAudio’s property lists.</h3>
|
<h3 class="subtitle is-3">Bindings for PulseAudio’s property lists.</h3>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<p> Basic operations are mapped to Lua table operations:</p>
|
<p> Basic operations are mapped to Lua table operations:</p>
|
||||||
|
@ -76,7 +76,7 @@
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name"><a href="#from_string">from_string(str)</a></td>
|
<td class="name"><a href="#from_string">from_string(str)</a></td>
|
||||||
<td class="summary">Parses a string into a <a href="../modules/pulseaudio.proplist.html#PropList">PropList</a>.</td>
|
<td class="summary">Parses a string into a <a href="../modules/lua_libpulse_glib.proplist.html#PropList">PropList</a>.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
@ -791,7 +791,7 @@
|
||||||
<div class="control">
|
<div class="control">
|
||||||
<div class="tags has-addons">
|
<div class="tags has-addons">
|
||||||
<span class="tag is-dark">type</span>
|
<span class="tag is-dark">type</span>
|
||||||
<span class="tag return-value__type"><span><a class="type" href="../modules/pulseaudio.proplist.html#PropList">PropList</a></span></span>
|
<span class="tag return-value__type"><span><a class="type" href="../modules/lua_libpulse_glib.proplist.html#PropList">PropList</a></span></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -804,7 +804,7 @@
|
||||||
<strong>from_string(str)</strong>
|
<strong>from_string(str)</strong>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="block content section__item__description">Parses a string into a <a href="../modules/pulseaudio.proplist.html#PropList">PropList</a>.</div>
|
<div class="block content section__item__description">Parses a string into a <a href="../modules/lua_libpulse_glib.proplist.html#PropList">PropList</a>.</div>
|
||||||
|
|
||||||
<div class="block content section__item__params">
|
<div class="block content section__item__params">
|
||||||
<h4 class="title is-6">Parameters:</h4>
|
<h4 class="title is-6">Parameters:</h4>
|
||||||
|
@ -834,7 +834,7 @@
|
||||||
<div class="control">
|
<div class="control">
|
||||||
<div class="tags has-addons">
|
<div class="tags has-addons">
|
||||||
<span class="tag is-dark">type</span>
|
<span class="tag is-dark">type</span>
|
||||||
<span class="tag return-value__type"><span><a class="type" href="../modules/pulseaudio.proplist.html#PropList">PropList</a></span></span>
|
<span class="tag return-value__type"><span><a class="type" href="../modules/lua_libpulse_glib.proplist.html#PropList">PropList</a></span></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -1014,7 +1014,7 @@
|
||||||
<div class="control">
|
<div class="control">
|
||||||
<div class="tags has-addons">
|
<div class="tags has-addons">
|
||||||
<span class="tag is-dark">type</span>
|
<span class="tag is-dark">type</span>
|
||||||
<span class="tag return-value__type"><span><a class="type" href="../modules/pulseaudio.proplist.html#pulseaudio.proplist">proplist</a></span></span>
|
<span class="tag return-value__type"><span><a class="type" href="../modules/lua_libpulse_glib.proplist.html#pulseaudio.proplist">proplist</a></span></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -1029,7 +1029,7 @@
|
||||||
|
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
<div class="content has-text-centered">
|
<div class="content has-text-centered">
|
||||||
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 20:53:32.
|
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 21:08:52.
|
||||||
</div>
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
|
|
|
@ -18,11 +18,11 @@
|
||||||
</ul>
|
</ul>
|
||||||
<p class="menu-label">Modules</p>
|
<p class="menu-label">Modules</p>
|
||||||
<ul class="menu-list">
|
<ul class="menu-list">
|
||||||
<li><a href="../modules/pulseaudio.context.html">pulseaudio.context</a></li>
|
<li><a href="../modules/lua_libpulse_glib.context.html">lua_libpulse_glib.context</a></li>
|
||||||
<li><a href="../modules/pulseaudio.proplist.html">pulseaudio.proplist</a></li>
|
<li><a href="../modules/lua_libpulse_glib.proplist.html">lua_libpulse_glib.proplist</a></li>
|
||||||
<li><a href="../modules/pulseaudio.html">pulseaudio</a></li>
|
<li><a href="../modules/lua_libpulse_glib.html">lua_libpulse_glib</a></li>
|
||||||
<li>
|
<li>
|
||||||
<a class="is-active">pulseaudio.volume</a>
|
<a class="is-active">lua_libpulse_glib.volume</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#toc">Table of contents</a></li>
|
<li><a href="#toc">Table of contents</a></li>
|
||||||
<li><a href="#Static_Functions">Static Functions </a></li>
|
<li><a href="#Static_Functions">Static Functions </a></li>
|
||||||
|
@ -35,10 +35,10 @@
|
||||||
<div id="content" class="content__wrapper">
|
<div id="content" class="content__wrapper">
|
||||||
<section class="section section__module-description">
|
<section class="section section__module-description">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<h1 class="title is-1">Module <em>pulseaudio.volume</em></h1>
|
<h1 class="title is-1">Module <em>lua_libpulse_glib.volume</em></h1>
|
||||||
<h3 class="subtitle is-3">Bindings for libpulse’s <code>pa_cvolume</code>.</h3>
|
<h3 class="subtitle is-3">Bindings for libpulse’s <code>pa_cvolume</code>.</h3>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<p> Contrary to libpulse, methods that change the a <a href="../modules/pulseaudio.volume.html#Volume">Volume</a> object generally don’t return anything, but
|
<p> Contrary to libpulse, methods that change the a <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a> object generally don’t return anything, but
|
||||||
instead change the instance itself.</p>
|
instead change the instance itself.</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -51,7 +51,7 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name"><a href="#is_valid">is_valid(value)</a></td>
|
<td class="name"><a href="#is_valid">is_valid(value)</a></td>
|
||||||
<td class="summary">Checks whether a value is a valid <a href="../modules/pulseaudio.volume.html#Volume">Volume</a>.</td>
|
<td class="summary">Checks whether a value is a valid <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a>.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
@ -136,7 +136,7 @@
|
||||||
<strong>is_valid(value)</strong>
|
<strong>is_valid(value)</strong>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="block content section__item__description">Checks whether a value is a valid <a href="../modules/pulseaudio.volume.html#Volume">Volume</a>.</div>
|
<div class="block content section__item__description">Checks whether a value is a valid <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a>.</div>
|
||||||
|
|
||||||
<div class="block content section__item__params">
|
<div class="block content section__item__params">
|
||||||
<h4 class="title is-6">Parameters:</h4>
|
<h4 class="title is-6">Parameters:</h4>
|
||||||
|
@ -288,9 +288,9 @@
|
||||||
<div class="block content section__item__description">Divides the volume by the given value. </p>
|
<div class="block content section__item__description">Divides the volume by the given value. </p>
|
||||||
|
|
||||||
<p> The value to divide by may either be a scalar, that’s applied to all channels,
|
<p> The value to divide by may either be a scalar, that’s applied to all channels,
|
||||||
or another instance of <a href="../modules/pulseaudio.volume.html#Volume">Volume</a>, which would be applied channel by channel.</p>
|
or another instance of <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a>, which would be applied channel by channel.</p>
|
||||||
|
|
||||||
<p> It is possible to divide a <a href="../modules/pulseaudio.volume.html#Volume">Volume</a> by itself.</p>
|
<p> It is possible to divide a <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a> by itself.</p>
|
||||||
|
|
||||||
<p> This is only valid for software volumes.</div>
|
<p> This is only valid for software volumes.</div>
|
||||||
|
|
||||||
|
@ -306,7 +306,7 @@
|
||||||
<div class="control">
|
<div class="control">
|
||||||
<div class="tags has-addons">
|
<div class="tags has-addons">
|
||||||
<span class="tag is-dark">type</span>
|
<span class="tag is-dark">type</span>
|
||||||
<span class="tag parameter__type"><span><span class="type">number</span> or <a class="type" href="../modules/pulseaudio.volume.html#Volume">Volume</a></span></span>
|
<span class="tag parameter__type"><span><span class="type">number</span> or <a class="type" href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a></span></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -491,9 +491,9 @@
|
||||||
<div class="block content section__item__description">Multiplies the volume by the given amount. </p>
|
<div class="block content section__item__description">Multiplies the volume by the given amount. </p>
|
||||||
|
|
||||||
<p> The value to multiply with may either be a scalar, that’s applied to all channels,
|
<p> The value to multiply with may either be a scalar, that’s applied to all channels,
|
||||||
or another instance of <a href="../modules/pulseaudio.volume.html#Volume">Volume</a>, which would be applied channel by channel.</p>
|
or another instance of <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a>, which would be applied channel by channel.</p>
|
||||||
|
|
||||||
<p> It is possible to multiply a <a href="../modules/pulseaudio.volume.html#Volume">Volume</a> by itself.</p>
|
<p> It is possible to multiply a <a href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a> by itself.</p>
|
||||||
|
|
||||||
<p> This is only valid for software volumes.</div>
|
<p> This is only valid for software volumes.</div>
|
||||||
|
|
||||||
|
@ -508,7 +508,7 @@
|
||||||
<div class="control">
|
<div class="control">
|
||||||
<div class="tags has-addons">
|
<div class="tags has-addons">
|
||||||
<span class="tag is-dark">type</span>
|
<span class="tag is-dark">type</span>
|
||||||
<span class="tag parameter__type"><span><span class="type">number</span> or <a class="type" href="../modules/pulseaudio.volume.html#Volume">Volume</a></span></span>
|
<span class="tag parameter__type"><span><span class="type">number</span> or <a class="type" href="../modules/lua_libpulse_glib.volume.html#Volume">Volume</a></span></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -655,7 +655,7 @@
|
||||||
|
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
<div class="content has-text-centered">
|
<div class="content has-text-centered">
|
||||||
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 20:53:32.
|
Generated by <a href="https://github/com/stevendonovan/LDoc">LDoc 1.4.6</a>, designed with <a href="https://github.com/jgthms/bulma">Bulma</a>. Last updated at 2022-05-15 21:08:52.
|
||||||
</div>
|
</div>
|
||||||
</footer>
|
</footer>
|
||||||
|
|
Loading…
Add table
Reference in a new issue