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

285 lines
7.7 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Harvest.toc_add</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.Harvest.toc_add"/>
<meta priority="og:description" content="Reference for Clapper.Harvest.toc_add"/>
<meta name="twitter:title" content="Clapper.Harvest.toc_add"/>
<meta name="twitter:description" content="Reference for Clapper.Harvest.toc_add"/>
<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="class.Harvest.html">Harvest</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Harvest.fill.html">fill</a>
<a class="method" href="method.Harvest.fill_with_bytes.html">fill_with_bytes</a>
<a class="method" href="method.Harvest.fill_with_text.html">fill_with_text</a>
<a class="method" href="method.Harvest.headers_set.html">headers_set</a>
<a class="method" href="method.Harvest.headers_set_value.html">headers_set_value</a>
<a class="method" href="method.Harvest.set_expiration_date_utc.html">set_expiration_date_utc</a>
<a class="method" href="method.Harvest.set_expiration_seconds.html">set_expiration_seconds</a>
<a class="method" href="method.Harvest.tags_add.html">tags_add</a>
<a class="method" href="method.Harvest.tags_add_value.html">tags_add_value</a>
<a class="method current" href="method.Harvest.toc_add.html">toc_add</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="class.Harvest.html">Harvest</a><span class="sep"></span>toc_add</h1>
</header>
<section>
<div class="docblock">
<p><span class="emblem available">since: 0.8</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-harvest.h#L55">[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_harvest_toc_add</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperHarvest</span><span class="o">*</span><span class="w"> </span><span class="n">harvest</span><span class="p">,</span>
<span class="w"> </span><span class="n">GstTocEntryType</span><span class="w"> </span><span class="n">type</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">title</span><span class="p">,</span>
<span class="w"> </span><span class="n">gdouble</span><span class="w"> </span><span class="n">start</span><span class="p">,</span>
<span class="w"> </span><span class="n">gdouble</span><span class="w"> </span><span class="n">end</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-harvest.c#L598">[src]</a>
</h4>
<div class="docblock">
<p>Append a chapter or track name into table of&nbsp;contents.</p>
</div>
<div class="docblock">
<p>Available since: 0.8</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>type</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-link="enum.TocEntryType.html" data-namespace="Gst" class="external"><code>GstTocEntryType</code></a></p>
<p>A <code>GstTocEntryType</code>.</p>
<table>
</table>
</dd>
<dt class="arg-name"><code>title</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>const gchar*</code></p>
<p>An entry&nbsp;title.</p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>start</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>gdouble</code></p>
<p>Entry start time in&nbsp;seconds.</p>
<table>
</table>
</dd>
<dt class="arg-name"><code>end</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>gdouble</code></p>
<p>Entry end time in seconds or -1 if&nbsp;none.</p>
<table>
</table>
</dd>
</dl>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>