mirror of
https://github.com/Rafostar/clapper.git
synced 2026-01-15 08:20:35 +01:00
1186 lines
35 KiB
HTML
1186 lines
35 KiB
HTML
<!--
|
|
SPDX-FileCopyrightText: Rafał Dzięgiel
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
|
-->
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Clapper – 0.0</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-0.0"/>
|
|
<meta property="og:description" content="Reference for Clapper-0.0"/>
|
|
<meta name="twitter:title" content="Clapper-0.0"/>
|
|
<meta name="twitter:description" content="Reference for Clapper-0.0"/>
|
|
|
|
|
|
|
|
<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.0</p>
|
|
|
|
</div>
|
|
|
|
<div class="section">
|
|
<h5>Sections</h5>
|
|
<div class="links">
|
|
|
|
|
|
|
|
<a href="#classes">Classes</a>
|
|
|
|
|
|
<a href="#interfaces">Interfaces</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="#enums">Enumerations</a>
|
|
|
|
|
|
<a href="#bitfields">Bitfields</a>
|
|
|
|
|
|
|
|
|
|
<a href="#functions">Functions</a>
|
|
|
|
|
|
<a href="#function_macros">Function Macros</a>
|
|
|
|
|
|
<a href="#constants">Constants</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section">
|
|
<h5>Dependencies</h5>
|
|
<div class="links">
|
|
|
|
|
|
<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/gio/" class="external">Gio</a>
|
|
|
|
|
|
|
|
<a href="https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html" class="external">Gst</a>
|
|
|
|
|
|
|
|
<a href="https://gstreamer.freedesktop.org/documentation/base/" class="external">GstBase</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/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> 2025.3</p>
|
|
</div>
|
|
</nav>
|
|
|
|
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
|
|
|
|
|
|
<section id="main" class="content">
|
|
<header>
|
|
<h3>Namespace</h3>
|
|
<h1>Clapper – 0.0</h1>
|
|
|
|
<div class="description">
|
|
<p>Clapper playback library</p>
|
|
</div>
|
|
|
|
<div class="meta info">
|
|
<table>
|
|
<tr><td><em>Version</em></td><td>0.9.0</td></tr>
|
|
<tr><td><em>Authors</em></td><td>Rafał Dzięgiel</td></tr>
|
|
<tr><td><em>License</em></td><td>LGPL-2.1-or-later</td></tr>
|
|
<tr><td><em>Website</em></td><td><a href="https://rafostar.github.io/clapper/" class="external">https://rafostar.github.io/clapper/</a></td></tr>
|
|
<tr><td><em>Source</em></td><td><a href="https://github.com/Rafostar/clapper/" class="external">https://github.com/Rafostar/clapper/</a></td></tr>
|
|
</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>
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper">
|
|
<h4 id="dependencies" style="display:flex;">
|
|
Dependencies
|
|
<a href="#dependencies" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<table>
|
|
|
|
|
|
<tr>
|
|
<td><strong>GLib</strong>—2.0</td>
|
|
<td>A general-purpose, portable utility library</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://docs.gtk.org/glib/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>GObject</strong>—2.0</td>
|
|
<td>The base type system library</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://docs.gtk.org/gobject/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>Gio</strong>—2.0</td>
|
|
<td>GObject Interfaces and Objects, Networking, IPC, and I/O</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://docs.gtk.org/gio/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>Gst</strong>—1.0</td>
|
|
<td>GStreamer core library</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>GstBase</strong>—1.0</td>
|
|
<td>GStreamer base and utility classes</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://gstreamer.freedesktop.org/documentation/base/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>GstAudio</strong>—1.0</td>
|
|
<td>GStreamer audio library</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://gstreamer.freedesktop.org/documentation/audio/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>GstPbutils</strong>—1.0</td>
|
|
<td>GStreamer base utils library</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://gstreamer.freedesktop.org/documentation/pbutils/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td><strong>GstTag</strong>—1.0</td>
|
|
<td>GStreamer tag support library</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><a href="https://gstreamer.freedesktop.org/documentation/tag/" class="external">Browse documentation</a></td>
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper">
|
|
<h4 id="extra" style="display:flex;">
|
|
Additional documentation
|
|
<a href="#extra" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<ul>
|
|
|
|
<li><a href="classes_hierarchy.html">Classes Hierarchy</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="classes" class="section-header" style="display:flex;">
|
|
Classes
|
|
<a href="#classes" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<table style="display:block;">
|
|
<tbody>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="AudioStream" class="symbol" href="class.AudioStream.html">AudioStream</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Represents an audio stream within media.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Discoverer" class="symbol" href="class.Discoverer.html">Discoverer</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>An optional Discoverer feature to be added to the player.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="EnhancerProxy" class="symbol" href="class.EnhancerProxy.html">EnhancerProxy</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>An intermediary between player and enhancer plugin.</p>
|
|
<p><span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span> <span class="emblem available">since: 0.10</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="EnhancerProxyList" class="symbol" href="class.EnhancerProxyList.html">EnhancerProxyList</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>A list of enhancer proxies.</p>
|
|
<p><span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span> <span class="emblem available">since: 0.10</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Feature" class="symbol" href="class.Feature.html">Feature</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>A base class for creating new features for the player.</p>
|
|
<p><span class="emblem deprecated">deprecated: 0.10</span> </p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Harvest" class="symbol" href="class.Harvest.html">Harvest</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>An object storing data from enhancers that implement <code>ClapperExtractable</code> interface.</p>
|
|
<p><span class="emblem available">since: 0.8</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Marker" class="symbol" href="class.Marker.html">Marker</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Represents a point in timeline.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MediaItem" class="symbol" href="class.MediaItem.html">MediaItem</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Represents a media item.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Mpris" class="symbol" href="class.Mpris.html">Mpris</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>An optional <code>MPRIS</code> feature to add to the player.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Player" class="symbol" href="class.Player.html">Player</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>The media player object used for playback.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Queue" class="symbol" href="class.Queue.html">Queue</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>A queue of media to be 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 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 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 streams.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="SubtitleStream" class="symbol" href="class.SubtitleStream.html">SubtitleStream</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Represents a subtitle stream within media.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="ThreadedObject" class="symbol" href="class.ThreadedObject.html">ThreadedObject</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>A base class for creating objects that work within a separate thread.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Timeline" class="symbol" href="class.Timeline.html">Timeline</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>A media timeline filled with point markers.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="VideoStream" class="symbol" href="class.VideoStream.html">VideoStream</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Represents a video stream within media.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="interfaces" class="section-header" style="display:flex;">
|
|
Interfaces
|
|
<a href="#interfaces" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<table style="display:block;">
|
|
<tbody>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Extractable" class="symbol" href="iface.Extractable.html">Extractable</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>An interface for creating enhancers that resolve given <span class="caps">URI</span> into something playable.</p>
|
|
<p><span class="emblem available">since: 0.8</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="Reactable" class="symbol" href="iface.Reactable.html">Reactable</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>An interface for creating enhancers that react to the
|
|
playback and/or events that should influence it.</p>
|
|
<p><span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span> <span class="emblem available">since: 0.10</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="enums" class="section-header" style="display:flex;">
|
|
Enumerations
|
|
<a href="#enums" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<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="MarkerType" class="symbol" href="enum.MarkerType.html">MarkerType</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>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="PlayerState" class="symbol" href="enum.PlayerState.html">PlayerState</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="QueueProgressionMode" class="symbol" href="enum.QueueProgressionMode.html">QueueProgressionMode</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="StreamType" class="symbol" href="enum.StreamType.html">StreamType</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="bitfields" class="section-header" style="display:flex;">
|
|
Bitfields
|
|
<a href="#bitfields" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<table style="display:block;">
|
|
<tbody>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="EnhancerParamFlags" class="symbol" href="flags.EnhancerParamFlags.html">EnhancerParamFlags</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Additional <code>GParamFlags</code> to be set in enhancer plugins implementations.</p>
|
|
<p><span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span> <span class="emblem available">since: 0.10</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="ReactableItemUpdatedFlags" class="symbol" href="flags.ReactableItemUpdatedFlags.html">ReactableItemUpdatedFlags</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Flags informing which properties were updated within <code>ClapperMediaItem</code>.</p>
|
|
<p><span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span> <span class="emblem available">since: 0.10</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="functions" class="section-header" style="display:flex;">
|
|
Functions
|
|
<a href="#functions" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<table style="display:block;">
|
|
<tbody>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="enhancer_check" class="symbol" href="func.enhancer_check.html">enhancer_check</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Check if an enhancer of <code>type</code> is available for given <code>scheme</code> and <code>host</code>.</p>
|
|
<p><span class="emblem deprecated">deprecated: 0.10</span> <span class="emblem available">since: 0.8</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="get_global_enhancer_proxies" class="symbol" href="func.get_global_enhancer_proxies.html">get_global_enhancer_proxies</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Get a list of available enhancers in the form of <code>ClapperEnhancerProxy</code> objects.</p>
|
|
<p><span class="emblem available-next" title="This symbol will be available in the next stable release">unstable</span> <span class="emblem available">since: 0.10</span></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="init" class="symbol" href="func.init.html">init</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Initializes the Clapper library. Implementations must always call this
|
|
before using Clapper <span class="caps">API</span>.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<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 <code>clapper_init()</code>, but instead of
|
|
terminating on failure it returns <code>FALSE</code>.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="function_macros" class="section-header" style="display:flex;">
|
|
Function Macros
|
|
<a href="#function_macros" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<table style="display:block;">
|
|
<tbody>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="AUDIO_STREAM_CAST" class="symbol" href="func.AUDIO_STREAM_CAST.html">AUDIO_STREAM_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="CHECK_VERSION" class="symbol" href="func.CHECK_VERSION.html">CHECK_VERSION</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="DEPRECATED_FOR" class="symbol" href="func.DEPRECATED_FOR.html">DEPRECATED_FOR</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="DISCOVERER_CAST" class="symbol" href="func.DISCOVERER_CAST.html">DISCOVERER_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="ENCODE_VERSION" class="symbol" href="func.ENCODE_VERSION.html">ENCODE_VERSION</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="ENHANCER_PROXY_CAST" class="symbol" href="func.ENHANCER_PROXY_CAST.html">ENHANCER_PROXY_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="ENHANCER_PROXY_LIST_CAST" class="symbol" href="func.ENHANCER_PROXY_LIST_CAST.html">ENHANCER_PROXY_LIST_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="EXTRACTABLE_CAST" class="symbol" href="func.EXTRACTABLE_CAST.html">EXTRACTABLE_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="FEATURE_CAST" class="symbol" href="func.FEATURE_CAST.html">FEATURE_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="HARVEST_CAST" class="symbol" href="func.HARVEST_CAST.html">HARVEST_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MARKER_CAST" class="symbol" href="func.MARKER_CAST.html">MARKER_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MEDIA_ITEM_CAST" class="symbol" href="func.MEDIA_ITEM_CAST.html">MEDIA_ITEM_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MPRIS_CAST" class="symbol" href="func.MPRIS_CAST.html">MPRIS_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="PLAYER_CAST" class="symbol" href="func.PLAYER_CAST.html">PLAYER_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="QUEUE_CAST" class="symbol" href="func.QUEUE_CAST.html">QUEUE_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="REACTABLE_CAST" class="symbol" href="func.REACTABLE_CAST.html">REACTABLE_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</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="SUBTITLE_STREAM_CAST" class="symbol" href="func.SUBTITLE_STREAM_CAST.html">SUBTITLE_STREAM_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>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</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 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 string.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="TIMELINE_CAST" class="symbol" href="func.TIMELINE_CAST.html">TIMELINE_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="VIDEO_STREAM_CAST" class="symbol" href="func.VIDEO_STREAM_CAST.html">VIDEO_STREAM_CAST</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<section>
|
|
<div class="toggle-wrapper default-hide">
|
|
<h4 id="constants" class="section-header" style="display:flex;">
|
|
Constants
|
|
<a href="#constants" class="anchor"></a>
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<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 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>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Check if Clapper was compiled with <span class="caps">MPRIS</span> feature.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</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 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>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Clapper major version component.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MARKER_NO_END" class="symbol" href="const.MARKER_NO_END.html">MARKER_NO_END</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>The value used to indicate that marker does not have an ending time specified.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MICRO_VERSION" class="symbol" href="const.MICRO_VERSION.html">MICRO_VERSION</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Clapper micro version component.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="MINOR_VERSION" class="symbol" href="const.MINOR_VERSION.html">MINOR_VERSION</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Clapper minor version component.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</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>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Clapper version, encoded as a string.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
<tr class="section-item">
|
|
<td><a title="WITH_ENHANCERS_LOADER" class="symbol" href="const.WITH_ENHANCERS_LOADER.html">WITH_ENHANCERS_LOADER</a></td>
|
|
|
|
<td class="docblock-summary">
|
|
<p>Check if Clapper was compiled with Enhancers Loader functionality.</p>
|
|
<p></p>
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section id="search" class="content hidden"></section>
|
|
|
|
<footer>
|
|
|
|
</footer>
|
|
</div>
|
|
</body>
|
|
</html> |