Files
clapper/doc/clapper-gtk/class.Audio.html
github-actions[bot] 7add4cc1fd doc: Update
2025-08-03 12:24:47 +00:00

1005 lines
47 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>ClapperGtk.Audio</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="ClapperGtk-0.0"/>
<meta property="og:title" content="ClapperGtk.Audio"/>
<meta property="og:description" content="Reference for ClapperGtk.Audio"/>
<meta name="twitter:title" content="ClapperGtk.Audio"/>
<meta name="twitter:description" content="Reference for ClapperGtk.Audio"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="ClapperGtk" 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">ClapperGtk</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 class="current" href="class.Audio.html#description">Audio</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.Audio.new.html">new</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Audio.get_child.html">get_child</a>
<a class="method" href="method.Audio.set_child.html">set_child</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Audio.child.html">child</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>Class</h3>
<h1 aria-label="Name"><a href="index.html">ClapperGtk</a><span class="sep" role="presentation"></span>Audio</h1>
</header>
<section>
<summary>
<div class="docblock">
<p><span class="emblem available-next" title="This type will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.10</span></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-gtk/clapper-gtk-audio.c#L19">[src]</a>
</h4>
<pre><code>final class ClapperGtk.Audio : ClapperGtk.Av
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A <span class="caps">GTK</span> widget for audio playback with Clapper <span class="caps">API</span>.</p>
<p><code>ClapperGtkAudio</code> is a widget meant for integrating audio playback
within <span class="caps">GTK</span> application. It exposes <a href="javascript:void(0)" data-namespace="Clapper" data-link="class.Player.html" class="external"><code>ClapperPlayer</code></a> through its
base class <a href="property.Av.player.html"><code>ClapperGtkAv:player</code></a>&nbsp;property.</p>
<p>Other widgets (buttons, seek bar, etc.) provided by <code>ClapperGtk</code> library, once placed
anywhere inside audio container (including nesting within another widget like <a href="javascript:void(0)" data-namespace="Gtk" data-link="class.Box.html" class="external"><code>GtkBox</code></a>)
will automatically control <code>ClapperGtkAudio</code> they are within. This allows to freely create
custom <span class="caps">UI</span> best suited for specific&nbsp;application.</p>
<h1 id="basic-usage">Basic usage<a class="md-anchor" href="#basic-usage" title="Permanent link"></a></h1>
<p>A typical use case is to embed audio widget as part of your app where audio playback
is needed (can be even the very first child of the window). Get the <a href="javascript:void(0)" data-namespace="Clapper" data-link="class.Player.html" class="external"><code>ClapperPlayer</code></a>
belonging to the <span class="caps">AV</span> widget and start adding new <a href="javascript:void(0)" data-namespace="Clapper" data-link="class.MediaItem.html" class="external"><code>ClapperMediaItem</code></a> items to the
<a href="javascript:void(0)" data-namespace="Clapper" data-link="class.Queue.html" class="external"><code>ClapperQueue</code></a> for playback. For more information please refer to the Clapper
playback library&nbsp;documentation.</p>
<h1 id="actions">Actions<a class="md-anchor" href="#actions" title="Permanent link"></a></h1>
<p>You can use built-in actions of parent <a href="class.Av.html"><code>ClapperGtkAv</code></a>.
See its documentation for the list of available&nbsp;ones.</p>
<h1 id="clappergtkaudio-as-gtkbuildable">ClapperGtkAudio as GtkBuildable<a class="md-anchor" href="#clappergtkaudio-as-gtkbuildable" title="Permanent link"></a></h1>
<p><code>ClapperGtkAudio</code> implementation of the <a href="javascript:void(0)" data-namespace="Gtk" data-link="iface.Buildable.html" class="external"><code>GtkBuildable</code></a> interface supports
placing a single widget (which might then hold multiple widgets) as <code>&lt;child&gt;</code> element.</p>
<div class="codehilite"><pre><span></span><code><span class="nt">&lt;object</span><span class="w"> </span><span class="na">class=</span><span class="s">&quot;ClapperGtkAudio&quot;</span><span class="w"> </span><span class="na">id=</span><span class="s">&quot;audio&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;child&gt;</span>
<span class="w"> </span><span class="nt">&lt;object</span><span class="w"> </span><span class="na">class=</span><span class="s">&quot;GtkBox&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;property</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;orientation&quot;</span><span class="nt">&gt;</span>horizontal<span class="nt">&lt;/property&gt;</span>
<span class="w"> </span><span class="nt">&lt;child&gt;</span>
<span class="w"> </span><span class="nt">&lt;object</span><span class="w"> </span><span class="na">class=</span><span class="s">&quot;ClapperGtkPreviousItemButton&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;/child&gt;</span>
<span class="w"> </span><span class="nt">&lt;child&gt;</span>
<span class="w"> </span><span class="nt">&lt;object</span><span class="w"> </span><span class="na">class=</span><span class="s">&quot;ClapperGtkTogglePlayButton&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;/child&gt;</span>
<span class="w"> </span><span class="nt">&lt;child&gt;</span>
<span class="w"> </span><span class="nt">&lt;object</span><span class="w"> </span><span class="na">class=</span><span class="s">&quot;ClapperGtkNextItemButton&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;/child&gt;</span>
<span class="w"> </span><span class="nt">&lt;/object&gt;</span>
<span class="w"> </span><span class="nt">&lt;/child&gt;</span>
<span class="nt">&lt;/object&gt;</span>
</code></pre></div>
</div>
<div class="docblock">
<p>Available since: 0.10</p>
</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 ClapperGtk.Audio">
<!-- Generated by graphviz version 12.2.1 (20241206.2353)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="403pt" height="404pt"
viewBox="0.00 0.00 402.88 404.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 400)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperGtkAudio">
<path fill="none" stroke="black" d="M220.12,-108C220.12,-108 131.38,-108 131.38,-108 125.38,-108 119.38,-102 119.38,-96 119.38,-96 119.38,-84 119.38,-84 119.38,-78 125.38,-72 131.38,-72 131.38,-72 220.12,-72 220.12,-72 226.12,-72 232.12,-78 232.12,-84 232.12,-84 232.12,-96 232.12,-96 232.12,-102 226.12,-108 220.12,-108"/>
<text text-anchor="middle" x="175.75" y="-83.83" font-family="Times,serif" font-size="14.00">ClapperGtkAudio</text>
</a>
</g>
</g>
<!-- implements_0 -->
<g id="node6" class="node">
<title>implements_0</title>
<g id="a_node6"><a xlink:title="Gtk.Accessible">
<polygon fill="none" stroke="black" points="107.5,-36 0,-36 0,0 107.5,0 107.5,-36"/>
<text text-anchor="middle" x="53.75" y="-14.45" font-family="sans-serif" font-size="14.00">GtkAccessible</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_0 -->
<g id="edge5" class="edge">
<title>this&#45;&#45;implements_0</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M145.28,-71.52C126.51,-60.74 102.53,-46.99 83.83,-36.26"/>
</g>
<!-- implements_1 -->
<g id="node7" class="node">
<title>implements_1</title>
<g id="a_node7"><a xlink:title="Gtk.Buildable">
<polygon fill="none" stroke="black" points="226.12,-36 125.38,-36 125.38,0 226.12,0 226.12,-36"/>
<text text-anchor="middle" x="175.75" y="-14.45" font-family="sans-serif" font-size="14.00">GtkBuildable</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_1 -->
<g id="edge6" class="edge">
<title>this&#45;&#45;implements_1</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M175.75,-71.7C175.75,-60.85 175.75,-46.92 175.75,-36.1"/>
</g>
<!-- implements_2 -->
<g id="node8" class="node">
<title>implements_2</title>
<g id="a_node8"><a xlink:title="Gtk.ConstraintTarget">
<polygon fill="none" stroke="black" points="394.88,-36 244.62,-36 244.62,0 394.88,0 394.88,-36"/>
<text text-anchor="middle" x="319.75" y="-14.45" font-family="sans-serif" font-size="14.00">GtkConstraintTarget</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_2 -->
<g id="edge7" class="edge">
<title>this&#45;&#45;implements_2</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M211.72,-71.52C233.87,-60.74 262.17,-46.99 284.24,-36.26"/>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.Av.html" xlink:title="ClapperGtkAv">
<path fill="none" stroke="black" d="M211.12,-180C211.12,-180 140.38,-180 140.38,-180 134.38,-180 128.38,-174 128.38,-168 128.38,-168 128.38,-156 128.38,-156 128.38,-150 134.38,-144 140.38,-144 140.38,-144 211.12,-144 211.12,-144 217.12,-144 223.12,-150 223.12,-156 223.12,-156 223.12,-168 223.12,-168 223.12,-174 217.12,-180 211.12,-180"/>
<text text-anchor="middle" x="175.75" y="-155.82" font-family="Times,serif" font-size="14.00">ClapperGtkAv</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="M175.75,-143.7C175.75,-132.85 175.75,-118.92 175.75,-108.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:title="Gtk.Widget">
<path fill="none" stroke="black" d="M201.75,-252C201.75,-252 149.75,-252 149.75,-252 143.75,-252 137.75,-246 137.75,-240 137.75,-240 137.75,-228 137.75,-228 137.75,-222 143.75,-216 149.75,-216 149.75,-216 201.75,-216 201.75,-216 207.75,-216 213.75,-222 213.75,-228 213.75,-228 213.75,-240 213.75,-240 213.75,-246 207.75,-252 201.75,-252"/>
<text text-anchor="middle" x="175.75" y="-227.82" font-family="Times,serif" font-size="14.00">GtkWidget</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="M175.75,-215.7C175.75,-204.85 175.75,-190.92 175.75,-180.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="M224.25,-324C224.25,-324 127.25,-324 127.25,-324 121.25,-324 115.25,-318 115.25,-312 115.25,-312 115.25,-300 115.25,-300 115.25,-294 121.25,-288 127.25,-288 127.25,-288 224.25,-288 224.25,-288 230.25,-288 236.25,-294 236.25,-300 236.25,-300 236.25,-312 236.25,-312 236.25,-318 230.25,-324 224.25,-324"/>
<text text-anchor="middle" x="175.75" y="-299.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="M175.75,-287.7C175.75,-276.85 175.75,-262.92 175.75,-252.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="M194.62,-396C194.62,-396 156.88,-396 156.88,-396 150.88,-396 144.88,-390 144.88,-384 144.88,-384 144.88,-372 144.88,-372 144.88,-366 150.88,-360 156.88,-360 156.88,-360 194.62,-360 194.62,-360 200.62,-360 206.62,-366 206.62,-372 206.62,-372 206.62,-384 206.62,-384 206.62,-390 200.62,-396 194.62,-396"/>
<text text-anchor="middle" x="175.75" y="-371.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="M175.75,-359.7C175.75,-348.85 175.75,-334.92 175.75,-324.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.Av.html" title="Av">ClapperGtkAv</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Widget.html" data-namespace="Gtk">GtkWidget</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 implements">
<h4 id="implements">
Implements
<a href="#implements" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.Accessible.html" data-namespace="Gtk">GtkAccessible</a></li>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.Buildable.html" data-namespace="Gtk">GtkBuildable</a></li>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.ConstraintTarget.html" data-namespace="Gtk">GtkConstraintTarget</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.Audio.new.html">clapper_gtk_audio_new</a></h6>
<div class="docblock">
<p>Creates a new <code>ClapperGtkAudio</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.Audio.get_child.html">clapper_gtk_audio_get_child</a></h6>
<div class="docblock">
<p>Get a child <code>GtkWidget</code> of <code>audio</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Audio.set_child.html">clapper_gtk_audio_set_child</a></h6>
<div class="docblock">
<p>Set a child <code>GtkWidget</code> of <code>audio</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 href="class.Av.html">ClapperGtkAv</a> (4)</h5><div class="docblock">
<h6><a href="method.Av.get_auto_inhibit.html">clapper_gtk_av_get_auto_inhibit</a></h6><div class="docblock">
<p>Get whether automatic session inhibit is&nbsp;enabled.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.10</span></p>
</div>
<h6><a href="method.Av.get_inhibited.html">clapper_gtk_av_get_inhibited</a></h6><div class="docblock">
<p>Get whether session is currently inhibited by
<code>ClapperGtkAv:auto-inhibit</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.10</span></p>
</div>
<h6><a href="method.Av.get_player.html">clapper_gtk_av_get_player</a></h6><div class="docblock">
<p>Get <code>ClapperPlayer</code> used by this <code>ClapperGtkAv</code> instance.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.10</span></p>
</div>
<h6><a href="method.Av.set_auto_inhibit.html">clapper_gtk_av_set_auto_inhibit</a></h6><div class="docblock">
<p>Set whether widget should try to automatically inhibit session
from idling (and possibly screen going black) when media is&nbsp;playing.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.10</span></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.Widget.html" data-namespace="Gtk">GtkWidget</a> (164)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Widget.html#methods" data-namespace="Gtk">GtkWidget</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 class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="iface.Accessible.html" data-namespace="Gtk">GtkAccessible</a> (20)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.announce.html">gtk_accessible_announce</a></h6>
<div class="docblock">
<p>Requests the user&#8217;s screen reader to announce the given&nbsp;message.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_accessible_parent.html">gtk_accessible_get_accessible_parent</a></h6>
<div class="docblock">
<p>Retrieves the accessible parent for an accessible&nbsp;object.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_accessible_role.html">gtk_accessible_get_accessible_role</a></h6>
<div class="docblock">
<p>Retrieves the accessible role of an accessible&nbsp;object.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_at_context.html">gtk_accessible_get_at_context</a></h6>
<div class="docblock">
<p>Retrieves the implementation for the given accessible&nbsp;object.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_bounds.html">gtk_accessible_get_bounds</a></h6>
<div class="docblock">
<p>Queries the coordinates and dimensions of this&nbsp;accessible.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_first_accessible_child.html">gtk_accessible_get_first_accessible_child</a></h6>
<div class="docblock">
<p>Retrieves the first accessible child of an accessible&nbsp;object.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_next_accessible_sibling.html">gtk_accessible_get_next_accessible_sibling</a></h6>
<div class="docblock">
<p>Retrieves the next accessible sibling of an accessible&nbsp;object.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_platform_state.html">gtk_accessible_get_platform_state</a></h6>
<div class="docblock">
<p>Queries a platform state, such as&nbsp;focus.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.reset_property.html">gtk_accessible_reset_property</a></h6>
<div class="docblock">
<p>Resets the accessible property to its default&nbsp;value.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.reset_relation.html">gtk_accessible_reset_relation</a></h6>
<div class="docblock">
<p>Resets the accessible relation to its default&nbsp;value.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.reset_state.html">gtk_accessible_reset_state</a></h6>
<div class="docblock">
<p>Resets the accessible state to its default&nbsp;value.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.set_accessible_parent.html">gtk_accessible_set_accessible_parent</a></h6>
<div class="docblock">
<p>Sets the parent and sibling of an accessible&nbsp;object.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_next_accessible_sibling.html">gtk_accessible_update_next_accessible_sibling</a></h6>
<div class="docblock">
<p>Updates the next accessible&nbsp;sibling.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_platform_state.html">gtk_accessible_update_platform_state</a></h6>
<div class="docblock">
<p>Informs ATs that the platform state has&nbsp;changed.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_property.html">gtk_accessible_update_property</a></h6>
<div class="docblock">
<p>Updates a list of accessible&nbsp;properties.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_property_value.html">gtk_accessible_update_property_value</a></h6>
<div class="docblock">
<p>Updates an array of accessible&nbsp;properties.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_relation.html">gtk_accessible_update_relation</a></h6>
<div class="docblock">
<p>Updates a list of accessible&nbsp;relations.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_relation_value.html">gtk_accessible_update_relation_value</a></h6>
<div class="docblock">
<p>Updates an array of accessible&nbsp;relations.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_state.html">gtk_accessible_update_state</a></h6>
<div class="docblock">
<p>Updates a list of accessible&nbsp;states.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_state_value.html">gtk_accessible_update_state_value</a></h6>
<div class="docblock">
<p>Updates an array of accessible&nbsp;states.</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="iface.Buildable.html" data-namespace="Gtk">GtkBuildable</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Buildable.get_buildable_id.html">gtk_buildable_get_buildable_id</a></h6>
<div class="docblock">
<p>Gets the <span class="caps">ID</span> of the <code>buildable</code> object.</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.Audio.child.html">ClapperGtk.Audio:child</a></h6>
<div class="docblock">
<p>The child widget of <code>ClapperGtkAudio</code>.</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.Av.html">ClapperGtkAv</a> (3)</h5><div class="docblock">
<h6><a href="property.Av.auto-inhibit.html">ClapperGtk.Av:auto-inhibit</a></h6><div class="docblock">
<p>Try to automatically inhibit session when media is&nbsp;playing.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.Av.inhibited.html">ClapperGtk.Av:inhibited</a></h6><div class="docblock">
<p>Get whether session is currently inhibited by&nbsp;playback.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.Av.player.html">ClapperGtk.Av:player</a></h6><div class="docblock">
<p>A <code>ClapperPlayer</code> used by&nbsp;widget.</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.Widget.html" data-namespace="Gtk">GtkWidget</a> (35)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.can-focus.html">Gtk.Widget:can-focus</a></h6>
<div class="docblock">
<p>Whether the widget or any of its descendents can accept
the input&nbsp;focus.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.can-target.html">Gtk.Widget:can-target</a></h6>
<div class="docblock">
<p>Whether the widget can receive pointer&nbsp;events.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.css-classes.html">Gtk.Widget:css-classes</a></h6>
<div class="docblock">
<p>A list of css classes applied to this&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.css-name.html">Gtk.Widget:css-name</a></h6>
<div class="docblock">
<p>The name of this widget in the <span class="caps">CSS</span>&nbsp;tree.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.cursor.html">Gtk.Widget:cursor</a></h6>
<div class="docblock">
<p>The cursor used by <code>widget</code>.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.focus-on-click.html">Gtk.Widget:focus-on-click</a></h6>
<div class="docblock">
<p>Whether the widget should grab focus when it is clicked with the&nbsp;mouse.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.focusable.html">Gtk.Widget:focusable</a></h6>
<div class="docblock">
<p>Whether this widget itself will accept the input&nbsp;focus.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.halign.html">Gtk.Widget:halign</a></h6>
<div class="docblock">
<p>How to distribute horizontal space if widget gets extra&nbsp;space.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.has-default.html">Gtk.Widget:has-default</a></h6>
<div class="docblock">
<p>Whether the widget is the default&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.has-focus.html">Gtk.Widget:has-focus</a></h6>
<div class="docblock">
<p>Whether the widget has the input&nbsp;focus.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.has-tooltip.html">Gtk.Widget:has-tooltip</a></h6>
<div class="docblock">
<p>Enables or disables the emission of the <code>GtkWidget::query-tooltip</code>
signal on <code>widget</code>.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.height-request.html">Gtk.Widget:height-request</a></h6>
<div class="docblock">
<p>Overrides for height request of the&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.hexpand.html">Gtk.Widget:hexpand</a></h6>
<div class="docblock">
<p>Whether to expand&nbsp;horizontally.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.hexpand-set.html">Gtk.Widget:hexpand-set</a></h6>
<div class="docblock">
<p>Whether to use the <code>hexpand</code> property.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.layout-manager.html">Gtk.Widget:layout-manager</a></h6>
<div class="docblock">
<p>The <code>GtkLayoutManager</code> instance to use to compute
the preferred size of the widget, and allocate its&nbsp;children.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.limit-events.html">Gtk.Widget:limit-events</a></h6>
<div class="docblock">
<p>Makes this widget act like a modal dialog, with respect to
event&nbsp;delivery.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-bottom.html">Gtk.Widget:margin-bottom</a></h6>
<div class="docblock">
<p>Margin on bottom side of&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-end.html">Gtk.Widget:margin-end</a></h6>
<div class="docblock">
<p>Margin on end of widget,&nbsp;horizontally.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-start.html">Gtk.Widget:margin-start</a></h6>
<div class="docblock">
<p>Margin on start of widget,&nbsp;horizontally.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-top.html">Gtk.Widget:margin-top</a></h6>
<div class="docblock">
<p>Margin on top side of&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.name.html">Gtk.Widget:name</a></h6>
<div class="docblock">
<p>The name of the&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.opacity.html">Gtk.Widget:opacity</a></h6>
<div class="docblock">
<p>The requested opacity of the&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.overflow.html">Gtk.Widget:overflow</a></h6>
<div class="docblock">
<p>How content outside the widget&#8217;s content area is&nbsp;treated.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.parent.html">Gtk.Widget:parent</a></h6>
<div class="docblock">
<p>The parent widget of this&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.receives-default.html">Gtk.Widget:receives-default</a></h6>
<div class="docblock">
<p>Whether the widget will receive the default action when it is&nbsp;focused.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.root.html">Gtk.Widget:root</a></h6>
<div class="docblock">
<p>The <code>GtkRoot</code> widget of the widget tree containing this&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.scale-factor.html">Gtk.Widget:scale-factor</a></h6>
<div class="docblock">
<p>The scale factor of the&nbsp;widget.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.sensitive.html">Gtk.Widget:sensitive</a></h6>
<div class="docblock">
<p>Whether the widget responds to&nbsp;input.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.tooltip-markup.html">Gtk.Widget:tooltip-markup</a></h6>
<div class="docblock">
<p>Sets the text of tooltip to be the given string, which is marked up
with Pango&nbsp;markup.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.tooltip-text.html">Gtk.Widget:tooltip-text</a></h6>
<div class="docblock">
<p>Sets the text of tooltip to be the given&nbsp;string.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.valign.html">Gtk.Widget:valign</a></h6>
<div class="docblock">
<p>How to distribute vertical space if widget gets extra&nbsp;space.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.vexpand.html">Gtk.Widget:vexpand</a></h6>
<div class="docblock">
<p>Whether to expand&nbsp;vertically.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.vexpand-set.html">Gtk.Widget:vexpand-set</a></h6>
<div class="docblock">
<p>Whether to use the <code>vexpand</code> property.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.visible.html">Gtk.Widget:visible</a></h6>
<div class="docblock">
<p>Whether the widget is&nbsp;visible.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.width-request.html">Gtk.Widget:width-request</a></h6>
<div class="docblock">
<p>Overrides for width request of the&nbsp;widget.</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="iface.Accessible.html" data-namespace="Gtk">GtkAccessible</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Accessible.accessible-role.html">Gtk.Accessible:accessible-role</a></h6>
<div class="docblock">
<p>The accessible role of the given <code>GtkAccessible</code> implementation.</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.Widget.html" data-namespace="Gtk">GtkWidget</a> (13)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.destroy.html">GtkWidget::destroy</a></h6>
<div class="docblock">
<p>Signals that all holders of a reference to the widget should release
the reference that they&nbsp;hold.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.direction-changed.html">GtkWidget::direction-changed</a></h6>
<div class="docblock">
<p>Emitted when the text direction of a widget&nbsp;changes.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.hide.html">GtkWidget::hide</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is&nbsp;hidden.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.keynav-failed.html">GtkWidget::keynav-failed</a></h6>
<div class="docblock">
<p>Emitted if keyboard navigation&nbsp;fails.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.map.html">GtkWidget::map</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is going to be&nbsp;mapped.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.mnemonic-activate.html">GtkWidget::mnemonic-activate</a></h6>
<div class="docblock">
<p>Emitted when a widget is activated via a&nbsp;mnemonic.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.move-focus.html">GtkWidget::move-focus</a></h6>
<div class="docblock">
<p>Emitted when the focus is&nbsp;moved.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.query-tooltip.html">GtkWidget::query-tooltip</a></h6>
<div class="docblock">
<p>Emitted when the widgets tooltip is about to be&nbsp;shown.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.realize.html">GtkWidget::realize</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is associated with a <code>GdkSurface</code>.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.show.html">GtkWidget::show</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is&nbsp;shown.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.state-flags-changed.html">GtkWidget::state-flags-changed</a></h6>
<div class="docblock">
<p>Emitted when the widget state&nbsp;changes.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.unmap.html">GtkWidget::unmap</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is going to be&nbsp;unmapped.</p>
</div><h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.unrealize.html">GtkWidget::unrealize</a></h6>
<div class="docblock">
<p>Emitted when the <code>GdkSurface</code> associated with <code>widget</code> is&nbsp;destroyed.</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 ClapperGtkAudioClass {
ClapperGtkAvClass 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: ClapperGtkAvClass</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>
<ul class="toc-list">
<li class="toc-list-item"><a href="#basic-usage"><span class="link-text">Basic usage</span></a></li>
<li class="toc-list-item"><a href="#actions"><span class="link-text">Actions</span></a></li>
<li class="toc-list-item"><a href="#clappergtkaudio-as-gtkbuildable"><span class="link-text">ClapperGtkAudio as GtkBuildable</span></a></li>
</ul>
<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="#implements"><span class="link-text">Implements</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>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>