mirror of
https://github.com/Rafostar/clapper.git
synced 2025-08-31 16:31:58 +02:00
224 lines
6.3 KiB
HTML
224 lines
6.3 KiB
HTML
<!--
|
|
SPDX-FileCopyrightText: Rafał Dzięgiel
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
|
-->
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Clapper.init</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.init"/>
|
|
<meta property="og:description" content="Reference for Clapper.init"/>
|
|
<meta name="twitter:title" content="Clapper.init"/>
|
|
<meta name="twitter:description" content="Reference for Clapper.init"/>
|
|
|
|
|
|
|
|
<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">
|
|
<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">Clapper</a></h3>
|
|
<p>API Version: 0.0</p>
|
|
|
|
<p>Library Version: 0.5.2</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="section">
|
|
<h5>Functions</h5>
|
|
<div class="links">
|
|
|
|
</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>Function </h3>
|
|
<h1><a href="index.html">Clapper</a><span class="sep"></span>init</h1>
|
|
</header>
|
|
|
|
<section>
|
|
<div class="docblock">
|
|
<p></p>
|
|
</div>
|
|
<div class="declaration toggle-wrapper">
|
|
<h4 id="declaration" style="display:flex;">
|
|
Declaration
|
|
<a href="#declaration" class="anchor"></a>
|
|
|
|
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper/clapper.h#L51">[src]</a>
|
|
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
|
|
<span class="n">clapper_init</span><span class="w"> </span><span class="p">(</span>
|
|
<span class="w"> </span><span class="kt">int</span><span class="o">*</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="kt">char</span><span class="o">***</span><span class="w"> </span><span class="n">argv</span>
|
|
<span class="p">)</span>
|
|
</pre></div>
|
|
</code></pre>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="description 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/lib/clapper/clapper.c#L55">[src]</a>
|
|
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<p>Initializes the Clapper library. Implementations must always call this
|
|
before using Clapper <span class="caps">API</span>.</p>
|
|
<p>Because Clapper uses GStreamer internally, this function will also initialize
|
|
GStreamer before initializing Clapper itself for user convienience, so
|
|
application does not have to do so anymore.</p>
|
|
<p><span class="caps">WARNING</span>: This function will terminate your program if it was unable to
|
|
initialize for some reason. If you want to do some fallback logic,
|
|
use <a href="func.init_check.html"><code>clapper_init_check()</code></a> instead.</p>
|
|
</div>
|
|
|
|
<div class="docblock">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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>argc</code></dt>
|
|
<dd class="arg-description">
|
|
<p><em>Type:</em> <code>int*</code></p>
|
|
<p><p>Pointer to application’s argc.</p></p>
|
|
<table>
|
|
<tr><td title="direction: inout">The argument will be modified by the function.</td></tr>
|
|
|
|
<tr><td>The argument can be set to <code>NULL</code> by the function.</td></tr>
|
|
<tr><td>The argument can be <code>NULL</code>.</td></tr>
|
|
|
|
|
|
|
|
|
|
|
|
</table>
|
|
</dd>
|
|
|
|
<dt class="arg-name"><code>argv</code></dt>
|
|
<dd class="arg-description">
|
|
<p><em>Type:</em> An array of <code>char**</code></p>
|
|
<p><p>Pointer to application’s argv.</p></p>
|
|
<table>
|
|
<tr><td title="direction: inout">The argument will be modified by the function.</td></tr>
|
|
|
|
<tr><td>The argument can be set to <code>NULL</code> by the function.</td></tr>
|
|
<tr><td>The argument can be <code>NULL</code>.</td></tr>
|
|
|
|
|
|
<tr><td>The length of the array is specified in the <code>argc</code> argument.</td></tr>
|
|
<tr><td title="transfer: full">The caller of the function takes ownership of the data, and is responsible for freeing it.</td></tr>
|
|
<tr><td>Each element is a NUL terminated UTF-8 string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
|
|
|
|
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section id="search" class="content hidden"></section>
|
|
|
|
<footer>
|
|
|
|
</footer>
|
|
</div>
|
|
</body>
|
|
</html> |