Files
clapper/doc/clapper/class.ThreadedObject.html
github-actions[bot] 7aba8ae83f doc: Update
2025-06-19 10:45:20 +00:00

562 lines
16 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.ThreadedObject</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.ThreadedObject"/>
<meta property="og:description" content="Reference for Clapper.ThreadedObject"/>
<meta name="twitter:title" content="Clapper.ThreadedObject"/>
<meta name="twitter:description" content="Reference for Clapper.ThreadedObject"/>
<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>Type</h5>
<div class="links">
<a class="current" href="class.ThreadedObject.html#description">ThreadedObject</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.ThreadedObject.get_context.html">get_context</a>
</div>
</div>
<div class="section">
<h5>Virtual methods</h5>
<div class="links">
<a class="method" href="vfunc.ThreadedObject.thread_start.html">thread_start</a>
<a class="method" href="vfunc.ThreadedObject.thread_stop.html">thread_stop</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>Class</h3>
<h1 aria-label="Name"><a href="index.html">Clapper</a><span class="sep" role="presentation"></span>ThreadedObject</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/clapper-threaded-object.c#L19">[src]</a>
</h4>
<pre><code>class Clapper.ThreadedObject : Gst.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A base class for creating objects that work within a separate&nbsp;thread.</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.ThreadedObject">
<!-- Generated by graphviz version 12.2.1 (20241206.2353)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="155pt" height="260pt"
viewBox="0.00 0.00 154.50 260.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 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperThreadedObject">
<path fill="none" stroke="black" d="M134.5,-36C134.5,-36 12,-36 12,-36 6,-36 0,-30 0,-24 0,-24 0,-12 0,-12 0,-6 6,0 12,0 12,0 134.5,0 134.5,0 140.5,0 146.5,-6 146.5,-12 146.5,-12 146.5,-24 146.5,-24 146.5,-30 140.5,-36 134.5,-36"/>
<text text-anchor="middle" x="73.25" y="-11.82" font-family="Times,serif" font-size="14.00">ClapperThreadedObject</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M96.62,-108C96.62,-108 49.88,-108 49.88,-108 43.88,-108 37.88,-102 37.88,-96 37.88,-96 37.88,-84 37.88,-84 37.88,-78 43.88,-72 49.88,-72 49.88,-72 96.62,-72 96.62,-72 102.62,-72 108.62,-78 108.62,-84 108.62,-84 108.62,-96 108.62,-96 108.62,-102 102.62,-108 96.62,-108"/>
<text text-anchor="middle" x="73.25" y="-83.83" font-family="Times,serif" font-size="14.00">GstObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge3" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M73.25,-71.7C73.25,-60.85 73.25,-46.92 73.25,-36.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M121.75,-180C121.75,-180 24.75,-180 24.75,-180 18.75,-180 12.75,-174 12.75,-168 12.75,-168 12.75,-156 12.75,-156 12.75,-150 18.75,-144 24.75,-144 24.75,-144 121.75,-144 121.75,-144 127.75,-144 133.75,-150 133.75,-156 133.75,-156 133.75,-168 133.75,-168 133.75,-174 127.75,-180 121.75,-180"/>
<text text-anchor="middle" x="73.25" y="-155.82" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge2" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M73.25,-143.7C73.25,-132.85 73.25,-118.92 73.25,-108.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M92.12,-252C92.12,-252 54.38,-252 54.38,-252 48.38,-252 42.38,-246 42.38,-240 42.38,-240 42.38,-228 42.38,-228 42.38,-222 48.38,-216 54.38,-216 54.38,-216 92.12,-216 92.12,-216 98.12,-216 104.12,-222 104.12,-228 104.12,-228 104.12,-240 104.12,-240 104.12,-246 98.12,-252 92.12,-252"/>
<text text-anchor="middle" x="73.25" y="-227.82" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge1" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M73.25,-215.7C73.25,-204.85 73.25,-190.92 73.25,-180.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 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="descendants toggle-wrapper default-hide">
<h4 id="descendants">Descendants <a href="#descendants" class="anchor"></a></h4>
<div class="docblock">
<ul>
<li class="class"><a href="class.Player.html" title="Player">ClapperPlayer</a></li>
</ul>
</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.ThreadedObject.get_context.html">clapper_threaded_object_get_context</a></h6>
<div class="docblock">
<p>Get the <code>GMainContext</code> of the thread used by this&nbsp;object.</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="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="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 ClapperThreadedObjectClass {
GstObjectClass parent_class;
void (* thread_start) (
ClapperThreadedObject* threaded_object
);
void (* thread_stop) (
ClapperThreadedObject* threaded_object
);
}</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: GstObjectClass</code></dt>
<dd><p>The object class&nbsp;structure.</p></dd>
<dt><code>thread_start: void (* thread_start) (
ClapperThreadedObject* threaded_object
)</code></dt>
<dd><p>Called right after thread&nbsp;started.</p></dd>
<dt><code>thread_stop: void (* thread_stop) (
ClapperThreadedObject* threaded_object
)</code></dt>
<dd><p>Called when thread is going to&nbsp;stop.</p></dd>
</dd>
</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-thread_start"><a href="vfunc.ThreadedObject.thread_start.html">Clapper.ThreadedObjectClass.thread_start</a></h6>
<div class="docblock">
<p>Called right after thread&nbsp;started.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6 id="vfunc-thread_stop"><a href="vfunc.ThreadedObject.thread_stop.html">Clapper.ThreadedObjectClass.thread_stop</a></h6>
<div class="docblock">
<p>Called when thread is going to&nbsp;stop.</p>
</div>
<div class="docblock">
<p></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="#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="#methods"><span class="link-text">Methods</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>