Files
clapper/doc/clapper/iface.Extractable.html
github-actions[bot] aa00d3cd4d doc: Update
2025-07-26 16:11:43 +00:00

307 lines
6.7 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Extractable</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.Extractable"/>
<meta property="og:description" content="Reference for Clapper.Extractable"/>
<meta name="twitter:title" content="Clapper.Extractable"/>
<meta name="twitter:description" content="Reference for Clapper.Extractable"/>
<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">
<a href="index.html"><img src="clapper-logo.svg" class="logo"/></a>
</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.9.1</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="iface.Extractable.html#description">Extractable</a>
</div>
</div>
<div class="section">
<h5>Virtual methods</h5>
<div class="links">
<a class="method" href="vfunc.Extractable.extract.html">extract</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2025.4</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Interface</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span>Extractable</h1>
</header>
<section>
<summary>
<div class="docblock">
<p><span class="emblem available">since: 0.8</span></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/clapper-extractable.c#L19">[src]</a>
</h4>
<pre><code>interface Clapper.Extractable : GObject.Object</code></pre>
<div class="docblock">
<p>An interface for creating enhancers that resolve given <span class="caps">URI</span> into something&nbsp;playable.</p>
</div>
<div class="docblock">
<p>Available since: 0.8</p>
</div>
</div>
</summary>
<div class="toggle-wrapper prerequisite">
<h4 id="prerequisite">
Prerequisite
<a href="#prerequisite" class="anchor"></a>
</h4>
<div class="docblock">
<p>In order to implement Extractable, your type must inherit from<a data-namespace="GObject" data-link="class.Object.html" href="javascript:void(0)" class="external"><code>GObject</code></a>.</p>
</div>
</div>
<div class="interface toggle-wrapper default-hide">
<h4 style="display:flex;" id="interface-struct">
Interface structure
<a href="#interface-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ClapperExtractableInterface {
GTypeInterface parent_iface;
gboolean (* extract) (
ClapperExtractable* extractable,
GUri* uri,
ClapperHarvest* harvest,
GCancellable* cancellable,
GError** error
);
}</code></pre>
</div>
<div class="docblock">
<p>No description available.</p>
</div>
<div class="docblock">
<h6>Interface members</h6>
<table>
<tr>
<td style="vertical-align:top"><code>parent_iface</code></td>
<td style="vertical-align:top"><pre><code>GTypeInterface</code></pre></td>
</tr>
<tr>
<td>&nbsp;</td><td style="vertical-align:top"><p>The parent interface&nbsp;structure.</p></td>
</tr>
<tr>
<td style="vertical-align:top"><code>extract</code></td>
<td style="vertical-align:top"><pre><code>gboolean (* extract) (
ClapperExtractable* extractable,
GUri* uri,
ClapperHarvest* harvest,
GCancellable* cancellable,
GError** error
)</code></pre></td>
</tr>
<tr>
<td>&nbsp;</td><td style="vertical-align:top"><p>Extract data and fill&nbsp;harvest.</p></td>
</tr>
</table>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="virtual-methods">
Virtual methods
<a href="#virtual-methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6 id="vfunc-extract"><a href="vfunc.Extractable.extract.html">Clapper.Extractable.extract</a></h6>
<div class="docblock">
<p>Extract data and fill&nbsp;harvest.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.8</span></p>
</div>
</div>
</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="#virtual-methods"><span class="link-text">Virtual methods</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>