Files
clapper/doc/clapper/class.Server.html
github-actions[bot] 3364469035 doc: Update
2024-06-14 15:35:24 +00:00

740 lines
22 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Server</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.Server"/>
<meta property="og:description" content="Reference for Clapper.Server"/>
<meta name="twitter:title" content="Clapper.Server"/>
<meta name="twitter:description" content="Reference for Clapper.Server"/>
<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.7.0</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.Server.html#description">Server</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.Server.new.html">new</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Server.get_current_port.html">get_current_port</a>
<a class="method" href="method.Server.get_enabled.html">get_enabled</a>
<a class="method" href="method.Server.get_port.html">get_port</a>
<a class="method" href="method.Server.get_queue_controllable.html">get_queue_controllable</a>
<a class="method" href="method.Server.get_running.html">get_running</a>
<a class="method" href="method.Server.set_enabled.html">set_enabled</a>
<a class="method" href="method.Server.set_port.html">set_port</a>
<a class="method" href="method.Server.set_queue_controllable.html">set_queue_controllable</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Server.current-port.html">current-port</a>
<a class="property" href="property.Server.enabled.html">enabled</a>
<a class="property" href="property.Server.port.html">port</a>
<a class="property" href="property.Server.queue-controllable.html">queue-controllable</a>
<a class="property" href="property.Server.running.html">running</a>
</div>
</div>
<div class="section">
<h5>Signals</h5>
<div class="links">
<a class="signal" href="signal.Server.error.html">error</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2024.1</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>Server</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/server/clapper-server.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.Server : Clapper.Feature
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>An optional Server feature to add to the&nbsp;player.</p>
<p><code>ClapperServer</code> is a feature that hosts a local server
providing an ability to both monitor and control playback
through WebSocket messages and <span class="caps">HTTP</span>&nbsp;requests.</p>
<p>Use <a href="const.HAVE_SERVER.html"><code>CLAPPER_HAVE_SERVER</code></a> macro to check if Clapper <span class="caps">API</span>
was compiled with this&nbsp;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.Server">
<?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 9.0.0 (20230911.1827)
-->
<!-- 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="ClapperServer">
<path fill="none" stroke="black" d="M95.88,-36C95.88,-36 25.12,-36 25.12,-36 19.12,-36 13.12,-30 13.12,-24 13.12,-24 13.12,-12 13.12,-12 13.12,-6 19.12,0 25.12,0 25.12,0 95.88,0 95.88,0 101.88,0 107.88,-6 107.88,-12 107.88,-12 107.88,-24 107.88,-24 107.88,-30 101.88,-36 95.88,-36"/>
<text text-anchor="middle" x="60.5" y="-11.82" font-family="Times,serif" font-size="14.00">ClapperServer</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="-83.83" font-family="Times,serif" font-size="14.00">ClapperFeature</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge4" class="edge">
<title>ancestor_0&#45;&#45;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="-155.82" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge3" class="edge">
<title>ancestor_1&#45;&#45;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="-227.82" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge2" class="edge">
<title>ancestor_2&#45;&#45;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="-299.82" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge1" class="edge">
<title>ancestor_3&#45;&#45;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.Server.new.html">clapper_server_new</a></h6>
<div class="docblock">
<p>Creates a new <code>ClapperServer</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.Server.get_current_port.html">clapper_server_get_current_port</a></h6>
<div class="docblock">
<p>Get port on which server is currently listening&nbsp;on.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_enabled.html">clapper_server_get_enabled</a></h6>
<div class="docblock">
<p>Get whether <code>ClapperServer</code> is set to be&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_port.html">clapper_server_get_port</a></h6>
<div class="docblock">
<p>Get requested server listening&nbsp;port.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_queue_controllable.html">clapper_server_get_queue_controllable</a></h6>
<div class="docblock">
<p>Get whether remote <code>server</code> clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.get_running.html">clapper_server_get_running</a></h6>
<div class="docblock">
<p>Get whether <code>ClapperServer</code> is currently&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.set_enabled.html">clapper_server_set_enabled</a></h6>
<div class="docblock">
<p>Set whether <code>ClapperServer</code> should be&nbsp;running.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.set_port.html">clapper_server_set_port</a></h6>
<div class="docblock">
<p>Set server listening&nbsp;port.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Server.set_queue_controllable.html">clapper_server_set_queue_controllable</a></h6>
<div class="docblock">
<p>Set whether remote <code>server</code> clients can control <code>ClapperQueue</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&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="Gst">GstObject</a>&nbsp;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&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;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.Server.current-port.html">Clapper.Server:current-port</a></h6>
<div class="docblock">
<p>Port on which server is currently listening on or 0 if not&nbsp;listening.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.enabled.html">Clapper.Server:enabled</a></h6>
<div class="docblock">
<p>Whether server is&nbsp;enabled.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.port.html">Clapper.Server:port</a></h6>
<div class="docblock">
<p>Port to listen on or 0 for using random unused&nbsp;port.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.queue-controllable.html">Clapper.Server:queue-controllable</a></h6>
<div class="docblock">
<p>Whether remote server clients can control <code>ClapperQueue</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Server.running.html">Clapper.Server:running</a></h6>
<div class="docblock">
<p>Whether server is currently&nbsp;running.</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><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 &#8216;parent&#8217;
property, we don&#8217;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&nbsp;effect.</p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="signal.Server.error.html">Clapper.Server::error</a></h6>
<div class="docblock">
<p>Error signal when server could not start.
This will be emitted from application main&nbsp;thread.</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="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&nbsp;bin.</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&nbsp;al.</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 ClapperServerClass {
ClapperFeatureClass parent_class;
}</code></pre>
</div>
<div class="docblock">
<p>No description available.</p>
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: ClapperFeatureClass</code></dt>
<dd><p>No description available.</p></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>
<li class="toc-list-item"><a href="#signals"><span class="link-text">Signals</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>