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

228 lines
6.4 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Reactable.queue_remove_sync</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.Reactable.queue_remove_sync"/>
<meta priority="og:description" content="Reference for Clapper.Reactable.queue_remove_sync"/>
<meta name="twitter:title" content="Clapper.Reactable.queue_remove_sync"/>
<meta name="twitter:description" content="Reference for Clapper.Reactable.queue_remove_sync"/>
<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 href="iface.Reactable.html">Reactable</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Reactable.get_player.html">get_player</a>
<a class="method" href="method.Reactable.queue_append_sync.html">queue_append_sync</a>
<a class="method" href="method.Reactable.queue_clear_sync.html">queue_clear_sync</a>
<a class="method" href="method.Reactable.queue_insert_sync.html">queue_insert_sync</a>
<a class="method current" href="method.Reactable.queue_remove_sync.html">queue_remove_sync</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>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="iface.Reactable.html">Reactable</a><span class="sep"></span>queue_remove_sync</h1>
</header>
<section>
<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: 0.10</span></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/src/lib/clapper/clapper-reactable.h#L223">[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_reactable_queue_remove_sync</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperReactable</span><span class="o">*</span><span class="w"> </span><span class="n">reactable</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/src/lib/clapper/clapper-reactable.c#L150">[src]</a>
</h4>
<div class="docblock">
<p>A convenience function that within application main thread synchronously removes
an <code>item</code> from the playback queue of the player that <code>reactable</code> belongs&nbsp;to.</p>
<p>Reactable enhancers should only modify the queue from the application
main thread, switching thread either themselves or using this convenience
function that does&nbsp;so.</p>
<p>Note that this function will do no operation if called when there is no player
set yet (e.g. inside enhancer construction) or if enhancer outlived the parent
instance somehow. Both cases are considered to be implementation&nbsp;bug.</p>
</div>
<div class="docblock">
<p>Available since: 0.10</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>item</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<a href="class.MediaItem.html"><code>ClapperMediaItem</code></a></p>
<p>A <code>ClapperMediaItem</code>.</p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>