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

729 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.AudioStream</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.AudioStream"/>
<meta property="og:description" content="Reference for Clapper.AudioStream"/>
<meta name="twitter:title" content="Clapper.AudioStream"/>
<meta name="twitter:description" content="Reference for Clapper.AudioStream"/>
<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.AudioStream.html#description">AudioStream</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.AudioStream.get_bitrate.html">get_bitrate</a>
<a class="method" href="method.AudioStream.get_channels.html">get_channels</a>
<a class="method" href="method.AudioStream.get_codec.html">get_codec</a>
<a class="method" href="method.AudioStream.get_lang_code.html">get_lang_code</a>
<a class="method" href="method.AudioStream.get_lang_name.html">get_lang_name</a>
<a class="method" href="method.AudioStream.get_sample_format.html">get_sample_format</a>
<a class="method" href="method.AudioStream.get_sample_rate.html">get_sample_rate</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.AudioStream.bitrate.html">bitrate</a>
<a class="property" href="property.AudioStream.channels.html">channels</a>
<a class="property" href="property.AudioStream.codec.html">codec</a>
<a class="property" href="property.AudioStream.lang-code.html">lang-code</a>
<a class="property" href="property.AudioStream.lang-name.html">lang-name</a>
<a class="property" href="property.AudioStream.sample-format.html">sample-format</a>
<a class="property" href="property.AudioStream.sample-rate.html">sample-rate</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>AudioStream</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-audio-stream.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.AudioStream : Clapper.Stream
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents an audio stream within&nbsp;media.</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.AudioStream">
<?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="140pt" height="332pt"
viewBox="0.00 0.00 139.50 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="ClapperAudioStream">
<path fill="none" stroke="black" d="M119.5,-36C119.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 119.5,0 119.5,0 125.5,0 131.5,-6 131.5,-12 131.5,-12 131.5,-24 131.5,-24 131.5,-30 125.5,-36 119.5,-36"/>
<text text-anchor="middle" x="65.75" y="-11.82" font-family="Times,serif" font-size="14.00">ClapperAudioStream</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Stream.html" xlink:title="ClapperStream">
<path fill="none" stroke="black" d="M102.62,-108C102.62,-108 28.88,-108 28.88,-108 22.88,-108 16.88,-102 16.88,-96 16.88,-96 16.88,-84 16.88,-84 16.88,-78 22.88,-72 28.88,-72 28.88,-72 102.62,-72 102.62,-72 108.62,-72 114.62,-78 114.62,-84 114.62,-84 114.62,-96 114.62,-96 114.62,-102 108.62,-108 102.62,-108"/>
<text text-anchor="middle" x="65.75" y="-83.83" font-family="Times,serif" font-size="14.00">ClapperStream</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="M65.75,-71.7C65.75,-60.85 65.75,-46.92 65.75,-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="M89.12,-180C89.12,-180 42.38,-180 42.38,-180 36.38,-180 30.38,-174 30.38,-168 30.38,-168 30.38,-156 30.38,-156 30.38,-150 36.38,-144 42.38,-144 42.38,-144 89.12,-144 89.12,-144 95.12,-144 101.12,-150 101.12,-156 101.12,-156 101.12,-168 101.12,-168 101.12,-174 95.12,-180 89.12,-180"/>
<text text-anchor="middle" x="65.75" 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="M65.75,-143.7C65.75,-132.85 65.75,-118.92 65.75,-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="M114.25,-252C114.25,-252 17.25,-252 17.25,-252 11.25,-252 5.25,-246 5.25,-240 5.25,-240 5.25,-228 5.25,-228 5.25,-222 11.25,-216 17.25,-216 17.25,-216 114.25,-216 114.25,-216 120.25,-216 126.25,-222 126.25,-228 126.25,-228 126.25,-240 126.25,-240 126.25,-246 120.25,-252 114.25,-252"/>
<text text-anchor="middle" x="65.75" 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="M65.75,-215.7C65.75,-204.85 65.75,-190.92 65.75,-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="M84.62,-324C84.62,-324 46.88,-324 46.88,-324 40.88,-324 34.88,-318 34.88,-312 34.88,-312 34.88,-300 34.88,-300 34.88,-294 40.88,-288 46.88,-288 46.88,-288 84.62,-288 84.62,-288 90.62,-288 96.62,-294 96.62,-300 96.62,-300 96.62,-312 96.62,-312 96.62,-318 90.62,-324 84.62,-324"/>
<text text-anchor="middle" x="65.75" 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="M65.75,-287.7C65.75,-276.85 65.75,-262.92 65.75,-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.Stream.html" title="Stream">ClapperStream</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 methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.AudioStream.get_bitrate.html">clapper_audio_stream_get_bitrate</a></h6>
<div class="docblock">
<p>Get bitrate of audio <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.AudioStream.get_channels.html">clapper_audio_stream_get_channels</a></h6>
<div class="docblock">
<p>Get number of audio channels in <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.AudioStream.get_codec.html">clapper_audio_stream_get_codec</a></h6>
<div class="docblock">
<p>Get codec used to encode <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.AudioStream.get_lang_code.html">clapper_audio_stream_get_lang_code</a></h6>
<div class="docblock">
<p>Get an <span class="caps">ISO</span>-639 language code of the <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.AudioStream.get_lang_name.html">clapper_audio_stream_get_lang_name</a></h6>
<div class="docblock">
<p>Get language name of the <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.AudioStream.get_sample_format.html">clapper_audio_stream_get_sample_format</a></h6>
<div class="docblock">
<p>Get sample format of audio <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.AudioStream.get_sample_rate.html">clapper_audio_stream_get_sample_rate</a></h6>
<div class="docblock">
<p>Get sample rate of audio <code>stream</code> (in&nbsp;Hz).</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 href="class.Stream.html">ClapperStream</a> (2)</h5><div class="docblock">
<h6><a href="method.Stream.get_stream_type.html">clapper_stream_get_stream_type</a></h6><div class="docblock">
<p>Get the <code>ClapperStreamType</code> of <code>stream</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Stream.get_title.html">clapper_stream_get_title</a></h6><div class="docblock">
<p>Get the title of <code>stream</code>, if&nbsp;any.</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.AudioStream.bitrate.html">Clapper.AudioStream:bitrate</a></h6>
<div class="docblock">
<p>Stream&nbsp;bitrate.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.AudioStream.channels.html">Clapper.AudioStream:channels</a></h6>
<div class="docblock">
<p>Stream number of audio&nbsp;channels.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.AudioStream.codec.html">Clapper.AudioStream:codec</a></h6>
<div class="docblock">
<p>Stream&nbsp;codec.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.AudioStream.lang-code.html">Clapper.AudioStream:lang-code</a></h6>
<div class="docblock">
<p>Stream language code in <span class="caps">ISO</span>-639&nbsp;format.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.AudioStream.lang-name.html">Clapper.AudioStream:lang-name</a></h6>
<div class="docblock">
<p>Stream language&nbsp;name.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.AudioStream.sample-format.html">Clapper.AudioStream:sample-format</a></h6>
<div class="docblock">
<p>Stream sample&nbsp;format.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.AudioStream.sample-rate.html">Clapper.AudioStream:sample-rate</a></h6>
<div class="docblock">
<p>Stream sample rate (in&nbsp;Hz).</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 href="class.Stream.html">ClapperStream</a> (2)</h5><div class="docblock">
<h6><a href="property.Stream.stream-type.html">Clapper.Stream:stream-type</a></h6><div class="docblock">
<p>Type of&nbsp;stream.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.Stream.title.html">Clapper.Stream:title</a></h6><div class="docblock">
<p>Title of&nbsp;stream.</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="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 ClapperAudioStreamClass {
ClapperStreamClass 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: ClapperStreamClass</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="#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>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>