dany/clapper
1
0
Fork 0
mirror of https://github.com/Rafostar/clapper.git synced 2025-08-31 00:11:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update Clapper API reference

Browse Source
This commit is contained in:
Rafał Dzięgiel
2024-01-21 20:50:31 +01:00
parent 5c1a07f062
commit 28fd45a300
196 changed files with 17729 additions and 772 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/clapper/clapper.devhelp2
View File

File diff suppressed because one or more lines are too long

2
doc/clapper/clapper.toml
View File

@@ -31,7 +31,7 @@ dependencies = ["GLib-2.0", "GObject-2.0", "Gio-2.0", "Gst-1.0"]
[dependencies."Gst-1.0"]
name = "Gst"
description = "GStreamer core library"
docs_url = "https://gstreamer.freedesktop.org/documentation/"
docs_url = "https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html"
[dependencies."GstBase-1.0"]
name = "GstBase"

183
doc/clapper/class.Discoverer.html
View File

@@ -85,6 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
@@ -96,29 +97,47 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Discoverer.discover_item.html">discover_item</a>
<a class="method" href="method.Discoverer.get_discovery_mode.html">get_discovery_mode</a>
<a class="method" href="method.Discoverer.set_discovery_mode.html">set_discovery_mode</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Discoverer.discovery-mode.html">discovery-mode</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -142,26 +161,29 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-discoverer.h#L36">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.Discoverer : Gst.Object {
<pre><code>final class Clapper.Discoverer : Clapper.Feature
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Clapper media scanner used to discover media item&nbsp;info.</p>
<p>Once media is scanned, all extra information of it will be filled
within media item, this includes title, duration, chapters,&nbsp;etc.</p>
<p>For performance reasons, <code>ClapperDiscoverer</code> will create a thread pool
with an optimal number of threads for current hardware it is run in.
All discovery is then done asynchronously using said threads and queued
for discovery later if all threads are currently&nbsp;occupied.</p>
<p>An optional Discoverer feature to be added to the&nbsp;player.</p>
<p><code>ClapperDiscoverer</code> is a feature that wraps around <code>GstDiscoverer</code> <span class="caps">API</span>
to automatically discover items within <a href="class.Queue.html"><code>ClapperQueue</code></a>. Once media
is scanned, all extra information of it will be filled within media item,
this includes title, duration, chapters,&nbsp;etc.</p>
<p>Please note that media items are also discovered during their playback
from the player itself. Discoverer is useful in situations where one
wants to present to the user an updated media item before playback,
thus mainly to be applied into e.g. an <span class="caps">UI</span> with playback&nbsp;queue.</p>
by the player itself. <code>ClapperDiscoverer</code> is useful in situations where
one wants to present to the user an updated media item before its
playback, such as an <span class="caps">UI</span> that displays playback&nbsp;queue.</p>
<p>Depending on your applicatation, you can select an optimal
<a href="enum.DiscovererDiscoveryMode.html"><code>ClapperDiscovererDiscoveryMode</code></a> that best suits your&nbsp;needs.</p>
<p>Use <a href="const.HAVE_DISCOVERER.html"><code>CLAPPER_HAVE_DISCOVERER</code></a> macro to check if Clapper <span class="caps">API</span>
was compiled with this&nbsp;feature.</p>
</div>
<div class="docblock">
@@ -175,6 +197,93 @@ thus mainly to be applied into e.g. an <span class="caps">UI</span> with playbac
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Discoverer">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="332pt"
viewBox="0.00 0.00 130.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperDiscoverer">
<path fill="none" stroke="black" d="M108.5,-36C108.5,-36 13.5,-36 13.5,-36 7.5,-36 1.5,-30 1.5,-24 1.5,-24 1.5,-12 1.5,-12 1.5,-6 7.5,0 13.5,0 13.5,0 108.5,0 108.5,0 114.5,0 120.5,-6 120.5,-12 120.5,-12 120.5,-24 120.5,-24 120.5,-30 114.5,-36 108.5,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperDiscoverer</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Feature.html" xlink:title="ClapperFeature">
<path fill="none" stroke="black" d="M99,-108C99,-108 23,-108 23,-108 17,-108 11,-102 11,-96 11,-96 11,-84 11,-84 11,-78 17,-72 23,-72 23,-72 99,-72 99,-72 105,-72 111,-78 111,-84 111,-84 111,-96 111,-96 111,-102 105,-108 99,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperFeature</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge4" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-180C84.5,-180 37.5,-180 37.5,-180 31.5,-180 25.5,-174 25.5,-168 25.5,-168 25.5,-156 25.5,-156 25.5,-150 31.5,-144 37.5,-144 37.5,-144 84.5,-144 84.5,-144 90.5,-144 96.5,-150 96.5,-156 96.5,-156 96.5,-168 96.5,-168 96.5,-174 90.5,-180 84.5,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge3" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-252C110,-252 12,-252 12,-252 6,-252 0,-246 0,-240 0,-240 0,-228 0,-228 0,-222 6,-216 12,-216 12,-216 110,-216 110,-216 116,-216 122,-222 122,-228 122,-228 122,-240 122,-240 122,-246 116,-252 110,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge2" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
<!-- ancestor_3 -->
<g id="node5" class="node">
<title>ancestor_3</title>
<g id="a_node5"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-324C80,-324 42,-324 42,-324 36,-324 30,-318 30,-312 30,-312 30,-300 30,-300 30,-294 36,-288 42,-288 42,-288 80,-288 80,-288 86,-288 92,-294 92,-300 92,-300 92,-312 92,-312 92,-318 86,-324 80,-324"/>
<text text-anchor="middle" x="61" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge1" class="edge">
<title>ancestor_3&#45;&#45;ancestor_2</title>
<path fill="none" stroke="black" d="M61,-287.7C61,-276.85 61,-262.92 61,-252.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -187,6 +296,10 @@ thus mainly to be applied into e.g. an <span class="caps">UI</span> with playbac
<ul>
<li class="class"><a href="class.Feature.html" title="Feature">ClapperFeature</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a></li>
@@ -242,9 +355,19 @@ thus mainly to be applied into e.g. an <span class="caps">UI</span> with playbac
<div class="docblock">
<div class="">
<h6><a href="method.Discoverer.discover_item.html">clapper_discoverer_discover_item</a></h6>
<h6><a href="method.Discoverer.get_discovery_mode.html">clapper_discoverer_get_discovery_mode</a></h6>
<div class="docblock">
<p>Queues media item for&nbsp;discovery.</p>
<p>Get the <code>ClapperDiscovererDiscoveryMode</code> of <code>discoverer</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Discoverer.set_discovery_mode.html">clapper_discoverer_set_discovery_mode</a></h6>
<div class="docblock">
<p>Set the <code>ClapperDiscovererDiscoveryMode</code> of <code>discoverer</code>.</p>
</div>
<div class="docblock">
<p></p>
@@ -255,6 +378,8 @@ thus mainly to be applied into e.g. an <span class="caps">UI</span> with playbac
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (25)</h5>
<div class="docblock">
@@ -293,9 +418,25 @@ thus mainly to be applied into e.g. an <span class="caps">UI</span> with playbac
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.Discoverer.discovery-mode.html">Clapper.Discoverer:discovery-mode</a></h6>
<div class="docblock">
<p>Discoverer discovery&nbsp;mode.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties"><h5 style="display:block;">Properties inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (2)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.name.html">Gst.Object:name</a></h6>
@@ -342,6 +483,8 @@ achieve a similar&nbsp;effect.</p>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="signal.Object.deep-notify.html">GstObject::deep-notify</a></h6>
@@ -391,7 +534,7 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<div class="docblock">
<pre><code>struct ClapperDiscovererClass {
GstObjectClass parent_class;
ClapperFeatureClass parent_class;
}</code></pre>
</div>
@@ -406,7 +549,7 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<dl class="members">
<dt><code>parent_class: GstObjectClass</code></dt>
<dt><code>parent_class: ClapperFeatureClass</code></dt>
<dd>No description available.</dd>
</dd>
@@ -431,6 +574,8 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
@@ -446,6 +591,8 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>

198
doc/clapper/class.Feature.html
View File

@@ -85,38 +85,49 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Virtual methods</h5>
<div class="links">
<a class="method" href="vfunc.Feature.current_media_item_changed.html">current_media_item_changed</a>
<a class="method" href="vfunc.Feature.media_item_updated.html">media_item_updated</a>
<a class="method" href="vfunc.Feature.item_updated.html">item_updated</a>
<a class="method" href="vfunc.Feature.mute_changed.html">mute_changed</a>
<a class="method" href="vfunc.Feature.played_item_changed.html">played_item_changed</a>
<a class="method" href="vfunc.Feature.position_changed.html">position_changed</a>
<a class="method" href="vfunc.Feature.prepare.html">prepare</a>
<a class="method" href="vfunc.Feature.property_changed.html">property_changed</a>
<a class="method" href="vfunc.Feature.queue_cleared.html">queue_cleared</a>
<a class="method" href="vfunc.Feature.queue_item_added.html">queue_item_added</a>
<a class="method" href="vfunc.Feature.queue_item_removed.html">queue_item_removed</a>
<a class="method" href="vfunc.Feature.queue_item_repositioned.html">queue_item_repositioned</a>
<a class="method" href="vfunc.Feature.queue_progression_changed.html">queue_progression_changed</a>
<a class="method" href="vfunc.Feature.speed_changed.html">speed_changed</a>
@@ -132,8 +143,9 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -157,23 +169,24 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-feature.h#L38">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-feature.c#L20">[src]</a>
</h4>
<pre><code>class Clapper.Feature : Gst.Object {
parent_instance: GstObject
<pre><code>class Clapper.Feature : Gst.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents an additional&nbsp;feature.</p>
<p>A base class for creating new features for the&nbsp;player.</p>
<p>Feature objects are meant for adding additional functionalities that
are supposed to either act on playback/properties changes and/or change
them themselves due to some external&nbsp;signal/event.</p>
<p>For reacting to playback changes subclass should override this class
virtual functions logic, while for controlling playback implementation
may call <code>gst_object_get_parent()</code> to acquire a weak reference on a parent
player object feature was added&nbsp;to.</p>
may call <a href="javascript:void(0)" data-namespace="Gst" data-link="method.Object.get_parent.html" class="external"><code>gst_object_get_parent()</code></a> to acquire a weak reference on
a parent <a href="class.Player.html"><code>ClapperPlayer</code></a> object feature was added&nbsp;to.</p>
</div>
<div class="docblock">
@@ -187,6 +200,79 @@ player object feature was added&nbsp;to.</p>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Feature">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="260pt"
viewBox="0.00 0.00 130.00 260.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperFeature">
<path fill="none" stroke="black" d="M99,-36C99,-36 23,-36 23,-36 17,-36 11,-30 11,-24 11,-24 11,-12 11,-12 11,-6 17,0 23,0 23,0 99,0 99,0 105,0 111,-6 111,-12 111,-12 111,-24 111,-24 111,-30 105,-36 99,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperFeature</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-108C84.5,-108 37.5,-108 37.5,-108 31.5,-108 25.5,-102 25.5,-96 25.5,-96 25.5,-84 25.5,-84 25.5,-78 31.5,-72 37.5,-72 37.5,-72 84.5,-72 84.5,-72 90.5,-72 96.5,-78 96.5,-84 96.5,-84 96.5,-96 96.5,-96 96.5,-102 90.5,-108 84.5,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-180C110,-180 12,-180 12,-180 6,-180 0,-174 0,-168 0,-168 0,-156 0,-156 0,-150 6,-144 12,-144 12,-144 110,-144 110,-144 116,-144 122,-150 122,-156 122,-156 122,-168 122,-168 122,-174 116,-180 110,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-252C80,-252 42,-252 42,-252 36,-252 30,-246 30,-240 30,-240 30,-228 30,-228 30,-222 36,-216 42,-216 42,-216 80,-216 80,-216 86,-216 92,-222 92,-228 92,-228 92,-240 92,-240 92,-246 86,-252 80,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -220,7 +306,11 @@ player object feature was added&nbsp;to.</p>
<h4 id="descendants">Descendants <a href="#descendants" class="anchor"></a></h4>
<div class="docblock">
<ul>
<li class="class"><a href="class.Discoverer.html" title="Discoverer">ClapperDiscoverer</a></li>
<li class="class"><a href="class.Mpris.html" title="Mpris">ClapperMpris</a></li>
<li class="class"><a href="class.Server.html" title="Server">ClapperServer</a></li>
</ul>
</div>
</div>
@@ -388,6 +478,10 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
gboolean (* unprepare) (
ClapperFeature* feature
);
void (* property_changed) (
ClapperFeature* feature,
GParamSpec* pspec
);
void (* state_changed) (
ClapperFeature* feature,
ClapperPlayerState state
@@ -408,11 +502,11 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
ClapperFeature* feature,
gboolean mute
);
void (* current_media_item_changed) (
void (* played_item_changed) (
ClapperFeature* feature,
ClapperMediaItem* current_item
ClapperMediaItem* item
);
void (* media_item_updated) (
void (* item_updated) (
ClapperFeature* feature,
ClapperMediaItem* item
);
@@ -423,7 +517,13 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
);
void (* queue_item_removed) (
ClapperFeature* feature,
ClapperMediaItem* item
ClapperMediaItem* item,
guint index
);
void (* queue_item_repositioned) (
ClapperFeature* feature,
guint before,
guint after
);
void (* queue_cleared) (
ClapperFeature* feature
@@ -459,6 +559,12 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
)</code></dt>
<dd>No description available.</dd>
<dt><code>property_changed: void (* property_changed) (
ClapperFeature* feature,
GParamSpec* pspec
)</code></dt>
<dd>No description available.</dd>
<dt><code>state_changed: void (* state_changed) (
ClapperFeature* feature,
ClapperPlayerState state
@@ -489,13 +595,13 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
)</code></dt>
<dd>No description available.</dd>
<dt><code>current_media_item_changed: void (* current_media_item_changed) (
<dt><code>played_item_changed: void (* played_item_changed) (
ClapperFeature* feature,
ClapperMediaItem* current_item
ClapperMediaItem* item
)</code></dt>
<dd>No description available.</dd>
<dt><code>media_item_updated: void (* media_item_updated) (
<dt><code>item_updated: void (* item_updated) (
ClapperFeature* feature,
ClapperMediaItem* item
)</code></dt>
@@ -510,7 +616,15 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<dt><code>queue_item_removed: void (* queue_item_removed) (
ClapperFeature* feature,
ClapperMediaItem* item
ClapperMediaItem* item,
guint index
)</code></dt>
<dd>No description available.</dd>
<dt><code>queue_item_repositioned: void (* queue_item_repositioned) (
ClapperFeature* feature,
guint before,
guint after
)</code></dt>
<dd>No description available.</dd>
@@ -541,18 +655,7 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<div class="docblock">
<div class="">
<h6 id="vfunc-current_media_item_changed"><a href="vfunc.Feature.current_media_item_changed.html">Clapper.FeatureClass.current_media_item_changed</a></h6>
<div class="docblock">
<p>Currently playing media item got changed.
Item will be <code>NULL</code> if no new item was&nbsp;selected.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6 id="vfunc-media_item_updated"><a href="vfunc.Feature.media_item_updated.html">Clapper.FeatureClass.media_item_updated</a></h6>
<h6 id="vfunc-item_updated"><a href="vfunc.Feature.item_updated.html">Clapper.FeatureClass.item_updated</a></h6>
<div class="docblock">
<p>An item in queue got updated. This might be (or not) currently
played item. Implementations can get parent player object
@@ -573,6 +676,17 @@ if they want to check that from its&nbsp;queue.</p>
</div>
</div>
<div class="">
<h6 id="vfunc-played_item_changed"><a href="vfunc.Feature.played_item_changed.html">Clapper.FeatureClass.played_item_changed</a></h6>
<div class="docblock">
<p>New media item started playing. All following events (such as position changes)
will be related to this <code>item</code> from now&nbsp;on.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6 id="vfunc-position_changed"><a href="vfunc.Feature.position_changed.html">Clapper.FeatureClass.position_changed</a></h6>
<div class="docblock">
@@ -593,6 +707,16 @@ if they want to check that from its&nbsp;queue.</p>
</div>
</div>
<div class="">
<h6 id="vfunc-property_changed"><a href="vfunc.Feature.property_changed.html">Clapper.FeatureClass.property_changed</a></h6>
<div class="docblock">
<p>A property of <code>feature</code> changed its&nbsp;value.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6 id="vfunc-queue_cleared"><a href="vfunc.Feature.queue_cleared.html">Clapper.FeatureClass.queue_cleared</a></h6>
<div class="docblock">
@@ -625,10 +749,20 @@ You probably want to implement this function if you also implemented item&nbsp;r
</div>
</div>
<div class="">
<h6 id="vfunc-queue_item_repositioned"><a href="vfunc.Feature.queue_item_repositioned.html">Clapper.FeatureClass.queue_item_repositioned</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6 id="vfunc-queue_progression_changed"><a href="vfunc.Feature.queue_progression_changed.html">Clapper.FeatureClass.queue_progression_changed</a></h6>
<div class="docblock">
<p><code>ClapperQueueProgressionMode</code> of the queue was&nbsp;changed.</p>
<p>Progression mode of the queue was&nbsp;changed.</p>
</div>
<div class="docblock">
<p></p>
@@ -693,6 +827,8 @@ You probably want to implement this function if you also implemented item&nbsp;r
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>

164
doc/clapper/class.MediaItem.html
View File

@@ -85,6 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
@@ -100,58 +101,73 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.MediaItem.audio-streams.html">audio-streams</a>
<a class="property" href="property.MediaItem.container-format.html">container-format</a>
<a class="property" href="property.MediaItem.duration.html">duration</a>
<a class="property" href="property.MediaItem.suburis.html">suburis</a>
<a class="property" href="property.MediaItem.id.html">id</a>
<a class="property" href="property.MediaItem.subtitle-streams.html">subtitle-streams</a>
<a class="property" href="property.MediaItem.title.html">title</a>
<a class="property" href="property.MediaItem.uri.html">uri</a>
<a class="property" href="property.MediaItem.video-streams.html">video-streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -175,16 +191,19 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L36">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.MediaItem : Gst.Object {
<pre><code>final class Clapper.MediaItem : Gst.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents a media&nbsp;item.</p>
<p>A newly created media item must be added to player <a href="class.Queue.html"><code>ClapperQueue</code></a>
first in order to be&nbsp;played.</p>
</div>
<div class="docblock">
@@ -198,6 +217,79 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.MediaItem">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="260pt"
viewBox="0.00 0.00 130.00 260.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperMediaItem">
<path fill="none" stroke="black" d="M109,-36C109,-36 13,-36 13,-36 7,-36 1,-30 1,-24 1,-24 1,-12 1,-12 1,-6 7,0 13,0 13,0 109,0 109,0 115,0 121,-6 121,-12 121,-12 121,-24 121,-24 121,-30 115,-36 109,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperMediaItem</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-108C84.5,-108 37.5,-108 37.5,-108 31.5,-108 25.5,-102 25.5,-96 25.5,-96 25.5,-84 25.5,-84 25.5,-78 31.5,-72 37.5,-72 37.5,-72 84.5,-72 84.5,-72 90.5,-72 96.5,-78 96.5,-84 96.5,-84 96.5,-96 96.5,-96 96.5,-102 90.5,-108 84.5,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-180C110,-180 12,-180 12,-180 6,-180 0,-174 0,-168 0,-168 0,-156 0,-156 0,-150 6,-144 12,-144 12,-144 110,-144 110,-144 116,-144 122,-150 122,-156 122,-156 122,-168 122,-168 122,-174 116,-180 110,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-252C80,-252 42,-252 42,-252 36,-252 30,-246 30,-240 30,-240 30,-228 30,-228 30,-222 36,-216 42,-216 42,-216 80,-216 80,-216 86,-216 92,-222 92,-228 92,-228 92,-240 92,-240 92,-246 86,-252 80,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -285,9 +377,9 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="docblock">
<div class="">
<h6><a href="method.MediaItem.append_suburi.html">clapper_media_item_append_suburi</a></h6>
<h6><a href="method.MediaItem.get_audio_streams.html">clapper_media_item_get_audio_streams</a></h6>
<div class="docblock">
No description available.
<p>Get a list of audio streams within media&nbsp;item.</p>
</div>
<div class="docblock">
<p></p>
@@ -315,9 +407,19 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="">
<h6><a href="method.MediaItem.get_suburis.html">clapper_media_item_get_suburis</a></h6>
<h6><a href="method.MediaItem.get_id.html">clapper_media_item_get_id</a></h6>
<div class="docblock">
No description available.
<p>Get the unique <span class="caps">ID</span> of <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_subtitle_streams.html">clapper_media_item_get_subtitle_streams</a></h6>
<div class="docblock">
<p>Get a list of subtitle streams within media&nbsp;item.</p>
</div>
<div class="docblock">
<p></p>
@@ -347,9 +449,9 @@ of displaying it in the application <span class="caps">UI</span>.</p>
</div>
<div class="">
<h6><a href="method.MediaItem.set_suburis.html">clapper_media_item_set_suburis</a></h6>
<h6><a href="method.MediaItem.get_video_streams.html">clapper_media_item_get_video_streams</a></h6>
<div class="docblock">
No description available.
<p>Get a list of video streams within media&nbsp;item.</p>
</div>
<div class="docblock">
<p></p>
@@ -400,6 +502,16 @@ of displaying it in the application <span class="caps">UI</span>.</p>
<div class="docblock">
<div class="">
<h6><a href="property.MediaItem.audio-streams.html">Clapper.MediaItem:audio-streams</a></h6>
<div class="docblock">
<p>List of available audio&nbsp;streams.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.container-format.html">Clapper.MediaItem:container-format</a></h6>
<div class="docblock">
@@ -421,9 +533,19 @@ of displaying it in the application <span class="caps">UI</span>.</p>
</div>
<div class="">
<h6><a href="property.MediaItem.suburis.html">Clapper.MediaItem:suburis</a></h6>
<h6><a href="property.MediaItem.id.html">Clapper.MediaItem:id</a></h6>
<div class="docblock">
<p>External Subtitle&nbsp;URIs.</p>
<p>Media Item <span class="caps">ID</span>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.subtitle-streams.html">Clapper.MediaItem:subtitle-streams</a></h6>
<div class="docblock">
<p>List of available subtitle&nbsp;streams.</p>
</div>
<div class="docblock">
<p></p>
@@ -450,6 +572,16 @@ of displaying it in the application <span class="caps">UI</span>.</p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.video-streams.html">Clapper.MediaItem:video-streams</a></h6>
<div class="docblock">
<p>List of available video&nbsp;streams.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
@@ -590,6 +722,8 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>

144
doc/clapper/class.Mpris.html
View File

@@ -85,6 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
@@ -96,21 +97,28 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Mpris.get_fallback_art_url.html">get_fallback_art_url</a>
<a class="method" href="method.Mpris.get_queue_controllable.html">get_queue_controllable</a>
<a class="method" href="method.Mpris.set_fallback_art_url.html">set_fallback_art_url</a>
<a class="method" href="method.Mpris.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
@@ -123,19 +131,25 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="property" href="property.Mpris.own-name.html">own-name</a>
<a class="property" href="property.Mpris.queue-controllable.html">queue-controllable</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -159,16 +173,19 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L36">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.Mpris : Clapper.Feature {
<pre><code>final class Clapper.Mpris : Clapper.Feature
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents a <span class="caps">MPRIS</span>&nbsp;feature.</p>
<p>An optional <code>MPRIS</code> feature to add to the&nbsp;player.</p>
<p>Not every <span class="caps">OS</span> supports <code>MPRIS</code>. Use <a href="const.HAVE_MPRIS.html"><code>CLAPPER_HAVE_MPRIS</code></a> macro
to check if Clapper <span class="caps">API</span> was compiled with this&nbsp;feature.</p>
</div>
<div class="docblock">
@@ -182,6 +199,93 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Mpris">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="332pt"
viewBox="0.00 0.00 130.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperMpris">
<path fill="none" stroke="black" d="M95.5,-36C95.5,-36 26.5,-36 26.5,-36 20.5,-36 14.5,-30 14.5,-24 14.5,-24 14.5,-12 14.5,-12 14.5,-6 20.5,0 26.5,0 26.5,0 95.5,0 95.5,0 101.5,0 107.5,-6 107.5,-12 107.5,-12 107.5,-24 107.5,-24 107.5,-30 101.5,-36 95.5,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperMpris</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Feature.html" xlink:title="ClapperFeature">
<path fill="none" stroke="black" d="M99,-108C99,-108 23,-108 23,-108 17,-108 11,-102 11,-96 11,-96 11,-84 11,-84 11,-78 17,-72 23,-72 23,-72 99,-72 99,-72 105,-72 111,-78 111,-84 111,-84 111,-96 111,-96 111,-102 105,-108 99,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperFeature</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge4" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-180C84.5,-180 37.5,-180 37.5,-180 31.5,-180 25.5,-174 25.5,-168 25.5,-168 25.5,-156 25.5,-156 25.5,-150 31.5,-144 37.5,-144 37.5,-144 84.5,-144 84.5,-144 90.5,-144 96.5,-150 96.5,-156 96.5,-156 96.5,-168 96.5,-168 96.5,-174 90.5,-180 84.5,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge3" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-252C110,-252 12,-252 12,-252 6,-252 0,-246 0,-240 0,-240 0,-228 0,-228 0,-222 6,-216 12,-216 12,-216 110,-216 110,-216 116,-216 122,-222 122,-228 122,-228 122,-240 122,-240 122,-246 116,-252 110,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge2" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
<!-- ancestor_3 -->
<g id="node5" class="node">
<title>ancestor_3</title>
<g id="a_node5"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-324C80,-324 42,-324 42,-324 36,-324 30,-318 30,-312 30,-312 30,-300 30,-300 30,-294 36,-288 42,-288 42,-288 80,-288 80,-288 86,-288 92,-294 92,-300 92,-300 92,-312 92,-312 92,-318 86,-324 80,-324"/>
<text text-anchor="middle" x="61" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge1" class="edge">
<title>ancestor_3&#45;&#45;ancestor_2</title>
<path fill="none" stroke="black" d="M61,-287.7C61,-276.85 61,-262.92 61,-252.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -262,6 +366,16 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="method.Mpris.get_queue_controllable.html">clapper_mpris_get_queue_controllable</a></h6>
<div class="docblock">
<p>Get whether remote <code>MPRIS</code> clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Mpris.set_fallback_art_url.html">clapper_mpris_set_fallback_art_url</a></h6>
<div class="docblock">
@@ -272,6 +386,16 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="method.Mpris.set_queue_controllable.html">clapper_mpris_set_queue_controllable</a></h6>
<div class="docblock">
<p>Set whether remote <span class="caps">MPRIS</span> clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
@@ -358,6 +482,16 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="property.Mpris.queue-controllable.html">Clapper.Mpris:queue-controllable</a></h6>
<div class="docblock">
<p>Whether remote <span class="caps">MPRIS</span> clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
@@ -502,6 +636,8 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>

117
doc/clapper/class.Player.html
View File

@@ -85,6 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
@@ -96,8 +97,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Instance methods</h5>
<div class="links">
@@ -157,6 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Properties</h5>
<div class="links">
@@ -190,6 +194,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Signals</h5>
<div class="links">
@@ -205,12 +210,15 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -234,16 +242,28 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L37">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.Player : Clapper.ThreadedObject {
<pre><code>final class Clapper.Player : Clapper.ThreadedObject
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Clapper player that uses <code>GStreamer</code> internally to play various&nbsp;media.</p>
<p>The media player object used for&nbsp;playback.</p>
<p><code>ClapperPlayer</code> was written in an easy to use way, so no special GStreamer
experience is needed to get started with making various playback&nbsp;applications.</p>
<p>Scheduling media for playback is done using a <a href="class.Queue.html"><code>ClapperQueue</code></a> upon which
player&nbsp;operates.</p>
<p>Player uses <code>GStreamer</code> internally and handles playback on a separate thread, while
serializing all events/commands between player and the thread it was created upon
(usually main app thread). This makes it very easy to integrate with <span class="caps">UI</span> toolkits
that operate on a single thread like (but not limited to) <span class="caps">GTK</span>.</p>
<p>To listen for property changes, you can connect to property &#8220;notify&#8221; signal.
As previously mentioned, all signals will be dispatched from the thread player
was created&nbsp;on.</p>
</div>
<div class="docblock">
@@ -257,6 +277,93 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Player">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="155pt" height="332pt"
viewBox="0.00 0.00 155.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperPlayer">
<path fill="none" stroke="black" d="M108.5,-36C108.5,-36 38.5,-36 38.5,-36 32.5,-36 26.5,-30 26.5,-24 26.5,-24 26.5,-12 26.5,-12 26.5,-6 32.5,0 38.5,0 38.5,0 108.5,0 108.5,0 114.5,0 120.5,-6 120.5,-12 120.5,-12 120.5,-24 120.5,-24 120.5,-30 114.5,-36 108.5,-36"/>
<text text-anchor="middle" x="73.5" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperPlayer</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.ThreadedObject.html" xlink:title="ClapperThreadedObject">
<path fill="none" stroke="black" d="M135,-108C135,-108 12,-108 12,-108 6,-108 0,-102 0,-96 0,-96 0,-84 0,-84 0,-78 6,-72 12,-72 12,-72 135,-72 135,-72 141,-72 147,-78 147,-84 147,-84 147,-96 147,-96 147,-102 141,-108 135,-108"/>
<text text-anchor="middle" x="73.5" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperThreadedObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge4" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M73.5,-71.7C73.5,-60.85 73.5,-46.92 73.5,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M97,-180C97,-180 50,-180 50,-180 44,-180 38,-174 38,-168 38,-168 38,-156 38,-156 38,-150 44,-144 50,-144 50,-144 97,-144 97,-144 103,-144 109,-150 109,-156 109,-156 109,-168 109,-168 109,-174 103,-180 97,-180"/>
<text text-anchor="middle" x="73.5" y="-158.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge3" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M73.5,-143.7C73.5,-132.85 73.5,-118.92 73.5,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M122.5,-252C122.5,-252 24.5,-252 24.5,-252 18.5,-252 12.5,-246 12.5,-240 12.5,-240 12.5,-228 12.5,-228 12.5,-222 18.5,-216 24.5,-216 24.5,-216 122.5,-216 122.5,-216 128.5,-216 134.5,-222 134.5,-228 134.5,-228 134.5,-240 134.5,-240 134.5,-246 128.5,-252 122.5,-252"/>
<text text-anchor="middle" x="73.5" y="-230.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge2" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M73.5,-215.7C73.5,-204.85 73.5,-190.92 73.5,-180.1"/>
</g>
<!-- ancestor_3 -->
<g id="node5" class="node">
<title>ancestor_3</title>
<g id="a_node5"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M92.5,-324C92.5,-324 54.5,-324 54.5,-324 48.5,-324 42.5,-318 42.5,-312 42.5,-312 42.5,-300 42.5,-300 42.5,-294 48.5,-288 54.5,-288 54.5,-288 92.5,-288 92.5,-288 98.5,-288 104.5,-294 104.5,-300 104.5,-300 104.5,-312 104.5,-312 104.5,-318 98.5,-324 92.5,-324"/>
<text text-anchor="middle" x="73.5" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge1" class="edge">
<title>ancestor_3&#45;&#45;ancestor_2</title>
<path fill="none" stroke="black" d="M73.5,-287.7C73.5,-276.85 73.5,-262.92 73.5,-252.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -936,6 +1043,8 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>

269
doc/clapper/class.Queue.html
View File

@@ -85,10 +85,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
@@ -99,8 +102,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
@@ -109,27 +118,48 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Queue.current-index.html">current-index</a>
<a class="property" href="property.Queue.current-item.html">current-item</a>
<a class="property" href="property.Queue.gapless.html">gapless</a>
<a class="property" href="property.Queue.instant.html">instant</a>
<a class="property" href="property.Queue.n-items.html">n-items</a>
<a class="property" href="property.Queue.progression-mode.html">progression-mode</a>
@@ -139,14 +169,18 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -170,16 +204,17 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L38">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.Queue : Gst.Object {
<pre><code>final class Clapper.Queue : Gst.Object
implements Gio.ListModel {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A media playback&nbsp;queue.</p>
<p>A queue of media to be&nbsp;played.</p>
</div>
<div class="docblock">
@@ -193,6 +228,93 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Queue">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="332pt"
viewBox="0.00 0.00 130.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperQueue">
<path fill="none" stroke="black" d="M96.5,-108C96.5,-108 25.5,-108 25.5,-108 19.5,-108 13.5,-102 13.5,-96 13.5,-96 13.5,-84 13.5,-84 13.5,-78 19.5,-72 25.5,-72 25.5,-72 96.5,-72 96.5,-72 102.5,-72 108.5,-78 108.5,-84 108.5,-84 108.5,-96 108.5,-96 108.5,-102 102.5,-108 96.5,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperQueue</text>
</a>
</g>
</g>
<!-- implements_0 -->
<g id="node5" class="node">
<title>implements_0</title>
<g id="a_node5"><a xlink:title="Gio.ListModel">
<polygon fill="none" stroke="black" points="107,-36 15,-36 15,0 107,0 107,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="sans-serif" font-size="14.00">GListModel</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_0 -->
<g id="edge4" class="edge">
<title>this&#45;&#45;implements_0</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-180C84.5,-180 37.5,-180 37.5,-180 31.5,-180 25.5,-174 25.5,-168 25.5,-168 25.5,-156 25.5,-156 25.5,-150 31.5,-144 37.5,-144 37.5,-144 84.5,-144 84.5,-144 90.5,-144 96.5,-150 96.5,-156 96.5,-156 96.5,-168 96.5,-168 96.5,-174 90.5,-180 84.5,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-252C110,-252 12,-252 12,-252 6,-252 0,-246 0,-240 0,-240 0,-228 0,-228 0,-222 6,-216 12,-216 12,-216 110,-216 110,-216 116,-216 122,-222 122,-228 122,-228 122,-240 122,-240 122,-246 116,-252 110,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-324C80,-324 42,-324 42,-324 36,-324 30,-318 30,-312 30,-312 30,-300 30,-300 30,-294 36,-288 42,-288 42,-288 80,-288 80,-288 86,-288 92,-294 92,-300 92,-300 92,-312 92,-312 92,-318 86,-324 80,-324"/>
<text text-anchor="middle" x="61" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-287.7C61,-276.85 61,-262.92 61,-252.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -285,6 +407,16 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="method.Queue.get_current_index.html">clapper_queue_get_current_index</a></h6>
<div class="docblock">
<p>Get index of the currently selected <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.get_current_item.html">clapper_queue_get_current_item</a></h6>
<div class="docblock">
@@ -295,6 +427,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="method.Queue.get_gapless.html">clapper_queue_get_gapless</a></h6>
<div class="docblock">
<p>Get if <code>ClapperQueue</code> is set to use gapless&nbsp;progression.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.get_instant.html">clapper_queue_get_instant</a></h6>
<div class="docblock">
<p>Get if <code>ClapperQueue</code> is set to use instant media item&nbsp;changes.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.get_item.html">clapper_queue_get_item</a></h6>
<div class="docblock">
@@ -335,6 +487,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="method.Queue.item_is_current.html">clapper_queue_item_is_current</a></h6>
<div class="docblock">
<p>Checks if given <code>ClapperMediaItem</code> is currently&nbsp;selected.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.remove_index.html">clapper_queue_remove_index</a></h6>
<div class="docblock">
<p>Removes <code>ClapperMediaItem</code> at <code>index</code> from the&nbsp;queue.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.remove_item.html">clapper_queue_remove_item</a></h6>
<div class="docblock">
@@ -345,10 +517,31 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
</div>
<div class="">
<h6><a href="method.Queue.reposition_item.html">clapper_queue_reposition_item</a></h6>
<div class="docblock">
<p>Change position of one <code>ClapperMediaItem</code> within the&nbsp;queue.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.select_index.html">clapper_queue_select_index</a></h6>
<div class="docblock">
<p>Selects <code>ClapperMediaItem</code> at <code>index</code> from <code>queue</code> as
current one and signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.select_item.html">clapper_queue_select_item</a></h6>
<div class="docblock">
<p>Selects <code>ClapperMediaItem</code> from playlist as current one and
<p>Selects <code>ClapperMediaItem</code> from <code>queue</code> as current one and
signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
</div>
<div class="docblock">
@@ -359,7 +552,7 @@ signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
<div class="">
<h6><a href="method.Queue.select_next_item.html">clapper_queue_select_next_item</a></h6>
<div class="docblock">
<p>Selects next <code>ClapperMediaItem</code> from playlist for&nbsp;playback.</p>
<p>Selects next <code>ClapperMediaItem</code> from <code>queue</code> for&nbsp;playback.</p>
</div>
<div class="docblock">
<p></p>
@@ -369,7 +562,27 @@ signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
<div class="">
<h6><a href="method.Queue.select_previous_item.html">clapper_queue_select_previous_item</a></h6>
<div class="docblock">
<p>Selects previous <code>ClapperMediaItem</code> from playlist for&nbsp;playback.</p>
<p>Selects previous <code>ClapperMediaItem</code> from <code>queue</code> for&nbsp;playback.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.set_gapless.html">clapper_queue_set_gapless</a></h6>
<div class="docblock">
<p>Set <code>ClapperQueue</code> progression to be&nbsp;gapless.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.set_instant.html">clapper_queue_set_instant</a></h6>
<div class="docblock">
<p>Set <code>ClapperQueue</code> media item changes to be&nbsp;instant.</p>
</div>
<div class="docblock">
<p></p>
@@ -386,6 +599,16 @@ signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
</div>
</div>
<div class="">
<h6><a href="method.Queue.steal_index.html">clapper_queue_steal_index</a></h6>
<div class="docblock">
<p>Removes <code>ClapperMediaItem</code> at <code>index</code> from the&nbsp;queue.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
@@ -473,6 +696,16 @@ signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
<div class="docblock">
<div class="">
<h6><a href="property.Queue.current-index.html">Clapper.Queue:current-index</a></h6>
<div class="docblock">
<p>Index of currently selected media item for&nbsp;playback.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Queue.current-item.html">Clapper.Queue:current-item</a></h6>
<div class="docblock">
@@ -483,6 +716,26 @@ signals <code>ClapperPlayer</code> to play&nbsp;it.</p>
</div>
</div>
<div class="">
<h6><a href="property.Queue.gapless.html">Clapper.Queue:gapless</a></h6>
<div class="docblock">
<p>Use gapless&nbsp;progression.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Queue.instant.html">Clapper.Queue:instant</a></h6>
<div class="docblock">
<p>Use instant media item&nbsp;changes.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Queue.n-items.html">Clapper.Queue:n-items</a></h6>
<div class="docblock">
@@ -662,6 +915,8 @@ items were added in their&nbsp;place.</p>
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>

754
doc/clapper/class.Server.html Normal file
View File

@@ -0,0 +1,754 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Server</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.Server"/>
<meta property="og:description" content="Reference for Clapper.Server"/>
<meta name="twitter:title" content="Clapper.Server"/>
<meta name="twitter:description" content="Reference for Clapper.Server"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.Server.html#description">Server</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.Server.new.html">new</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Server.get_current_port.html">get_current_port</a>
<a class="method" href="method.Server.get_enabled.html">get_enabled</a>
<a class="method" href="method.Server.get_port.html">get_port</a>
<a class="method" href="method.Server.get_queue_controllable.html">get_queue_controllable</a>
<a class="method" href="method.Server.get_running.html">get_running</a>
<a class="method" href="method.Server.set_enabled.html">set_enabled</a>
<a class="method" href="method.Server.set_port.html">set_port</a>
<a class="method" href="method.Server.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Server.current-port.html">current-port</a>
<a class="property" href="property.Server.enabled.html">enabled</a>
<a class="property" href="property.Server.port.html">port</a>
<a class="property" href="property.Server.queue-controllable.html">queue-controllable</a>
<a class="property" href="property.Server.running.html">running</a>
</div>
</div>
<div class="section">
<h5>Signals</h5>
<div class="links">
<a class="signal" href="signal.Server.error.html">error</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">Clapper</a><span class="sep" role="presentation"></span>Server</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/server/clapper-server.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.Server : Clapper.Feature
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>An optional Server feature to add to the&nbsp;player.</p>
<p><code>ClapperServer</code> is a feature that hosts a local server
providing an ability to both monitor and control playback
through WebSocket messages and <span class="caps">HTTP</span>&nbsp;requests.</p>
<p>Use <a href="const.HAVE_SERVER.html"><code>CLAPPER_HAVE_SERVER</code></a> macro to check if Clapper <span class="caps">API</span>
was compiled with this&nbsp;feature.</p>
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Server">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="332pt"
viewBox="0.00 0.00 130.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperServer">
<path fill="none" stroke="black" d="M96.5,-36C96.5,-36 25.5,-36 25.5,-36 19.5,-36 13.5,-30 13.5,-24 13.5,-24 13.5,-12 13.5,-12 13.5,-6 19.5,0 25.5,0 25.5,0 96.5,0 96.5,0 102.5,0 108.5,-6 108.5,-12 108.5,-12 108.5,-24 108.5,-24 108.5,-30 102.5,-36 96.5,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperServer</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Feature.html" xlink:title="ClapperFeature">
<path fill="none" stroke="black" d="M99,-108C99,-108 23,-108 23,-108 17,-108 11,-102 11,-96 11,-96 11,-84 11,-84 11,-78 17,-72 23,-72 23,-72 99,-72 99,-72 105,-72 111,-78 111,-84 111,-84 111,-96 111,-96 111,-102 105,-108 99,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperFeature</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge4" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-180C84.5,-180 37.5,-180 37.5,-180 31.5,-180 25.5,-174 25.5,-168 25.5,-168 25.5,-156 25.5,-156 25.5,-150 31.5,-144 37.5,-144 37.5,-144 84.5,-144 84.5,-144 90.5,-144 96.5,-150 96.5,-156 96.5,-156 96.5,-168 96.5,-168 96.5,-174 90.5,-180 84.5,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge3" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-252C110,-252 12,-252 12,-252 6,-252 0,-246 0,-240 0,-240 0,-228 0,-228 0,-222 6,-216 12,-216 12,-216 110,-216 110,-216 116,-216 122,-222 122,-228 122,-228 122,-240 122,-240 122,-246 116,-252 110,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge2" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
<!-- ancestor_3 -->
<g id="node5" class="node">
<title>ancestor_3</title>
<g id="a_node5"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-324C80,-324 42,-324 42,-324 36,-324 30,-318 30,-312 30,-312 30,-300 30,-300 30,-294 36,-288 42,-288 42,-288 80,-288 80,-288 86,-288 92,-294 92,-300 92,-300 92,-312 92,-312 92,-318 86,-324 80,-324"/>
<text text-anchor="middle" x="61" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge1" class="edge">
<title>ancestor_3&#45;&#45;ancestor_2</title>
<path fill="none" stroke="black" d="M61,-287.7C61,-276.85 61,-262.92 61,-252.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a href="class.Feature.html" title="Feature">ClapperFeature</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.InitiallyUnowned.html" data-namespace="GObject">GInitiallyUnowned</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper constructors">
<h4 id="constructors">
Constructors
<a href="#constructors" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="ctor.Server.new.html">clapper_server_new</a></h6>
<div class="docblock">
<p>Creates a new <code>ClapperServer</code> instance.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.Server.get_current_port.html">clapper_server_get_current_port</a></h6>
<div class="docblock">
<p>Get port on which server is currently listening&nbsp;on.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_enabled.html">clapper_server_get_enabled</a></h6>
<div class="docblock">
<p>Get whether <code>ClapperServer</code> is set to be&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_port.html">clapper_server_get_port</a></h6>
<div class="docblock">
<p>Get requested server listening&nbsp;port.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_queue_controllable.html">clapper_server_get_queue_controllable</a></h6>
<div class="docblock">
<p>Get whether remote <code>server</code> clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_running.html">clapper_server_get_running</a></h6>
<div class="docblock">
<p>Get whether <code>ClapperServer</code> is currently&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.set_enabled.html">clapper_server_set_enabled</a></h6>
<div class="docblock">
<p>Set whether <code>ClapperServer</code> should be&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.set_port.html">clapper_server_set_port</a></h6>
<div class="docblock">
<p>Set server listening&nbsp;port.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.set_queue_controllable.html">clapper_server_set_queue_controllable</a></h6>
<div class="docblock">
<p>Set whether remote <code>server</code> clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (25)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="Gst">GstObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.Server.current-port.html">Clapper.Server:current-port</a></h6>
<div class="docblock">
<p>Port on which server is currently listening on or 0 if not&nbsp;listening.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.enabled.html">Clapper.Server:enabled</a></h6>
<div class="docblock">
<p>Whether server is&nbsp;enabled.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.port.html">Clapper.Server:port</a></h6>
<div class="docblock">
<p>Port to listen on or 0 for using random unused&nbsp;port.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.queue-controllable.html">Clapper.Server:queue-controllable</a></h6>
<div class="docblock">
<p>Whether remote server clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.running.html">Clapper.Server:running</a></h6>
<div class="docblock">
<p>Whether server is currently&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties"><h5 style="display:block;">Properties inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (2)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.name.html">Gst.Object:name</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.parent.html">Gst.Object:parent</a></h6>
<div class="docblock">
<p>The parent of the object. Please note, that when changing the &#8216;parent&#8217;
property, we don&#8217;t emit <code>GObject::notify</code> and <code>GstObject::deep-notify</code>
signals due to locking issues. In some cases one can use
<code>GstBin::element-added</code> or <code>GstBin::element-removed</code> signals on the parent to
achieve a similar&nbsp;effect.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="signal.Server.error.html">Clapper.Server::error</a></h6>
<div class="docblock">
<p>Error signal when server could not start.
This will be emitted from application main&nbsp;thread.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="signal.Object.deep-notify.html">GstObject::deep-notify</a></h6>
<div class="docblock">
<p>The deep notify signal is used to be notified of property changes. It is
typically attached to the toplevel bin to receive notifications from all
the elements contained in that&nbsp;bin.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ClapperServerClass {
ClapperFeatureClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: ClapperFeatureClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#constructors"><span class="link-text">Constructors</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>
<li class="toc-list-item"><a href="#signals"><span class="link-text">Signals</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

535
doc/clapper/class.Stream.html Normal file
View File

@@ -0,0 +1,535 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Stream</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.Stream"/>
<meta property="og:description" content="Reference for Clapper.Stream"/>
<meta name="twitter:title" content="Clapper.Stream"/>
<meta name="twitter:description" content="Reference for Clapper.Stream"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.Stream.html#description">Stream</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Stream.get_caps.html">get_caps</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Stream.caps.html">caps</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">Clapper</a><span class="sep" role="presentation"></span>Stream</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-stream.c#L20">[src]</a>
</h4>
<pre><code>class Clapper.Stream : Gst.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents a stream within&nbsp;media.</p>
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.Stream">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="260pt"
viewBox="0.00 0.00 130.00 260.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperStream">
<path fill="none" stroke="black" d="M98,-36C98,-36 24,-36 24,-36 18,-36 12,-30 12,-24 12,-24 12,-12 12,-12 12,-6 18,0 24,0 24,0 98,0 98,0 104,0 110,-6 110,-12 110,-12 110,-24 110,-24 110,-30 104,-36 98,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperStream</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-108C84.5,-108 37.5,-108 37.5,-108 31.5,-108 25.5,-102 25.5,-96 25.5,-96 25.5,-84 25.5,-84 25.5,-78 31.5,-72 37.5,-72 37.5,-72 84.5,-72 84.5,-72 90.5,-72 96.5,-78 96.5,-84 96.5,-84 96.5,-96 96.5,-96 96.5,-102 90.5,-108 84.5,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-180C110,-180 12,-180 12,-180 6,-180 0,-174 0,-168 0,-168 0,-156 0,-156 0,-150 6,-144 12,-144 12,-144 110,-144 110,-144 116,-144 122,-150 122,-156 122,-156 122,-168 122,-168 122,-174 116,-180 110,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-252C80,-252 42,-252 42,-252 36,-252 30,-246 30,-240 30,-240 30,-228 30,-228 30,-222 36,-216 42,-216 42,-216 80,-216 80,-216 86,-216 92,-222 92,-228 92,-228 92,-240 92,-240 92,-246 86,-252 80,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.InitiallyUnowned.html" data-namespace="GObject">GInitiallyUnowned</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.Stream.get_caps.html">clapper_stream_get_caps</a></h6>
<div class="docblock">
<p>Get the caps of <code>stream</code>, if&nbsp;any.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (25)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="Gst">GstObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.Stream.caps.html">Clapper.Stream:caps</a></h6>
<div class="docblock">
<p>The <code>GstCaps</code> of&nbsp;stream.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties"><h5 style="display:block;">Properties inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (2)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.name.html">Gst.Object:name</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.parent.html">Gst.Object:parent</a></h6>
<div class="docblock">
<p>The parent of the object. Please note, that when changing the &#8216;parent&#8217;
property, we don&#8217;t emit <code>GObject::notify</code> and <code>GstObject::deep-notify</code>
signals due to locking issues. In some cases one can use
<code>GstBin::element-added</code> or <code>GstBin::element-removed</code> signals on the parent to
achieve a similar&nbsp;effect.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="signal.Object.deep-notify.html">GstObject::deep-notify</a></h6>
<div class="docblock">
<p>The deep notify signal is used to be notified of property changes. It is
typically attached to the toplevel bin to receive notifications from all
the elements contained in that&nbsp;bin.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ClapperStreamClass {
GstObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GstObjectClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

702
doc/clapper/class.StreamList.html Normal file
View File

@@ -0,0 +1,702 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.StreamList</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.StreamList"/>
<meta property="og:description" content="Reference for Clapper.StreamList"/>
<meta name="twitter:title" content="Clapper.StreamList"/>
<meta name="twitter:description" content="Reference for Clapper.StreamList"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.StreamList.html#description">StreamList</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.StreamList.get_current_index.html">get_current_index</a>
<a class="method" href="method.StreamList.get_current_stream.html">get_current_stream</a>
<a class="method" href="method.StreamList.get_n_streams.html">get_n_streams</a>
<a class="method" href="method.StreamList.get_stream.html">get_stream</a>
<a class="method" href="method.StreamList.select_index.html">select_index</a>
<a class="method" href="method.StreamList.select_stream.html">select_stream</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.StreamList.current-index.html">current-index</a>
<a class="property" href="property.StreamList.current-stream.html">current-stream</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">Clapper</a><span class="sep" role="presentation"></span>StreamList</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-stream-list.c#L20">[src]</a>
</h4>
<pre><code>class Clapper.StreamList : Gst.Object
implements Gio.ListModel {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A list of media&nbsp;streams.</p>
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.StreamList">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="130pt" height="332pt"
viewBox="0.00 0.00 130.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperStreamList">
<path fill="none" stroke="black" d="M108.5,-108C108.5,-108 13.5,-108 13.5,-108 7.5,-108 1.5,-102 1.5,-96 1.5,-96 1.5,-84 1.5,-84 1.5,-78 7.5,-72 13.5,-72 13.5,-72 108.5,-72 108.5,-72 114.5,-72 120.5,-78 120.5,-84 120.5,-84 120.5,-96 120.5,-96 120.5,-102 114.5,-108 108.5,-108"/>
<text text-anchor="middle" x="61" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperStreamList</text>
</a>
</g>
</g>
<!-- implements_0 -->
<g id="node5" class="node">
<title>implements_0</title>
<g id="a_node5"><a xlink:title="Gio.ListModel">
<polygon fill="none" stroke="black" points="107,-36 15,-36 15,0 107,0 107,-36"/>
<text text-anchor="middle" x="61" y="-14.3" font-family="sans-serif" font-size="14.00">GListModel</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_0 -->
<g id="edge4" class="edge">
<title>this&#45;&#45;implements_0</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M61,-71.7C61,-60.85 61,-46.92 61,-36.1"/>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M84.5,-180C84.5,-180 37.5,-180 37.5,-180 31.5,-180 25.5,-174 25.5,-168 25.5,-168 25.5,-156 25.5,-156 25.5,-150 31.5,-144 37.5,-144 37.5,-144 84.5,-144 84.5,-144 90.5,-144 96.5,-150 96.5,-156 96.5,-156 96.5,-168 96.5,-168 96.5,-174 90.5,-180 84.5,-180"/>
<text text-anchor="middle" x="61" y="-158.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M61,-143.7C61,-132.85 61,-118.92 61,-108.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M110,-252C110,-252 12,-252 12,-252 6,-252 0,-246 0,-240 0,-240 0,-228 0,-228 0,-222 6,-216 12,-216 12,-216 110,-216 110,-216 116,-216 122,-222 122,-228 122,-228 122,-240 122,-240 122,-246 116,-252 110,-252"/>
<text text-anchor="middle" x="61" y="-230.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M61,-215.7C61,-204.85 61,-190.92 61,-180.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M80,-324C80,-324 42,-324 42,-324 36,-324 30,-318 30,-312 30,-312 30,-300 30,-300 30,-294 36,-288 42,-288 42,-288 80,-288 80,-288 86,-288 92,-294 92,-300 92,-300 92,-312 92,-312 92,-318 86,-324 80,-324"/>
<text text-anchor="middle" x="61" y="-302.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M61,-287.7C61,-276.85 61,-262.92 61,-252.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.InitiallyUnowned.html" data-namespace="GObject">GInitiallyUnowned</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper implements">
<h4 id="implements">
Implements
<a href="#implements" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.ListModel.html" data-namespace="Gio">GListModel</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.StreamList.get_current_index.html">clapper_stream_list_get_current_index</a></h6>
<div class="docblock">
<p>Get index of the currently selected <code>ClapperStream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.StreamList.get_current_stream.html">clapper_stream_list_get_current_stream</a></h6>
<div class="docblock">
<p>Get the currently selected <code>ClapperStream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.StreamList.get_n_streams.html">clapper_stream_list_get_n_streams</a></h6>
<div class="docblock">
<p>Get the number of streams in <code>ClapperStreamList</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.StreamList.get_stream.html">clapper_stream_list_get_stream</a></h6>
<div class="docblock">
<p>Get the <code>ClapperStream</code> at&nbsp;index.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.StreamList.select_index.html">clapper_stream_list_select_index</a></h6>
<div class="docblock">
<p>Selects <code>ClapperStream</code> at <code>index</code> from <code>list</code> as current&nbsp;one.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.StreamList.select_stream.html">clapper_stream_list_select_stream</a></h6>
<div class="docblock">
<p>Selects <code>ClapperStream</code> from <code>list</code> to be&nbsp;activated.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (25)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="Gst">GstObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="iface.ListModel.html" data-namespace="Gio">GListModel</a> (5)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_item.html">g_list_model_get_item</a></h6>
<div class="docblock">
<p>Get the item at <code>position</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_item_type.html">g_list_model_get_item_type</a></h6>
<div class="docblock">
<p>Gets the type of the items in <code>list</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_n_items.html">g_list_model_get_n_items</a></h6>
<div class="docblock">
<p>Gets the number of items in <code>list</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_object.html">g_list_model_get_object</a></h6>
<div class="docblock">
<p>Get the item at <code>position</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.items_changed.html">g_list_model_items_changed</a></h6>
<div class="docblock">
<p>Emits the <code>GListModel::items-changed</code> signal on <code>list</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.StreamList.current-index.html">Clapper.StreamList:current-index</a></h6>
<div class="docblock">
<p>Index of currently selected&nbsp;stream.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.StreamList.current-stream.html">Clapper.StreamList:current-stream</a></h6>
<div class="docblock">
<p>Currently selected&nbsp;stream.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties"><h5 style="display:block;">Properties inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (2)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.name.html">Gst.Object:name</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="property.Object.parent.html">Gst.Object:parent</a></h6>
<div class="docblock">
<p>The parent of the object. Please note, that when changing the &#8216;parent&#8217;
property, we don&#8217;t emit <code>GObject::notify</code> and <code>GstObject::deep-notify</code>
signals due to locking issues. In some cases one can use
<code>GstBin::element-added</code> or <code>GstBin::element-removed</code> signals on the parent to
achieve a similar&nbsp;effect.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="Gst">GstObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gst" data-link="signal.Object.deep-notify.html">GstObject::deep-notify</a></h6>
<div class="docblock">
<p>The deep notify signal is used to be notified of property changes. It is
typically attached to the toplevel bin to receive notifications from all
the elements contained in that&nbsp;bin.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="iface.ListModel.html" data-namespace="Gio">GListModel</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="signal.ListModel.items-changed.html">GListModel::items-changed</a></h6>
<div class="docblock">
<p>This signal is emitted whenever items were added to or removed
from <code>list</code>. At <code>position</code>, <code>removed</code> items were removed and <code>added</code>
items were added in their&nbsp;place.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This signal will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ClapperStreamListClass {
GstObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GstObjectClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#implements"><span class="link-text">Implements</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

92
doc/clapper/class.ThreadedObject.html
View File

@@ -85,10 +85,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
@@ -100,12 +103,16 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Virtual methods</h5>
<div class="links">
@@ -119,8 +126,9 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -144,12 +152,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-threaded-object.h#L30">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-threaded-object.c#L20">[src]</a>
</h4>
<pre><code>class Clapper.ThreadedObject : Gst.Object {
parent_instance: GstObject
<pre><code>class Clapper.ThreadedObject : Gst.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
@@ -167,6 +176,79 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for Clapper.ThreadedObject">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="155pt" height="260pt"
viewBox="0.00 0.00 155.00 260.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperThreadedObject">
<path fill="none" stroke="black" d="M135,-36C135,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 135,0 135,0 141,0 147,-6 147,-12 147,-12 147,-24 147,-24 147,-30 141,-36 135,-36"/>
<text text-anchor="middle" x="73.5" y="-14.3" font-family="Times,serif" font-size="14.00">ClapperThreadedObject</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M97,-108C97,-108 50,-108 50,-108 44,-108 38,-102 38,-96 38,-96 38,-84 38,-84 38,-78 44,-72 50,-72 50,-72 97,-72 97,-72 103,-72 109,-78 109,-84 109,-84 109,-96 109,-96 109,-102 103,-108 97,-108"/>
<text text-anchor="middle" x="73.5" y="-86.3" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M73.5,-71.7C73.5,-60.85 73.5,-46.92 73.5,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M122.5,-180C122.5,-180 24.5,-180 24.5,-180 18.5,-180 12.5,-174 12.5,-168 12.5,-168 12.5,-156 12.5,-156 12.5,-150 18.5,-144 24.5,-144 24.5,-144 122.5,-144 122.5,-144 128.5,-144 134.5,-150 134.5,-156 134.5,-156 134.5,-168 134.5,-168 134.5,-174 128.5,-180 122.5,-180"/>
<text text-anchor="middle" x="73.5" y="-158.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M73.5,-143.7C73.5,-132.85 73.5,-118.92 73.5,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M92.5,-252C92.5,-252 54.5,-252 54.5,-252 48.5,-252 42.5,-246 42.5,-240 42.5,-240 42.5,-228 42.5,-228 42.5,-222 48.5,-216 54.5,-216 54.5,-216 92.5,-216 92.5,-216 98.5,-216 104.5,-222 104.5,-228 104.5,-228 104.5,-240 104.5,-240 104.5,-246 98.5,-252 92.5,-252"/>
<text text-anchor="middle" x="73.5" y="-230.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M73.5,-215.7C73.5,-204.85 73.5,-190.92 73.5,-180.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
@@ -458,6 +540,8 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>

19
doc/clapper/classes_hierarchy.html
View File

@@ -79,7 +79,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -87,6 +87,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<section id="main" class="content">
<h4 id="title" style="display:flex;">
Classes Hierarchy
<a href="#title" class="anchor"></a>
</h4>
<section>
<div class="docblock">
<h1>Classes Hierarchy</h1>
@@ -97,12 +104,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<ul class="type">
<li class="type"><a data-namespace="Gst" data-link="class.Object.html" href="javascript:void(0)" class="external"><code>Gst.Object</code></a>
<ul class="type">
<li class="type"><a href="class.Discoverer.html"><code>Discoverer</code></a>
</li>
<li class="type"><a href="class.Feature.html"><code>Feature</code></a>
<ul class="type">
<li class="type"><a href="class.Discoverer.html"><code>Discoverer</code></a>
</li>
<li class="type"><a href="class.Mpris.html"><code>Mpris</code></a>
</li>
<li class="type"><a href="class.Server.html"><code>Server</code></a>
</li>
</ul>
</li>
<li class="type"><a href="class.MediaItem.html"><code>MediaItem</code></a>
@@ -115,6 +124,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</li>
<li class="type"><a href="class.Queue.html"><code>Queue</code></a>
</li>
<li class="type"><a href="class.Stream.html"><code>Stream</code></a>
</li>
<li class="type"><a href="class.StreamList.html"><code>StreamList</code></a>
</li>
</ul>
</li>
</ul>

153
doc/clapper/const.HAVE_DISCOVERER.html Normal file
View File

@@ -0,0 +1,153 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.HAVE_DISCOVERER</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.HAVE_DISCOVERER"/>
<meta property="og:description" content="Reference for Clapper.HAVE_DISCOVERER"/>
<meta name="twitter:title" content="Clapper.HAVE_DISCOVERER"/>
<meta name="twitter:description" content="Reference for Clapper.HAVE_DISCOVERER"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Constant</h5>
<div class="links">
<a class="current" href="const.HAVE_DISCOVERER.html">HAVE_DISCOVERER</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constant</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>HAVE_DISCOVERER</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_HAVE_DISCOVERER true</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
<p>Check if Clapper was compiled with Discoverer&nbsp;feature.</p>
</div>
<div class="docblock">
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

2
doc/clapper/const.HAVE_MPRIS.html
View File

@@ -85,7 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

153
doc/clapper/const.HAVE_SERVER.html Normal file
View File

@@ -0,0 +1,153 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.HAVE_SERVER</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.HAVE_SERVER"/>
<meta property="og:description" content="Reference for Clapper.HAVE_SERVER"/>
<meta name="twitter:title" content="Clapper.HAVE_SERVER"/>
<meta name="twitter:description" content="Reference for Clapper.HAVE_SERVER"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Constant</h5>
<div class="links">
<a class="current" href="const.HAVE_SERVER.html">HAVE_SERVER</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constant</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>HAVE_SERVER</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_HAVE_SERVER true</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
<p>Check if Clapper was compiled with Server&nbsp;feature.</p>
</div>
<div class="docblock">
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

2
doc/clapper/const.MAJOR_VERSION.html
View File

@@ -85,7 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

2
doc/clapper/const.MICRO_VERSION.html
View File

@@ -85,7 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

2
doc/clapper/const.MINOR_VERSION.html
View File

@@ -85,7 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

153
doc/clapper/const.QUEUE_INVALID_POSITION.html Normal file
View File

@@ -0,0 +1,153 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.QUEUE_INVALID_POSITION</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.QUEUE_INVALID_POSITION"/>
<meta property="og:description" content="Reference for Clapper.QUEUE_INVALID_POSITION"/>
<meta name="twitter:title" content="Clapper.QUEUE_INVALID_POSITION"/>
<meta name="twitter:description" content="Reference for Clapper.QUEUE_INVALID_POSITION"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Constant</h5>
<div class="links">
<a class="current" href="const.QUEUE_INVALID_POSITION.html">QUEUE_INVALID_POSITION</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constant</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>QUEUE_INVALID_POSITION</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_QUEUE_INVALID_POSITION 4294967295</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
<p>The value used to refer to an invalid position in a <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

153
doc/clapper/const.STREAM_LIST_INVALID_POSITION.html Normal file
View File

@@ -0,0 +1,153 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.STREAM_LIST_INVALID_POSITION</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.STREAM_LIST_INVALID_POSITION"/>
<meta property="og:description" content="Reference for Clapper.STREAM_LIST_INVALID_POSITION"/>
<meta name="twitter:title" content="Clapper.STREAM_LIST_INVALID_POSITION"/>
<meta name="twitter:description" content="Reference for Clapper.STREAM_LIST_INVALID_POSITION"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Constant</h5>
<div class="links">
<a class="current" href="const.STREAM_LIST_INVALID_POSITION.html">STREAM_LIST_INVALID_POSITION</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constant</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>STREAM_LIST_INVALID_POSITION</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_STREAM_LIST_INVALID_POSITION 4294967295</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
<p>The value used to refer to an invalid position in a <code>ClapperStreamList</code>.</p>
</div>
<div class="docblock">
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

158
doc/clapper/const.TIME_FORMAT.html Normal file
View File

@@ -0,0 +1,158 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.TIME_FORMAT</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.TIME_FORMAT"/>
<meta property="og:description" content="Reference for Clapper.TIME_FORMAT"/>
<meta name="twitter:title" content="Clapper.TIME_FORMAT"/>
<meta name="twitter:description" content="Reference for Clapper.TIME_FORMAT"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Constant</h5>
<div class="links">
<a class="current" href="const.TIME_FORMAT.html">TIME_FORMAT</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constant</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>TIME_FORMAT</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_TIME_FORMAT &quot;02u:%02u:%02u&quot;</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
<p>A string that can be used in printf-like format to display
e.g. position or duration in <code>hh:mm:ss</code> format. Meant to be
used together with <a href="func.TIME_ARGS.html"><code>CLAPPER_TIME_ARGS()</code></a>.</p>
<p>Example:</p>
<div class="codehilite"><pre><span></span><code><span class="n">gchar</span><span class="w"> </span><span class="o">*</span><span class="n">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">g_strdup_printf</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;%&quot;</span><span class="w"> </span><span class="n">CLAPPER_TIME_FORMAT</span><span class="p">,</span><span class="w"> </span><span class="n">CLAPPER_TIME_ARGS</span><span class="p">(</span><span class="n">t</span><span class="p">));</span>
</code></pre></div>
</div>
<div class="docblock">
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

157
doc/clapper/const.TIME_MS_FORMAT.html Normal file
View File

@@ -0,0 +1,157 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.TIME_MS_FORMAT</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.TIME_MS_FORMAT"/>
<meta property="og:description" content="Reference for Clapper.TIME_MS_FORMAT"/>
<meta name="twitter:title" content="Clapper.TIME_MS_FORMAT"/>
<meta name="twitter:description" content="Reference for Clapper.TIME_MS_FORMAT"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Constant</h5>
<div class="links">
<a class="current" href="const.TIME_MS_FORMAT.html">TIME_MS_FORMAT</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constant</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>TIME_MS_FORMAT</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_TIME_MS_FORMAT &quot;02u:%02u:%02u.%03u&quot;</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
<p>Same as <a href="const.TIME_FORMAT.html"><code>CLAPPER_TIME_FORMAT</code></a>, but also displays milliseconds.
Meant to be used together with <a href="func.TIME_MS_ARGS.html"><code>CLAPPER_TIME_MS_ARGS()</code></a>.</p>
<p>Example:</p>
<div class="codehilite"><pre><span></span><code><span class="n">gchar</span><span class="w"> </span><span class="o">*</span><span class="n">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">g_strdup_printf</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;%&quot;</span><span class="w"> </span><span class="n">CLAPPER_TIME_MS_FORMAT</span><span class="p">,</span><span class="w"> </span><span class="n">CLAPPER_TIME_MS_ARGS</span><span class="p">(</span><span class="n">t</span><span class="p">));</span>
</code></pre></div>
</div>
<div class="docblock">
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

2
doc/clapper/const.VERSION_S.html
View File

@@ -85,7 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

6
doc/clapper/ctor.Discoverer.new.html
View File

@@ -93,7 +93,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-discoverer.h#L56">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.h#L37">[src]</a>
</h4>
@@ -134,7 +134,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-discoverer.c#L346">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.c#L355">[src]</a>
</h4>

6
doc/clapper/ctor.MediaItem.new.html
View File

@@ -97,7 +97,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -119,7 +119,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L43">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L40">[src]</a>
</h4>
@@ -138,7 +138,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L134">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L214">[src]</a>
</h4>

6
doc/clapper/ctor.MediaItem.new_from_file.html
View File

@@ -97,7 +97,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -119,7 +119,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L47">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L44">[src]</a>
</h4>
@@ -138,7 +138,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L193">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L278">[src]</a>
</h4>

6
doc/clapper/ctor.MediaItem.new_take.html
View File

@@ -97,7 +97,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -119,7 +119,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L45">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L42">[src]</a>
</h4>
@@ -138,7 +138,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L158">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L238">[src]</a>
</h4>

6
doc/clapper/ctor.Mpris.new.html
View File

@@ -93,7 +93,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L43">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L38">[src]</a>
</h4>
@@ -136,7 +136,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1246">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1340">[src]</a>
</h4>

6
doc/clapper/ctor.Player.new.html
View File

@@ -93,7 +93,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L44">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L39">[src]</a>
</h4>
@@ -134,7 +134,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L444">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L433">[src]</a>
</h4>

197
doc/clapper/ctor.Server.new.html Normal file
View File

@@ -0,0 +1,197 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Server.new</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.Server.new"/>
<meta property="og:description" content="Reference for Clapper.Server.new"/>
<meta name="twitter:title" content="Clapper.Server.new"/>
<meta name="twitter:description" content="Reference for Clapper.Server.new"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Server.html">Server</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="method current" href="ctor.Server.new.html">new</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Constructor</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Server.html">Server</a><span class="sep"></span>new</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/server/clapper-server.h#L37">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="n">ClapperServer</span><span class="o">*</span>
<span class="n">clapper_server_new</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="kt">void</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/server/clapper-server.c#L808">[src]</a>
</h4>
<div class="docblock">
<p>Creates a new <code>ClapperServer</code> instance.</p>
</div>
<div class="docblock">
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<a href="class.Server.html"><code>ClapperServer</code></a></p>
<p><p>A new <code>ClapperServer</code> instance.</p></p>
</div>
<div>
<table>
<tr><td title="transfer: full">The caller of the function takes ownership of the data, and is responsible for freeing it.</td></tr>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

209
doc/clapper/enum.DiscovererDiscoveryMode.html Normal file
View File

@@ -0,0 +1,209 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.DiscovererDiscoveryMode</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.DiscovererDiscoveryMode"/>
<meta property="og:description" content="Reference for Clapper.DiscovererDiscoveryMode"/>
<meta name="twitter:title" content="Clapper.DiscovererDiscoveryMode"/>
<meta name="twitter:description" content="Reference for Clapper.DiscovererDiscoveryMode"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="enum.DiscovererDiscoveryMode.html">DiscovererDiscoveryMode</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Enumeration</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>DiscovererDiscoveryMode</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>enum Clapper.DiscovererDiscoveryMode</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
No description available.
</div>
<div class="docblock">
</div>
</div>
<div class="members toggle-wrapper">
<h4 id="members">
Members
<a href="#members" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="enum-members">
<dt><a id="always" href="#always"><code>CLAPPER_DISCOVERER_DISCOVERY_ALWAYS</code></a></dt>
<dd>
<div><p>Run discovery for every single media item added to <a href="class.Queue.html"><code>ClapperQueue</code></a>.
This mode is useful when application presents a list of items to select from to the user before playback.
It will scan every single item in queue, so user can have an updated list of items when selecting what to&nbsp;play.</p></div>
<ul>
<li>Value: <code>0</code></li>
<li>Nickname: <code>always</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="noncurrent" href="#noncurrent"><code>CLAPPER_DISCOVERER_DISCOVERY_NONCURRENT</code></a></dt>
<dd>
<div><p>Only run discovery on an item if it is not a currently selected item in <a href="class.Queue.html"><code>ClapperQueue</code></a>.
This mode is optimal when application always plays (or at least goes into paused) after selecting item from queue.
It will skip discovery of such items since they will be discovered by <a href="class.Player.html"><code>ClapperPlayer</code></a>&nbsp;anyway.</p></div>
<ul>
<li>Value: <code>1</code></li>
<li>Nickname: <code>noncurrent</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
</dl>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#members"><span class="link-text">Members</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

57
doc/clapper/enum.PlayerSeekMethod.html
View File

@@ -88,7 +88,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -145,28 +145,39 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</h4>
<div class="docblock">
<table class="enum-members">
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><a id="accurate" href="#accurate"><code title="Value: 0">CLAPPER_PLAYER_SEEK_METHOD_ACCURATE</code></a></td>
<td><p>Seek to exact position&nbsp;(slow).</p></td>
</tr>
<tr>
<td><a id="normal" href="#normal"><code title="Value: 1">CLAPPER_PLAYER_SEEK_METHOD_NORMAL</code></a></td>
<td><p>Seek to approximated&nbsp;position.</p></td>
</tr>
<tr>
<td><a id="fast" href="#fast"><code title="Value: 2">CLAPPER_PLAYER_SEEK_METHOD_FAST</code></a></td>
<td><p>Seek to position of nearest keyframe&nbsp;(fast).</p></td>
</tr>
</table>
<dl class="enum-members">
<dt><a id="accurate" href="#accurate"><code>CLAPPER_PLAYER_SEEK_METHOD_ACCURATE</code></a></dt>
<dd>
<div><p>Seek to exact position&nbsp;(slow).</p></div>
<ul>
<li>Value: <code>0</code></li>
<li>Nickname: <code>accurate</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="normal" href="#normal"><code>CLAPPER_PLAYER_SEEK_METHOD_NORMAL</code></a></dt>
<dd>
<div><p>Seek to approximated&nbsp;position.</p></div>
<ul>
<li>Value: <code>1</code></li>
<li>Nickname: <code>normal</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="fast" href="#fast"><code>CLAPPER_PLAYER_SEEK_METHOD_FAST</code></a></dt>
<dd>
<div><p>Seek to position of nearest keyframe&nbsp;(fast).</p></div>
<ul>
<li>Value: <code>2</code></li>
<li>Nickname: <code>fast</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
</dl>
</div>
</div>

72
doc/clapper/enum.PlayerState.html
View File

@@ -88,7 +88,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -145,33 +145,49 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</h4>
<div class="docblock">
<table class="enum-members">
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><a id="stopped" href="#stopped"><code title="Value: 0">CLAPPER_PLAYER_STATE_STOPPED</code></a></td>
<td><p>Player is&nbsp;stopped.</p></td>
</tr>
<tr>
<td><a id="buffering" href="#buffering"><code title="Value: 1">CLAPPER_PLAYER_STATE_BUFFERING</code></a></td>
<td><p>Player is&nbsp;buffering.</p></td>
</tr>
<tr>
<td><a id="paused" href="#paused"><code title="Value: 2">CLAPPER_PLAYER_STATE_PAUSED</code></a></td>
<td><p>Player is&nbsp;paused.</p></td>
</tr>
<tr>
<td><a id="playing" href="#playing"><code title="Value: 3">CLAPPER_PLAYER_STATE_PLAYING</code></a></td>
<td><p>Player is&nbsp;playing.</p></td>
</tr>
</table>
<dl class="enum-members">
<dt><a id="stopped" href="#stopped"><code>CLAPPER_PLAYER_STATE_STOPPED</code></a></dt>
<dd>
<div><p>Player is&nbsp;stopped.</p></div>
<ul>
<li>Value: <code>0</code></li>
<li>Nickname: <code>stopped</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="buffering" href="#buffering"><code>CLAPPER_PLAYER_STATE_BUFFERING</code></a></dt>
<dd>
<div><p>Player is&nbsp;buffering.</p></div>
<ul>
<li>Value: <code>1</code></li>
<li>Nickname: <code>buffering</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="paused" href="#paused"><code>CLAPPER_PLAYER_STATE_PAUSED</code></a></dt>
<dd>
<div><p>Player is&nbsp;paused.</p></div>
<ul>
<li>Value: <code>2</code></li>
<li>Nickname: <code>paused</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="playing" href="#playing"><code>CLAPPER_PLAYER_STATE_PLAYING</code></a></dt>
<dd>
<div><p>Player is&nbsp;playing.</p></div>
<ul>
<li>Value: <code>3</code></li>
<li>Nickname: <code>playing</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
</dl>
</div>
</div>

72
doc/clapper/enum.QueueProgressionMode.html
View File

@@ -88,7 +88,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -145,33 +145,49 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</h4>
<div class="docblock">
<table class="enum-members">
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><a id="consecutive" href="#consecutive"><code title="Value: 0">CLAPPER_QUEUE_PROGRESSION_CONSECUTIVE</code></a></td>
<td><p>Queue plays items one after another until the&nbsp;end.</p></td>
</tr>
<tr>
<td><a id="repeat_item" href="#repeat_item"><code title="Value: 1">CLAPPER_QUEUE_PROGRESSION_REPEAT_ITEM</code></a></td>
<td><p>Queue keeps repeating current media&nbsp;item.</p></td>
</tr>
<tr>
<td><a id="carousel" href="#carousel"><code title="Value: 2">CLAPPER_QUEUE_PROGRESSION_CAROUSEL</code></a></td>
<td><p>Queue starts from beginning after last media&nbsp;item.</p></td>
</tr>
<tr>
<td><a id="shuffle" href="#shuffle"><code title="Value: 3">CLAPPER_QUEUE_PROGRESSION_SHUFFLE</code></a></td>
<td><p>Queue selects a random media item after current&nbsp;one.</p></td>
</tr>
</table>
<dl class="enum-members">
<dt><a id="consecutive" href="#consecutive"><code>CLAPPER_QUEUE_PROGRESSION_CONSECUTIVE</code></a></dt>
<dd>
<div><p>Queue plays items one after another until the&nbsp;end.</p></div>
<ul>
<li>Value: <code>0</code></li>
<li>Nickname: <code>consecutive</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="repeat_item" href="#repeat_item"><code>CLAPPER_QUEUE_PROGRESSION_REPEAT_ITEM</code></a></dt>
<dd>
<div><p>Queue keeps repeating current media&nbsp;item.</p></div>
<ul>
<li>Value: <code>1</code></li>
<li>Nickname: <code>repeat-item</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="carousel" href="#carousel"><code>CLAPPER_QUEUE_PROGRESSION_CAROUSEL</code></a></dt>
<dd>
<div><p>Queue starts from beginning after last media&nbsp;item.</p></div>
<ul>
<li>Value: <code>2</code></li>
<li>Nickname: <code>carousel</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
<dt><a id="shuffle" href="#shuffle"><code>CLAPPER_QUEUE_PROGRESSION_SHUFFLE</code></a></dt>
<dd>
<div><p>Queue selects a random media item after current&nbsp;one.</p></div>
<ul>
<li>Value: <code>3</code></li>
<li>Nickname: <code>shuffle</code></li>
<li>Available since: 0.0</li>
</ul>
</dd>
</dl>
</div>
</div>

4
doc/clapper/func.CHECK_VERSION.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-version.h#L79">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-version.h#L71">[src]</a>
</h4>

4
doc/clapper/func.DISCOVERER_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-discoverer.h#L34">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.h#L33">[src]</a>
</h4>

4
doc/clapper/func.ENCODE_VERSION.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-version.h#L69">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-version.h#L61">[src]</a>
</h4>

2
doc/clapper/func.FEATURE_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

4
doc/clapper/func.MEDIA_ITEM_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L34">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L36">[src]</a>
</h4>

2
doc/clapper/func.MPRIS_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

2
doc/clapper/func.PLAYER_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

2
doc/clapper/func.QUEUE_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>

196
doc/clapper/func.SERVER_CAST.html Normal file
View File

@@ -0,0 +1,196 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.SERVER_CAST</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.SERVER_CAST"/>
<meta property="og:description" content="Reference for Clapper.SERVER_CAST"/>
<meta name="twitter:title" content="Clapper.SERVER_CAST"/>
<meta name="twitter:description" content="Reference for Clapper.SERVER_CAST"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Function Macros</h5>
<div class="links">
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Function Macro</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>SERVER_CAST</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/server/clapper-server.h#L33">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_SERVER_CAST (</span>
<span class="w"> </span><span class="n">obj</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p>This function is not directly available to language bindings.</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>obj</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>-</code></p>
<p>No description available.</p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

196
doc/clapper/func.STREAM_CAST.html Normal file
View File

@@ -0,0 +1,196 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.STREAM_CAST</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.STREAM_CAST"/>
<meta property="og:description" content="Reference for Clapper.STREAM_CAST"/>
<meta name="twitter:title" content="Clapper.STREAM_CAST"/>
<meta name="twitter:description" content="Reference for Clapper.STREAM_CAST"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Function Macros</h5>
<div class="links">
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Function Macro</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>STREAM_CAST</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-stream.h#L33">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_STREAM_CAST (</span>
<span class="w"> </span><span class="n">obj</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p>This function is not directly available to language bindings.</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>obj</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>-</code></p>
<p>No description available.</p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

196
doc/clapper/func.STREAM_LIST_CAST.html Normal file
View File

@@ -0,0 +1,196 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.STREAM_LIST_CAST</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.STREAM_LIST_CAST"/>
<meta property="og:description" content="Reference for Clapper.STREAM_LIST_CAST"/>
<meta name="twitter:title" content="Clapper.STREAM_LIST_CAST"/>
<meta name="twitter:description" content="Reference for Clapper.STREAM_LIST_CAST"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Function Macros</h5>
<div class="links">
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Function Macro</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>STREAM_LIST_CAST</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-stream-list.h#L35">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_STREAM_LIST_CAST (</span>
<span class="w"> </span><span class="n">obj</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
</h4>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p>This function is not directly available to language bindings.</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>obj</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>-</code></p>
<p>No description available.</p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

4
doc/clapper/func.THREADED_OBJECT_CAST.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-threaded-object.h#L28">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-threaded-object.h#L32">[src]</a>
</h4>

198
doc/clapper/func.TIME_ARGS.html Normal file
View File

@@ -0,0 +1,198 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.TIME_ARGS</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.TIME_ARGS"/>
<meta property="og:description" content="Reference for Clapper.TIME_ARGS"/>
<meta name="twitter:title" content="Clapper.TIME_ARGS"/>
<meta name="twitter:description" content="Reference for Clapper.TIME_ARGS"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Function Macros</h5>
<div class="links">
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Function Macro</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>TIME_ARGS</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-utils.h#L51">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_TIME_ARGS (</span>
<span class="w"> </span><span class="n">t</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-utils.h#L45">[src]</a>
</h4>
<div class="docblock">
<p>Formats <code>t</code> for the <a href="const.TIME_FORMAT.html"><code>CLAPPER_TIME_FORMAT</code></a> format&nbsp;string.</p>
</div>
<div class="docblock">
<p>This function is not directly available to language bindings.</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>t</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>-</code></p>
<p><p>Time value in&nbsp;seconds.</p></p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

198
doc/clapper/func.TIME_MS_ARGS.html Normal file
View File

@@ -0,0 +1,198 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.TIME_MS_ARGS</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta property="og:title" content="Clapper.TIME_MS_ARGS"/>
<meta property="og:description" content="Reference for Clapper.TIME_MS_ARGS"/>
<meta name="twitter:title" content="Clapper.TIME_MS_ARGS"/>
<meta name="twitter:description" content="Reference for Clapper.TIME_MS_ARGS"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Function Macros</h5>
<div class="links">
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Function Macro</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>TIME_MS_ARGS</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 id="declaration" style="display:flex;">
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-utils.h#L76">[src]</a>
</h4>
<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="cp">#define CLAPPER_TIME_MS_ARGS (</span>
<span class="w"> </span><span class="n">t</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-utils.h#L70">[src]</a>
</h4>
<div class="docblock">
<p>Formats <code>t</code> for the <a href="const.TIME_MS_FORMAT.html"><code>CLAPPER_TIME_MS_FORMAT</code></a> format&nbsp;string.</p>
</div>
<div class="docblock">
<p>This function is not directly available to language bindings.</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>t</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>-</code></p>
<p><p>Time value in&nbsp;seconds.</p></p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

10
doc/clapper/func.init.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.h#L39">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.h#L48">[src]</a>
</h4>
@@ -129,7 +129,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.c#L61">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.c#L55">[src]</a>
</h4>
@@ -141,7 +141,7 @@ GStreamer before initializing Clapper itself for user convienience, so
application does not have to do so&nbsp;anymore.</p>
<p><span class="caps">WARNING</span>: This function will terminate your program if it was unable to
initialize for some reason. If you want to do some fallback logic,
use <code>clapper_init_check()</code> instead.</p>
use <a href="func.init_check.html"><code>clapper_init_check()</code></a>&nbsp;instead.</p>
</div>
<div class="docblock">
@@ -195,7 +195,7 @@ use <code>clapper_init_check()</code> instead.</p>
<tr><td>The length of the array is specified in the <code>argc</code> argument.</td></tr>
<tr><td title="transfer: full">The called function takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td title="transfer: full">The caller of the function takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td>Each element is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>

10
doc/clapper/func.init_check.html
View File

@@ -87,7 +87,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -109,7 +109,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a href="#declaration" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.h#L41">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.h#L50">[src]</a>
</h4>
@@ -129,12 +129,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.c#L86">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.c#L80">[src]</a>
</h4>
<div class="docblock">
<p>This function does the same thing as clapper_init(), but instead of
<p>This function does the same thing as <a href="func.init.html"><code>clapper_init()</code></a>, but instead of
terminating on failure it returns <code>FALSE</code> with <code>error</code> set.</p>
</div>
@@ -189,7 +189,7 @@ terminating on failure it returns <code>FALSE</code> with <code>error</code> set
<tr><td>The length of the array is specified in the <code>argc</code> argument.</td></tr>
<tr><td title="transfer: full">The called function takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td title="transfer: full">The caller of the function takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td>Each element is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>

211
doc/clapper/index.html
View File

@@ -111,28 +111,48 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Dependencies</h5>
<div class="links">
<a href="https://docs.gtk.org/glib/" class="external">GLib</a>
<a href="https://docs.gtk.org/glib/" class="external">GLib</a>
<a href="https://docs.gtk.org/gobject/" class="external">GObject</a>
<a href="https://docs.gtk.org/gobject/" class="external">GObject</a>
<a href="https://docs.gtk.org/gio/" class="external">Gio</a>
<a href="https://docs.gtk.org/gio/" class="external">Gio</a>
<a href="https://gstreamer.freedesktop.org/documentation/" class="external">Gst</a>
<a href="https://gstreamer.freedesktop.org/documentation/base/" class="external">GstBase</a>
<a href="https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html" class="external">Gst</a>
<a href="https://gstreamer.freedesktop.org/documentation/audio/" class="external">GstAudio</a>
<a href="https://gstreamer.freedesktop.org/documentation/base/" class="external">GstBase</a>
<a href="https://gstreamer.freedesktop.org/documentation/tag/" class="external">GstTag</a>
<a href="https://gstreamer.freedesktop.org/documentation/audio/" class="external">GstAudio</a>
<a href="https://gstreamer.freedesktop.org/documentation/pbutils/" class="external">GstPbutils</a>
<a href="https://gstreamer.freedesktop.org/documentation/pbutils/" class="external">GstPbutils</a>
<a href="https://gstreamer.freedesktop.org/documentation/tag/" class="external">GstTag</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -158,16 +178,22 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</table>
</div>
<div class="meta build toggle-wrapper">
<h4>Build</h4>
<div class="docblock">
<table>
<tr><td>C headers</td><td><code>clapper/clapper.h</code></td></tr>
<tr><td>pkg-config files</td><td><code>clapper-0.0</code></td></tr>
</table>
</div>
</div>
</header>
@@ -223,7 +249,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</tr>
<tr>
<td></td>
<td><a href="https://gstreamer.freedesktop.org/documentation/" class="external">Browse documentation</a></td>
<td><a href="https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html" class="external">Browse documentation</a></td>
</tr>
@@ -318,7 +344,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<td><a title="Discoverer" class="symbol" href="class.Discoverer.html">Discoverer</a></td>
<td class="docblock-summary">
<p>Clapper media scanner used to discover media item&nbsp;info.</p>
<p>An optional Discoverer feature to be added to the&nbsp;player.</p>
<p></p>
</td>
@@ -328,7 +354,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<td><a title="Feature" class="symbol" href="class.Feature.html">Feature</a></td>
<td class="docblock-summary">
<p>Represents an additional&nbsp;feature.</p>
<p>A base class for creating new features for the&nbsp;player.</p>
<p></p>
</td>
@@ -348,7 +374,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<td><a title="Mpris" class="symbol" href="class.Mpris.html">Mpris</a></td>
<td class="docblock-summary">
<p>Represents a <span class="caps">MPRIS</span>&nbsp;feature.</p>
<p>An optional <code>MPRIS</code> feature to add to the&nbsp;player.</p>
<p></p>
</td>
@@ -358,7 +384,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<td><a title="Player" class="symbol" href="class.Player.html">Player</a></td>
<td class="docblock-summary">
<p>Clapper player that uses <code>GStreamer</code> internally to play various&nbsp;media.</p>
<p>The media player object used for&nbsp;playback.</p>
<p></p>
</td>
@@ -368,7 +394,37 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<td><a title="Queue" class="symbol" href="class.Queue.html">Queue</a></td>
<td class="docblock-summary">
<p>A media playback&nbsp;queue.</p>
<p>A queue of media to be&nbsp;played.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="Server" class="symbol" href="class.Server.html">Server</a></td>
<td class="docblock-summary">
<p>An optional Server feature to add to the&nbsp;player.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="Stream" class="symbol" href="class.Stream.html">Stream</a></td>
<td class="docblock-summary">
<p>Represents a stream within&nbsp;media.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="StreamList" class="symbol" href="class.StreamList.html">StreamList</a></td>
<td class="docblock-summary">
<p>A list of media&nbsp;streams.</p>
<p></p>
</td>
@@ -406,6 +462,16 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<table style="display:block;">
<tbody>
<tr class="section-item">
<td><a title="DiscovererDiscoveryMode" class="symbol" href="enum.DiscovererDiscoveryMode.html">DiscovererDiscoveryMode</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="PlayerSeekMethod" class="symbol" href="enum.PlayerSeekMethod.html">PlayerSeekMethod</a></td>
@@ -472,7 +538,7 @@ before using Clapper <span class="caps">API</span>.</p>
<td><a title="init_check" class="symbol" href="func.init_check.html">init_check</a></td>
<td class="docblock-summary">
<p>This function does the same thing as clapper_init(), but instead of
<p>This function does the same thing as <code>clapper_init()</code>, but instead of
terminating on failure it returns <code>FALSE</code> with <code>error</code> set.</p>
<p></p>
</td>
@@ -577,6 +643,36 @@ terminating on failure it returns <code>FALSE</code> with <code>error</code> set
</tr>
<tr class="section-item">
<td><a title="SERVER_CAST" class="symbol" href="func.SERVER_CAST.html">SERVER_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="STREAM_CAST" class="symbol" href="func.STREAM_CAST.html">STREAM_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="STREAM_LIST_CAST" class="symbol" href="func.STREAM_LIST_CAST.html">STREAM_LIST_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="THREADED_OBJECT_CAST" class="symbol" href="func.THREADED_OBJECT_CAST.html">THREADED_OBJECT_CAST</a></td>
@@ -587,6 +683,26 @@ terminating on failure it returns <code>FALSE</code> with <code>error</code> set
</tr>
<tr class="section-item">
<td><a title="TIME_ARGS" class="symbol" href="func.TIME_ARGS.html">TIME_ARGS</a></td>
<td class="docblock-summary">
<p>Formats <code>t</code> for the <code>CLAPPER_TIME_FORMAT</code> format&nbsp;string.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TIME_MS_ARGS" class="symbol" href="func.TIME_MS_ARGS.html">TIME_MS_ARGS</a></td>
<td class="docblock-summary">
<p>Formats <code>t</code> for the <code>CLAPPER_TIME_MS_FORMAT</code> format&nbsp;string.</p>
<p></p>
</td>
</tr>
</tbody>
</table>
</div>
@@ -605,6 +721,16 @@ terminating on failure it returns <code>FALSE</code> with <code>error</code> set
<table style="display:block;">
<tbody>
<tr class="section-item">
<td><a title="HAVE_DISCOVERER" class="symbol" href="const.HAVE_DISCOVERER.html">HAVE_DISCOVERER</a></td>
<td class="docblock-summary">
<p>Check if Clapper was compiled with Discoverer&nbsp;feature.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="HAVE_MPRIS" class="symbol" href="const.HAVE_MPRIS.html">HAVE_MPRIS</a></td>
@@ -615,6 +741,16 @@ terminating on failure it returns <code>FALSE</code> with <code>error</code> set
</tr>
<tr class="section-item">
<td><a title="HAVE_SERVER" class="symbol" href="const.HAVE_SERVER.html">HAVE_SERVER</a></td>
<td class="docblock-summary">
<p>Check if Clapper was compiled with Server&nbsp;feature.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="MAJOR_VERSION" class="symbol" href="const.MAJOR_VERSION.html">MAJOR_VERSION</a></td>
@@ -645,6 +781,49 @@ terminating on failure it returns <code>FALSE</code> with <code>error</code> set
</tr>
<tr class="section-item">
<td><a title="QUEUE_INVALID_POSITION" class="symbol" href="const.QUEUE_INVALID_POSITION.html">QUEUE_INVALID_POSITION</a></td>
<td class="docblock-summary">
<p>The value used to refer to an invalid position in a <code>ClapperQueue</code>.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="STREAM_LIST_INVALID_POSITION" class="symbol" href="const.STREAM_LIST_INVALID_POSITION.html">STREAM_LIST_INVALID_POSITION</a></td>
<td class="docblock-summary">
<p>The value used to refer to an invalid position in a <code>ClapperStreamList</code>.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TIME_FORMAT" class="symbol" href="const.TIME_FORMAT.html">TIME_FORMAT</a></td>
<td class="docblock-summary">
<p>A string that can be used in printf-like format to display
e.g. position or duration in <code>hh:mm:ss</code> format. Meant to be
used together with <code>CLAPPER_TIME_ARGS()</code>.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TIME_MS_FORMAT" class="symbol" href="const.TIME_MS_FORMAT.html">TIME_MS_FORMAT</a></td>
<td class="docblock-summary">
<p>Same as <code>CLAPPER_TIME_FORMAT</code>, but also displays milliseconds.
Meant to be used together with <code>CLAPPER_TIME_MS_ARGS()</code>.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="VERSION_S" class="symbol" href="const.VERSION_S.html">VERSION_S</a></td>

2
doc/clapper/index.json
View File

File diff suppressed because one or more lines are too long

3
doc/clapper/main.js
View File

@@ -149,7 +149,8 @@ function onKeyDown(event) {
let potentially_hidden_parent = search_input.closest('.hidden, .devhelp-hidden');
if (window.getComputedStyle(potentially_hidden_parent).display !== 'none' &&
event.code === "KeyS" && document.activeElement !== search_input) {
(event.key === "s" || event.key === "S") &&
document.activeElement !== search_input) {
event.preventDefault();
search_input.focus();
}

211
doc/clapper/method.Discoverer.get_discovery_mode.html Normal file
View File

@@ -0,0 +1,211 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Discoverer.get_discovery_mode</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Discoverer.get_discovery_mode"/>
<meta priority="og:description" content="Reference for Clapper.Discoverer.get_discovery_mode"/>
<meta name="twitter:title" content="Clapper.Discoverer.get_discovery_mode"/>
<meta name="twitter:description" content="Reference for Clapper.Discoverer.get_discovery_mode"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Discoverer.html">Discoverer</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method current" href="method.Discoverer.get_discovery_mode.html">get_discovery_mode</a>
<a class="method" href="method.Discoverer.set_discovery_mode.html">set_discovery_mode</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Discoverer.html">Discoverer</a><span class="sep"></span>get_discovery_mode</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.h#L41">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">ClapperDiscovererDiscoveryMode</span>
<span class="n">clapper_discoverer_get_discovery_mode</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperDiscoverer</span><span class="o">*</span><span class="w"> </span><span class="n">discoverer</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.c#L394">[src]</a>
</h4>
<div class="docblock">
<p>Get the <a href="enum.DiscovererDiscoveryMode.html"><code>ClapperDiscovererDiscoveryMode</code></a> of <code>discoverer</code>.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.Discoverer.discovery-mode.html"><code>Clapper.Discoverer:discovery-mode</code></a></td></tr>
</table>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<a href="enum.DiscovererDiscoveryMode.html"><code>ClapperDiscovererDiscoveryMode</code></a></p>
<p><p>A currently set <code>ClapperDiscovererDiscoveryMode</code>.</p></p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

48
doc/clapper/method.Discoverer.discover_item.html → doc/clapper/method.Discoverer.set_discovery_mode.html
View File

@@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Discoverer.discover_item</title>
<title>Clapper.Discoverer.set_discovery_mode</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
@@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<meta priority="og:title" content="Clapper.Discoverer.discover_item"/>
<meta priority="og:description" content="Reference for Clapper.Discoverer.discover_item"/>
<meta name="twitter:title" content="Clapper.Discoverer.discover_item"/>
<meta name="twitter:description" content="Reference for Clapper.Discoverer.discover_item"/>
<meta priority="og:title" content="Clapper.Discoverer.set_discovery_mode"/>
<meta priority="og:description" content="Reference for Clapper.Discoverer.set_discovery_mode"/>
<meta name="twitter:title" content="Clapper.Discoverer.set_discovery_mode"/>
<meta name="twitter:description" content="Reference for Clapper.Discoverer.set_discovery_mode"/>
@@ -87,13 +87,15 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method current" href="method.Discoverer.discover_item.html">discover_item</a>
<a class="method" href="method.Discoverer.get_discovery_mode.html">get_discovery_mode</a>
<a class="method current" href="method.Discoverer.set_discovery_mode.html">set_discovery_mode</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -103,7 +105,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Discoverer.html">Discoverer</a><span class="sep"></span>discover_item</h1>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Discoverer.html">Discoverer</a><span class="sep"></span>set_discovery_mode</h1>
</header>
<section>
@@ -116,15 +118,15 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-discoverer.h#L58">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.h#L39">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="n">clapper_discoverer_discover_item</span><span class="w"> </span><span class="p">(</span>
<span class="n">clapper_discoverer_set_discovery_mode</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperDiscoverer</span><span class="o">*</span><span class="w"> </span><span class="n">discoverer</span><span class="p">,</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span>
<span class="w"> </span><span class="n">ClapperDiscovererDiscoveryMode</span><span class="w"> </span><span class="n">mode</span>
<span class="p">)</span>
</pre></div>
</code></pre>
@@ -136,16 +138,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-discoverer.c#L364">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/discoverer/clapper-discoverer.c#L371">[src]</a>
</h4>
<div class="docblock">
<p>Queues media item for&nbsp;discovery.</p>
<p>If media item is already queued for discovery or was
discovered earlier, this funcion will simply return,
so it is safe to call this multiple times when for
e.g. user is scrolling through playback&nbsp;queue.</p>
<p>Set the <a href="enum.DiscovererDiscoveryMode.html"><code>ClapperDiscovererDiscoveryMode</code></a> of <code>discoverer</code>.</p>
</div>
<div class="docblock">
@@ -158,6 +156,14 @@ e.g. user is scrolling through playback&nbsp;queue.</p>
</div>
<div class="docblock">
<table>
<tr><td>Sets property</td><td><a href="property.Discoverer.discovery-mode.html"><code>Clapper.Discoverer:discovery-mode</code></a></td></tr>
</table>
</div>
</div>
@@ -170,10 +176,10 @@ e.g. user is scrolling through playback&nbsp;queue.</p>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>item</code></dt>
<dt class="arg-name"><code>mode</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<a href="class.MediaItem.html"><code>ClapperMediaItem</code></a></p>
<p><p>A <code>ClapperMediaItem</code>.</p></p>
<p><em>Type:</em>&nbsp;<a href="enum.DiscovererDiscoveryMode.html"><code>ClapperDiscovererDiscoveryMode</code></a></p>
<p><p>A <code>ClapperDiscovererDiscoveryMode</code>.</p></p>
<table>
@@ -182,7 +188,7 @@ e.g. user is scrolling through playback&nbsp;queue.</p>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
</table>
</dd>

73
doc/clapper/method.MediaItem.set_suburis.html → doc/clapper/method.MediaItem.get_audio_streams.html
View File

@@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.MediaItem.set_suburis</title>
<title>Clapper.MediaItem.get_audio_streams</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
@@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<meta priority="og:title" content="Clapper.MediaItem.set_suburis"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.set_suburis"/>
<meta name="twitter:title" content="Clapper.MediaItem.set_suburis"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.set_suburis"/>
<meta priority="og:title" content="Clapper.MediaItem.get_audio_streams"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.get_audio_streams"/>
<meta name="twitter:title" content="Clapper.MediaItem.get_audio_streams"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.get_audio_streams"/>
@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method current" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method current" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -115,7 +117,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>set_suburis</h1>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>get_audio_streams</h1>
</header>
<section>
@@ -128,15 +130,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L53">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L58">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="n">clapper_media_item_set_suburis</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">**</span><span class="w"> </span><span class="n">suburis</span>
<pre><code><div class="highlight"><pre><span></span><span class="n">ClapperStreamList</span><span class="o">*</span>
<span class="n">clapper_media_item_get_audio_streams</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span>
<span class="p">)</span>
</pre></div>
</code></pre>
@@ -148,10 +149,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L611">[src]</a>
</h4>
<div class="docblock">
No description available.
<p>Get a list of audio streams within media&nbsp;item.</p>
</div>
<div class="docblock">
@@ -167,7 +170,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="docblock">
<table>
<tr><td>Sets property</td><td><a href="property.MediaItem.suburis.html"><code>Clapper.MediaItem:suburis</code></a></td></tr>
<tr><td>Gets property</td><td><a href="property.MediaItem.audio-streams.html"><code>Clapper.MediaItem:audio-streams</code></a></td></tr>
</table>
</div>
@@ -175,41 +178,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>suburis</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>const gchar**</code></p>
<p>No description available.</p>
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<a href="class.StreamList.html"><code>ClapperStreamList</code></a></p>
<p><p>A <code>ClapperStreamList</code> of audio <code>ClapperStream</code>.</p></p>
</div>
<div>
<table>
<tr><td title="transfer: none">The data is owned by the instance.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
</div>
</section>
</section>

14
doc/clapper/method.MediaItem.get_container_format.html
View File

@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method current" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -128,7 +130,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L59">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L52">[src]</a>
</h4>
@@ -147,7 +149,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L337">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L408">[src]</a>
</h4>

14
doc/clapper/method.MediaItem.get_duration.html
View File

@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method current" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -128,7 +130,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L61">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L54">[src]</a>
</h4>
@@ -147,7 +149,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L377">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L449">[src]</a>
</h4>

46
doc/clapper/method.MediaItem.get_suburis.html → doc/clapper/method.MediaItem.get_id.html
View File

@@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.MediaItem.get_suburis</title>
<title>Clapper.MediaItem.get_id</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
@@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<meta priority="og:title" content="Clapper.MediaItem.get_suburis"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.get_suburis"/>
<meta name="twitter:title" content="Clapper.MediaItem.get_suburis"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.get_suburis"/>
<meta priority="og:title" content="Clapper.MediaItem.get_id"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.get_id"/>
<meta name="twitter:title" content="Clapper.MediaItem.get_id"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.get_id"/>
@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method current" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method current" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -115,7 +117,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>get_suburis</h1>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>get_id</h1>
</header>
<section>
@@ -128,13 +130,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L55">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L46">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">gchar</span><span class="o">**</span>
<span class="n">clapper_media_item_get_suburis</span><span class="w"> </span><span class="p">(</span>
<pre><code><div class="highlight"><pre><span></span><span class="n">guint</span>
<span class="n">clapper_media_item_get_id</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span>
<span class="p">)</span>
</pre></div>
@@ -147,17 +149,19 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L317">[src]</a>
</h4>
<div class="docblock">
No description available.
<p>Get the unique <span class="caps">ID</span> of <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
<p>This method is not directly available to language bindings.</p>
</div>
@@ -166,7 +170,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.MediaItem.suburis.html"><code>Clapper.MediaItem:suburis</code></a></td></tr>
<tr><td>Gets property</td><td><a href="property.MediaItem.id.html"><code>Clapper.MediaItem:id</code></a></td></tr>
</table>
</div>
@@ -185,17 +189,17 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;An array of&nbsp;<code>utf8</code></p>
<p>No description available.</p>
<p><em>Type:</em>&nbsp;<code>guint</code></p>
<p><p>An <span class="caps">ID</span> of <code>ClapperMediaItem</code>.</p></p>
</div>
<div>
<table>
<tr><td>The array is <code>NULL</code>-terminated.</td></tr>
<tr><td title="transfer: none">The data is owned by the instance.</td></tr>
<tr><td>Each element is a NUL terminated UTF-8 string.</td></tr>
</table>
</div>
</div>

223
doc/clapper/method.MediaItem.get_subtitle_streams.html Normal file
View File

@@ -0,0 +1,223 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.MediaItem.get_subtitle_streams</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.MediaItem.get_subtitle_streams"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.get_subtitle_streams"/>
<meta name="twitter:title" content="Clapper.MediaItem.get_subtitle_streams"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.get_subtitle_streams"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.MediaItem.html">MediaItem</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method current" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>get_subtitle_streams</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L60">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">ClapperStreamList</span><span class="o">*</span>
<span class="n">clapper_media_item_get_subtitle_streams</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L627">[src]</a>
</h4>
<div class="docblock">
<p>Get a list of subtitle streams within media&nbsp;item.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.MediaItem.subtitle-streams.html"><code>Clapper.MediaItem:subtitle-streams</code></a></td></tr>
</table>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<a href="class.StreamList.html"><code>ClapperStreamList</code></a></p>
<p><p>A <code>ClapperStreamList</code> of subtitle <code>ClapperStream</code>.</p></p>
</div>
<div>
<table>
<tr><td title="transfer: none">The data is owned by the instance.</td></tr>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

14
doc/clapper/method.MediaItem.get_title.html
View File

@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method current" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -128,7 +130,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L57">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L50">[src]</a>
</h4>
@@ -147,7 +149,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L296">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L365">[src]</a>
</h4>

14
doc/clapper/method.MediaItem.get_uri.html
View File

@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method current" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -128,7 +130,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L49">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L48">[src]</a>
</h4>
@@ -147,7 +149,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L213">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L333">[src]</a>
</h4>

79
doc/clapper/method.MediaItem.append_suburi.html → doc/clapper/method.MediaItem.get_video_streams.html
View File

@@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.MediaItem.append_suburi</title>
<title>Clapper.MediaItem.get_video_streams</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
@@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<meta priority="og:title" content="Clapper.MediaItem.append_suburi"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.append_suburi"/>
<meta name="twitter:title" content="Clapper.MediaItem.append_suburi"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.append_suburi"/>
<meta priority="og:title" content="Clapper.MediaItem.get_video_streams"/>
<meta priority="og:description" content="Reference for Clapper.MediaItem.get_video_streams"/>
<meta name="twitter:title" content="Clapper.MediaItem.get_video_streams"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem.get_video_streams"/>
@@ -87,25 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<h5>Methods</h5>
<div class="links">
<a class="method current" href="method.MediaItem.append_suburi.html">append_suburi</a>
<a class="method" href="method.MediaItem.get_audio_streams.html">get_audio_streams</a>
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_suburis.html">get_suburis</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_subtitle_streams.html">get_subtitle_streams</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburis.html">set_suburis</a>
<a class="method current" href="method.MediaItem.get_video_streams.html">get_video_streams</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -115,7 +117,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>append_suburi</h1>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.MediaItem.html">MediaItem</a><span class="sep"></span>get_video_streams</h1>
</header>
<section>
@@ -128,15 +130,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L51">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.h#L56">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="n">clapper_media_item_append_suburi</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">suburi</span>
<pre><code><div class="highlight"><pre><span></span><span class="n">ClapperStreamList</span><span class="o">*</span>
<span class="n">clapper_media_item_get_video_streams</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMediaItem</span><span class="o">*</span><span class="w"> </span><span class="n">item</span>
<span class="p">)</span>
</pre></div>
</code></pre>
@@ -148,10 +149,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-media-item.c#L595">[src]</a>
</h4>
<div class="docblock">
No description available.
<p>Get a list of video streams within media&nbsp;item.</p>
</div>
<div class="docblock">
@@ -164,44 +167,46 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.MediaItem.video-streams.html"><code>Clapper.MediaItem:video-streams</code></a></td></tr>
</table>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>suburi</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>const gchar*</code></p>
<p>No description available.</p>
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<a href="class.StreamList.html"><code>ClapperStreamList</code></a></p>
<p><p>A <code>ClapperStreamList</code> of video <code>ClapperStream</code>.</p></p>
</div>
<div>
<table>
<tr><td title="transfer: none">The data is owned by the instance.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
</div>
</section>
</section>

12
doc/clapper/method.Mpris.get_fallback_art_url.html
View File

@@ -89,13 +89,17 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method current" href="method.Mpris.get_fallback_art_url.html">get_fallback_art_url</a>
<a class="method" href="method.Mpris.get_queue_controllable.html">get_queue_controllable</a>
<a class="method" href="method.Mpris.set_fallback_art_url.html">set_fallback_art_url</a>
<a class="method" href="method.Mpris.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -118,7 +122,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L47">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L46">[src]</a>
</h4>
@@ -137,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1293">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1431">[src]</a>
</h4>
@@ -186,7 +190,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: full">The caller of the method takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td>The return value can be <code>NULL</code>.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</div>

215
doc/clapper/method.Mpris.get_queue_controllable.html Normal file
View File

@@ -0,0 +1,215 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Mpris.get_queue_controllable</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Mpris.get_queue_controllable"/>
<meta priority="og:description" content="Reference for Clapper.Mpris.get_queue_controllable"/>
<meta name="twitter:title" content="Clapper.Mpris.get_queue_controllable"/>
<meta name="twitter:description" content="Reference for Clapper.Mpris.get_queue_controllable"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Mpris.html">Mpris</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Mpris.get_fallback_art_url.html">get_fallback_art_url</a>
<a class="method current" href="method.Mpris.get_queue_controllable.html">get_queue_controllable</a>
<a class="method" href="method.Mpris.set_fallback_art_url.html">set_fallback_art_url</a>
<a class="method" href="method.Mpris.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Mpris.html">Mpris</a><span class="sep"></span>get_queue_controllable</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L42">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">gboolean</span>
<span class="n">clapper_mpris_get_queue_controllable</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMpris</span><span class="o">*</span><span class="w"> </span><span class="n">mpris</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1393">[src]</a>
</h4>
<div class="docblock">
<p>Get whether remote <code>MPRIS</code> clients can control <a href="class.Queue.html"><code>ClapperQueue</code></a>.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.Mpris.queue-controllable.html"><code>Clapper.Mpris:queue-controllable</code></a></td></tr>
</table>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<code>gboolean</code></p>
<p><p><code>TRUE</code> if control over <code>ClapperQueue</code> is allowed, <code>FALSE</code> otherwise.</p></p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

12
doc/clapper/method.Mpris.set_fallback_art_url.html
View File

@@ -89,13 +89,17 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Mpris.get_fallback_art_url.html">get_fallback_art_url</a>
<a class="method" href="method.Mpris.get_queue_controllable.html">get_queue_controllable</a>
<a class="method current" href="method.Mpris.set_fallback_art_url.html">set_fallback_art_url</a>
<a class="method" href="method.Mpris.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -118,7 +122,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L45">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L44">[src]</a>
</h4>
@@ -138,7 +142,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1272">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1409">[src]</a>
</h4>
@@ -188,7 +192,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>

227
doc/clapper/method.Mpris.set_queue_controllable.html Normal file
View File

@@ -0,0 +1,227 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Mpris.set_queue_controllable</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Mpris.set_queue_controllable"/>
<meta priority="og:description" content="Reference for Clapper.Mpris.set_queue_controllable"/>
<meta name="twitter:title" content="Clapper.Mpris.set_queue_controllable"/>
<meta name="twitter:description" content="Reference for Clapper.Mpris.set_queue_controllable"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Mpris.html">Mpris</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Mpris.get_fallback_art_url.html">get_fallback_art_url</a>
<a class="method" href="method.Mpris.get_queue_controllable.html">get_queue_controllable</a>
<a class="method" href="method.Mpris.set_fallback_art_url.html">set_fallback_art_url</a>
<a class="method current" href="method.Mpris.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Mpris.html">Mpris</a><span class="sep"></span>set_queue_controllable</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.h#L40">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="n">clapper_mpris_set_queue_controllable</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperMpris</span><span class="o">*</span><span class="w"> </span><span class="n">mpris</span><span class="p">,</span>
<span class="w"> </span><span class="n">gboolean</span><span class="w"> </span><span class="n">controllable</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/features/mpris/clapper-mpris.c#L1366">[src]</a>
</h4>
<div class="docblock">
<p>Set whether remote <span class="caps">MPRIS</span> clients can control <code>ClapperQueue</code>.</p>
<p>This includes ability to open new URIs, adding/removing
items from the queue and selecting current item for
playback remotely using <span class="caps">MPRIS</span>&nbsp;interface.</p>
<p>You probably want to keep this disabled if your application
is supposed to manage what is played now and not <span class="caps">MPRIS</span>&nbsp;client.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Sets property</td><td><a href="property.Mpris.queue-controllable.html"><code>Clapper.Mpris:queue-controllable</code></a></td></tr>
</table>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>controllable</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>gboolean</code></p>
<p><p>If <code>ClapperQueue</code> should be&nbsp;controllable.</p></p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

8
doc/clapper/method.Player.add_feature.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L94">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L89">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L918">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L908">[src]</a>
</h4>
@@ -228,7 +228,7 @@ so it is safe to call multiple times if&nbsp;unsure.</p>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

6
doc/clapper/method.Player.get_audio_filter.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L78">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L73">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L767">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L756">[src]</a>
</h4>

6
doc/clapper/method.Player.get_audio_sink.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L70">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L65">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L713">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L702">[src]</a>
</h4>

6
doc/clapper/method.Player.get_current_audio_decoder.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L82">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L77">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L803">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L792">[src]</a>
</h4>

6
doc/clapper/method.Player.get_current_video_decoder.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L80">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L75">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L781">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L770">[src]</a>
</h4>

6
doc/clapper/method.Player.get_mute.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L54">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L49">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L547">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L536">[src]</a>
</h4>

6
doc/clapper/method.Player.get_position.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L48">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L43">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L481">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L470">[src]</a>
</h4>

6
doc/clapper/method.Player.get_queue.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L46">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L41">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L462">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L451">[src]</a>
</h4>

6
doc/clapper/method.Player.get_speed.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L62">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L57">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L624">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L613">[src]</a>
</h4>

6
doc/clapper/method.Player.get_state.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L50">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L45">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L505">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L494">[src]</a>
</h4>

6
doc/clapper/method.Player.get_video_filter.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L74">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L69">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L740">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L729">[src]</a>
</h4>

6
doc/clapper/method.Player.get_video_sink.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L66">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L61">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L686">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L675">[src]</a>
</h4>

6
doc/clapper/method.Player.get_volume.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L58">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L53">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L588">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L577">[src]</a>
</h4>

6
doc/clapper/method.Player.pause.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L86">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L81">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L842">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L831">[src]</a>
</h4>

6
doc/clapper/method.Player.play.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L84">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L79">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L825">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L814">[src]</a>
</h4>

6
doc/clapper/method.Player.seek.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L90">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L85">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L877">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L866">[src]</a>
</h4>

10
doc/clapper/method.Player.seek_custom.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L92">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L87">[src]</a>
</h4>
@@ -185,14 +185,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L899">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L888">[src]</a>
</h4>
<div class="docblock">
<p>Request the player to perform a seek&nbsp;operation.</p>
<p>Same as clapper_player_seek(), but also allows to specify
<code>ClapperPlayerSeekMethod</code> to use for seek&nbsp;operation.</p>
<code>ClapperPlayerSeekMethod</code> to use for&nbsp;seek.</p>
</div>
<div class="docblock">
@@ -237,7 +237,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<dt class="arg-name"><code>method</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<a href="enum.PlayerSeekMethod.html"><code>ClapperPlayerSeekMethod</code></a></p>
<p>No description available.</p>
<p><p>A <code>ClapperPlayerSeekMethod</code>.</p></p>
<table>

8
doc/clapper/method.Player.set_audio_filter.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L76">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L71">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L754">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L743">[src]</a>
</h4>
@@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

8
doc/clapper/method.Player.set_audio_sink.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L68">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L63">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L700">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L689">[src]</a>
</h4>
@@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

6
doc/clapper/method.Player.set_mute.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L52">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L47">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L527">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L516">[src]</a>
</h4>

6
doc/clapper/method.Player.set_speed.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L60">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L55">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L608">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L597">[src]</a>
</h4>

8
doc/clapper/method.Player.set_video_filter.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L72">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L67">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L727">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L716">[src]</a>
</h4>
@@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

8
doc/clapper/method.Player.set_video_sink.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L64">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L59">[src]</a>
</h4>
@@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L673">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L662">[src]</a>
</h4>
@@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

8
doc/clapper/method.Player.set_volume.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L56">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L51">[src]</a>
</h4>
@@ -184,13 +184,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L569">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L558">[src]</a>
</h4>
<div class="docblock">
<p>Set the volume of the&nbsp;player.</p>
<p>The value should be within 0 - 1.5 range, where 1.0 is 100%
<p>The value should be within 0 - 2.0 range, where 1.0 is 100%
volume and anything above results with an&nbsp;overamplification.</p>
</div>

6
doc/clapper/method.Player.stop.html
View File

@@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L88">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.h#L83">[src]</a>
</h4>
@@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L860">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-player.c#L849">[src]</a>
</h4>

28
doc/clapper/method.Queue.add_item.html
View File

@@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
@@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L45">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L47">[src]</a>
</h4>
@@ -160,7 +180,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L161">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L395">[src]</a>
</h4>
@@ -204,7 +224,7 @@ so it is safe to call multiple times if&nbsp;unsure.</p>
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

26
doc/clapper/method.Queue.clear.html
View File

@@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
@@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L51">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L59">[src]</a>
</h4>
@@ -159,7 +179,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L256">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L601">[src]</a>
</h4>

28
doc/clapper/method.Queue.find_item.html
View File

@@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method current" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
@@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L63">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L77">[src]</a>
</h4>
@@ -161,7 +181,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L441">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L844">[src]</a>
</h4>
@@ -203,7 +223,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>

254
doc/clapper/method.Queue.get_current_index.html Normal file
View File

@@ -0,0 +1,254 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Queue.get_current_index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Queue.get_current_index"/>
<meta priority="og:description" content="Reference for Clapper.Queue.get_current_index"/>
<meta name="twitter:title" content="Clapper.Queue.get_current_index"/>
<meta name="twitter:description" content="Reference for Clapper.Queue.get_current_index"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Queue.html">Queue</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Queue.add_item.html">add_item</a>
<a class="method" href="method.Queue.clear.html">clear</a>
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method current" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
<a class="method" href="method.Queue.get_progression_mode.html">get_progression_mode</a>
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Queue.html">Queue</a><span class="sep"></span>get_current_index</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L73">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">guint</span>
<span class="n">clapper_queue_get_current_index</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperQueue</span><span class="o">*</span><span class="w"> </span><span class="n">queue</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L797">[src]</a>
</h4>
<div class="docblock">
<p>Get index of the currently selected <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.Queue.current-index.html"><code>Clapper.Queue:current-index</code></a></td></tr>
</table>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<code>guint</code></p>
<p><p>Current item index or #CLAPPER_QUEUE_INVALID_POSITION
when nothing is&nbsp;selected.</p></p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

28
doc/clapper/method.Queue.get_current_item.html
View File

@@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method current" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
@@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L61">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L71">[src]</a>
</h4>
@@ -159,7 +179,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L414">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L770">[src]</a>
</h4>
@@ -208,7 +228,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<tr><td title="transfer: full">The caller of the method takes ownership of the data, and is responsible for freeing it.</td></tr>
<tr><td>The return value can be <code>NULL</code>.</td></tr>
</table>
</div>

253
doc/clapper/method.Queue.get_gapless.html Normal file
View File

@@ -0,0 +1,253 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Queue.get_gapless</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Queue.get_gapless"/>
<meta priority="og:description" content="Reference for Clapper.Queue.get_gapless"/>
<meta name="twitter:title" content="Clapper.Queue.get_gapless"/>
<meta name="twitter:description" content="Reference for Clapper.Queue.get_gapless"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Queue.html">Queue</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Queue.add_item.html">add_item</a>
<a class="method" href="method.Queue.clear.html">clear</a>
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method current" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
<a class="method" href="method.Queue.get_progression_mode.html">get_progression_mode</a>
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Queue.html">Queue</a><span class="sep"></span>get_gapless</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L87">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">gboolean</span>
<span class="n">clapper_queue_get_gapless</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperQueue</span><span class="o">*</span><span class="w"> </span><span class="n">queue</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L985">[src]</a>
</h4>
<div class="docblock">
<p>Get if <code>ClapperQueue</code> is set to use gapless&nbsp;progression.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.Queue.gapless.html"><code>Clapper.Queue:gapless</code></a></td></tr>
</table>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<code>gboolean</code></p>
<p><p><code>TRUE</code> if enabled, <code>FALSE</code> otherwise.</p></p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

253
doc/clapper/method.Queue.get_instant.html Normal file
View File

@@ -0,0 +1,253 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Queue.get_instant</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Queue.get_instant"/>
<meta priority="og:description" content="Reference for Clapper.Queue.get_instant"/>
<meta name="twitter:title" content="Clapper.Queue.get_instant"/>
<meta name="twitter:description" content="Reference for Clapper.Queue.get_instant"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Queue.html">Queue</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Queue.add_item.html">add_item</a>
<a class="method" href="method.Queue.clear.html">clear</a>
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method current" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
<a class="method" href="method.Queue.get_progression_mode.html">get_progression_mode</a>
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Queue.html">Queue</a><span class="sep"></span>get_instant</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.h#L91">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">gboolean</span>
<span class="n">clapper_queue_get_instant</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperQueue</span><span class="o">*</span><span class="w"> </span><span class="n">queue</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper-queue.c#L1043">[src]</a>
</h4>
<div class="docblock">
<p>Get if <code>ClapperQueue</code> is set to use instant media item&nbsp;changes.</p>
</div>
<div class="docblock">
</div>
<div class="docblock">
<table>
<tr><td>Gets property</td><td><a href="property.Queue.instant.html"><code>Clapper.Queue:instant</code></a></td></tr>
</table>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<code>gboolean</code></p>
<p><p><code>TRUE</code> if enabled, <code>FALSE</code> otherwise.</p></p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More