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

doc: Upload initial ClapperGtk API reference

Browse Source
This commit is contained in:
Rafał Dzięgiel
2024-01-21 20:51:05 +01:00
parent 28fd45a300
commit e94c332364
138 changed files with 45973 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

830
doc/clapper-gtk/index.html Normal file
View File

@@ -0,0 +1,830 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>ClapperGtk &ndash; 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="ClapperGtk-0.0"/>
<meta property="og:title" content="ClapperGtk-0.0"/>
<meta property="og:description" content="Reference for ClapperGtk-0.0"/>
<meta name="twitter:title" content="ClapperGtk-0.0"/>
<meta name="twitter:description" content="Reference for ClapperGtk-0.0"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="ClapperGtk" 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">ClapperGtk</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Sections</h5>
<div class="links">
<a href="#classes">Classes</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://rafostar.github.io/clapper/doc/clapper/" class="external">Clapper</a>
<a href="https://docs.gtk.org/gtk4/" class="external">Gtk</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>Namespace</h3>
<h1>ClapperGtk &ndash; 0.0</h1>
<div class="description">
<p>Clapper GTK integration library</p>
</div>
<div class="meta info">
<table>
<tr><td><em>Version</em></td><td>0.5.2</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-gtk/clapper-gtk.h</code></td></tr>
<tr><td>pkg-config files</td><td><code>clapper-gtk-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>Clapper</strong>&mdash;0.0</td>
<td>Clapper playback library</td>
</tr>
<tr>
<td></td>
<td><a href="https://rafostar.github.io/clapper/doc/clapper/" class="external">Browse documentation</a></td>
</tr>
<tr>
<td><strong>Gtk</strong>&mdash;4.0</td>
<td>The GTK toolkit</td>
</tr>
<tr>
<td></td>
<td><a href="https://docs.gtk.org/gtk4/" class="external">Browse documentation</a></td>
</tr>
</table>
</div>
</div>
</section>
<section>
<div class="toggle-wrapper">
<h4 id="related" style="display:flex;">
Related libraries
<a href="#related" class="anchor"></a>
</h4>
<div class="docblock">
<table>
<tr>
<td><strong>GLib</strong></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></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>Gst</strong></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>
</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="Billboard" class="symbol" href="class.Billboard.html">Billboard</a></td>
<td class="docblock-summary">
<p>A layer where various messages can be&nbsp;displayed.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="Container" class="symbol" href="class.Container.html">Container</a></td>
<td class="docblock-summary">
<p>A simple container widget that holds just one&nbsp;child.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="EngageLayer" class="symbol" href="class.EngageLayer.html">EngageLayer</a></td>
<td class="docblock-summary">
<p>A layer with big <code>play</code> button, engaging user to start the&nbsp;playback.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="LeadContainer" class="symbol" href="class.LeadContainer.html">LeadContainer</a></td>
<td class="docblock-summary">
<p>A <code>ClapperGtkContainer</code> that can take priority in user interactions with the <code>ClapperGtkVideo</code>.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="NextItemButton" class="symbol" href="class.NextItemButton.html">NextItemButton</a></td>
<td class="docblock-summary">
<p>A <code>GtkButton</code> for selecting next queue&nbsp;item.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="PreviousItemButton" class="symbol" href="class.PreviousItemButton.html">PreviousItemButton</a></td>
<td class="docblock-summary">
<p>A <code>GtkButton</code> for selecting previous queue&nbsp;item.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="ProgressBar" class="symbol" href="class.ProgressBar.html">ProgressBar</a></td>
<td class="docblock-summary">
<p>A progress bar for displaying playback position and&nbsp;seeking.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="QueueSelection" class="symbol" href="class.QueueSelection.html">QueueSelection</a></td>
<td class="docblock-summary">
<p>A <code>GtkSelectionModel</code> that considers current item of <code>ClapperQueue</code> as selected&nbsp;one.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="SimpleControls" class="symbol" href="class.SimpleControls.html">SimpleControls</a></td>
<td class="docblock-summary">
<p>A minimalistic playback controls panel&nbsp;widget.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="SkipItemButton" class="symbol" href="class.SkipItemButton.html">SkipItemButton</a></td>
<td class="docblock-summary">
<p>A base class for creating buttons that skip to previous/next queue&nbsp;item.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TitleHeader" class="symbol" href="class.TitleHeader.html">TitleHeader</a></td>
<td class="docblock-summary">
<p>A header panel widget that displays current media&nbsp;title.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="ToggleFullscreenButton" class="symbol" href="class.ToggleFullscreenButton.html">ToggleFullscreenButton</a></td>
<td class="docblock-summary">
<p>A <code>GtkButton</code> for toggling fullscreen&nbsp;state.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TogglePlayButton" class="symbol" href="class.TogglePlayButton.html">TogglePlayButton</a></td>
<td class="docblock-summary">
<p>A <code>GtkButton</code> for toggling play/pause of&nbsp;playback.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="Video" class="symbol" href="class.Video.html">Video</a></td>
<td class="docblock-summary">
<p>A ready to be used <span class="caps">GTK</span> video widget implementing Clapper <span class="caps">API</span>.</p>
<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="VideoActionMask" class="symbol" href="flags.VideoActionMask.html">VideoActionMask</a></td>
<td class="docblock-summary">
<p></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="get_player_from_ancestor" class="symbol" href="func.get_player_from_ancestor.html">get_player_from_ancestor</a></td>
<td class="docblock-summary">
<p>Get <code>ClapperPlayer</code> used by <code>ClapperGtkVideoPlayer</code> ancestor of <code>widget</code>.</p>
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="get_resource" class="symbol" href="func.get_resource.html">get_resource</a></td>
<td class="docblock-summary">
<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="BILLBOARD_CAST" class="symbol" href="func.BILLBOARD_CAST.html">BILLBOARD_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="CONTAINER_CAST" class="symbol" href="func.CONTAINER_CAST.html">CONTAINER_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="ENGAGE_LAYER_CAST" class="symbol" href="func.ENGAGE_LAYER_CAST.html">ENGAGE_LAYER_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="LEAD_CONTAINER_CAST" class="symbol" href="func.LEAD_CONTAINER_CAST.html">LEAD_CONTAINER_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="NEXT_ITEM_BUTTON_CAST" class="symbol" href="func.NEXT_ITEM_BUTTON_CAST.html">NEXT_ITEM_BUTTON_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="PREVIOUS_ITEM_BUTTON_CAST" class="symbol" href="func.PREVIOUS_ITEM_BUTTON_CAST.html">PREVIOUS_ITEM_BUTTON_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="PROGRESS_BAR_CAST" class="symbol" href="func.PROGRESS_BAR_CAST.html">PROGRESS_BAR_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="QUEUE_SELECTION_CAST" class="symbol" href="func.QUEUE_SELECTION_CAST.html">QUEUE_SELECTION_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="SIMPLE_CONTROLS_CAST" class="symbol" href="func.SIMPLE_CONTROLS_CAST.html">SIMPLE_CONTROLS_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="SKIP_ITEM_BUTTON_CAST" class="symbol" href="func.SKIP_ITEM_BUTTON_CAST.html">SKIP_ITEM_BUTTON_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TITLE_HEADER_CAST" class="symbol" href="func.TITLE_HEADER_CAST.html">TITLE_HEADER_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TOGGLE_FULLSCREEN_BUTTON_CAST" class="symbol" href="func.TOGGLE_FULLSCREEN_BUTTON_CAST.html">TOGGLE_FULLSCREEN_BUTTON_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="TOGGLE_PLAY_BUTTON_CAST" class="symbol" href="func.TOGGLE_PLAY_BUTTON_CAST.html">TOGGLE_PLAY_BUTTON_CAST</a></td>
<td class="docblock-summary">
<p></p>
</td>
</tr>
<tr class="section-item">
<td><a title="VIDEO_CAST" class="symbol" href="func.VIDEO_CAST.html">VIDEO_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="MAJOR_VERSION" class="symbol" href="const.MAJOR_VERSION.html">MAJOR_VERSION</a></td>
<td class="docblock-summary">
<p>ClapperGtk major version&nbsp;component.</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>ClapperGtk micro version&nbsp;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>ClapperGtk minor version&nbsp;component.</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>ClapperGtk version, encoded as a&nbsp;string.</p>
<p></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>