mirror of
https://github.com/Rafostar/clapper.git
synced 2025-08-31 08:21:59 +02:00
615 lines
18 KiB
HTML
615 lines
18 KiB
HTML
<!--
|
|
SPDX-FileCopyrightText: Rafał Dzięgiel
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
|
-->
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Clapper.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.Discoverer"/>
|
|
<meta property="og:description" content="Reference for Clapper.Discoverer"/>
|
|
<meta name="twitter:title" content="Clapper.Discoverer"/>
|
|
<meta name="twitter:description" content="Reference for Clapper.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>Type</h5>
|
|
<div class="links">
|
|
<a class="current" href="class.Discoverer.html#description">Discoverer</a>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="section">
|
|
<h5>Constructors</h5>
|
|
<div class="links">
|
|
|
|
<a class="ctor" href="ctor.Discoverer.new.html">new</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="section">
|
|
<h5>Instance methods</h5>
|
|
<div class="links">
|
|
|
|
<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.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>Discoverer</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/src/lib/clapper/features/discoverer/clapper-discoverer.c#L20">[src]</a>
|
|
|
|
</h4>
|
|
|
|
<pre><code>final class Clapper.Discoverer : Clapper.Feature
|
|
{
|
|
/* No available fields */
|
|
}</pre></code>
|
|
|
|
<div class="docblock">
|
|
<p>An optional Discoverer feature to be added to the 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, etc.</p>
|
|
<p>Please note that media items are also discovered during their playback
|
|
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 queue.</p>
|
|
<p>Depending on your application, you can select an optimal
|
|
<a href="enum.DiscovererDiscoveryMode.html"><code>ClapperDiscovererDiscoveryMode</code></a> that best suits your 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 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.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 8.1.0 (20230707.0739)
|
|
-->
|
|
<!-- Title: hierarchy Pages: 1 -->
|
|
<svg width="129pt" height="332pt"
|
|
viewBox="0.00 0.00 129.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="M107.5,-36C107.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 107.5,0 107.5,0 113.5,0 119.5,-6 119.5,-12 119.5,-12 119.5,-24 119.5,-24 119.5,-30 113.5,-36 107.5,-36"/>
|
|
<text text-anchor="middle" x="60.5" y="-12.95" 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="M98.12,-108C98.12,-108 22.88,-108 22.88,-108 16.88,-108 10.88,-102 10.88,-96 10.88,-96 10.88,-84 10.88,-84 10.88,-78 16.88,-72 22.88,-72 22.88,-72 98.12,-72 98.12,-72 104.12,-72 110.12,-78 110.12,-84 110.12,-84 110.12,-96 110.12,-96 110.12,-102 104.12,-108 98.12,-108"/>
|
|
<text text-anchor="middle" x="60.5" y="-84.95" font-family="Times,serif" font-size="14.00">ClapperFeature</text>
|
|
</a>
|
|
</g>
|
|
</g>
|
|
<!-- ancestor_0--this -->
|
|
<g id="edge4" class="edge">
|
|
<title>ancestor_0--this</title>
|
|
<path fill="none" stroke="black" d="M60.5,-71.7C60.5,-60.85 60.5,-46.92 60.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="M83.88,-180C83.88,-180 37.12,-180 37.12,-180 31.12,-180 25.12,-174 25.12,-168 25.12,-168 25.12,-156 25.12,-156 25.12,-150 31.12,-144 37.12,-144 37.12,-144 83.88,-144 83.88,-144 89.88,-144 95.88,-150 95.88,-156 95.88,-156 95.88,-168 95.88,-168 95.88,-174 89.88,-180 83.88,-180"/>
|
|
<text text-anchor="middle" x="60.5" y="-156.95" font-family="Times,serif" font-size="14.00">GstObject</text>
|
|
</a>
|
|
</g>
|
|
</g>
|
|
<!-- ancestor_1--ancestor_0 -->
|
|
<g id="edge3" class="edge">
|
|
<title>ancestor_1--ancestor_0</title>
|
|
<path fill="none" stroke="black" d="M60.5,-143.7C60.5,-132.85 60.5,-118.92 60.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="M109,-252C109,-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 109,-216 109,-216 115,-216 121,-222 121,-228 121,-228 121,-240 121,-240 121,-246 115,-252 109,-252"/>
|
|
<text text-anchor="middle" x="60.5" y="-228.95" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
|
|
</a>
|
|
</g>
|
|
</g>
|
|
<!-- ancestor_2--ancestor_1 -->
|
|
<g id="edge2" class="edge">
|
|
<title>ancestor_2--ancestor_1</title>
|
|
<path fill="none" stroke="black" d="M60.5,-215.7C60.5,-204.85 60.5,-190.92 60.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="M79.38,-324C79.38,-324 41.62,-324 41.62,-324 35.62,-324 29.62,-318 29.62,-312 29.62,-312 29.62,-300 29.62,-300 29.62,-294 35.62,-288 41.62,-288 41.62,-288 79.38,-288 79.38,-288 85.38,-288 91.38,-294 91.38,-300 91.38,-300 91.38,-312 91.38,-312 91.38,-318 85.38,-324 79.38,-324"/>
|
|
<text text-anchor="middle" x="60.5" y="-300.95" font-family="Times,serif" font-size="14.00">GObject</text>
|
|
</a>
|
|
</g>
|
|
</g>
|
|
<!-- ancestor_3--ancestor_2 -->
|
|
<g id="edge1" class="edge">
|
|
<title>ancestor_3--ancestor_2</title>
|
|
<path fill="none" stroke="black" d="M60.5,-287.7C60.5,-276.85 60.5,-262.92 60.5,-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.Discoverer.new.html">clapper_discoverer_new</a></h6>
|
|
<div class="docblock">
|
|
<p>Creates a new <code>ClapperDiscoverer</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.Discoverer.get_discovery_mode.html">clapper_discoverer_get_discovery_mode</a></h6>
|
|
<div class="docblock">
|
|
<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>
|
|
</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 <a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="Gst">GstObject</a> 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 <a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a> 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.Discoverer.discovery-mode.html">Clapper.Discoverer:discovery-mode</a></h6>
|
|
<div class="docblock">
|
|
<p>Discoverer discovery 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>
|
|
<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 ‘parent’
|
|
property, we don’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 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 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 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 ClapperDiscovererClass {
|
|
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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
|
|
|
|
<section id="search" class="content hidden"></section>
|
|
|
|
<footer>
|
|
|
|
</footer>
|
|
</div>
|
|
</body>
|
|
</html> |