Files
clapper/doc/clapper-gtk/class.Video.html
2024-01-21 20:51:05 +01:00

1315 lines
51 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.Video</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.Video"/>
<meta property="og:description" content="Reference for ClapperGtk.Video"/>
<meta name="twitter:title" content="ClapperGtk.Video"/>
<meta name="twitter:description" content="Reference for ClapperGtk.Video"/>
<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">
<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">ClapperGtk</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.Video.html#description">Video</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.Video.new.html">new</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Video.add_fading_overlay.html">add_fading_overlay</a>
<a class="method" href="method.Video.add_overlay.html">add_overlay</a>
<a class="method" href="method.Video.get_auto_inhibit.html">get_auto_inhibit</a>
<a class="method" href="method.Video.get_fade_delay.html">get_fade_delay</a>
<a class="method" href="method.Video.get_inhibited.html">get_inhibited</a>
<a class="method" href="method.Video.get_player.html">get_player</a>
<a class="method" href="method.Video.get_touch_fade_delay.html">get_touch_fade_delay</a>
<a class="method" href="method.Video.set_auto_inhibit.html">set_auto_inhibit</a>
<a class="method" href="method.Video.set_fade_delay.html">set_fade_delay</a>
<a class="method" href="method.Video.set_touch_fade_delay.html">set_touch_fade_delay</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Video.auto-inhibit.html">auto-inhibit</a>
<a class="property" href="property.Video.fade-delay.html">fade-delay</a>
<a class="property" href="property.Video.inhibited.html">inhibited</a>
<a class="property" href="property.Video.player.html">player</a>
<a class="property" href="property.Video.touch-fade-delay.html">touch-fade-delay</a>
</div>
</div>
<div class="section">
<h5>Signals</h5>
<div class="links">
<a class="signal" href="signal.Video.toggle-fullscreen.html">toggle-fullscreen</a>
</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>Class</h3>
<h1 aria-label="Name"><a href="index.html">ClapperGtk</a><span class="sep" role="presentation"></span>Video</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/lib/clapper-gtk/clapper-gtk-video.c#L20">[src]</a>
</h4>
<pre><code>final class ClapperGtk.Video : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A ready to be used <span class="caps">GTK</span> video widget implementing Clapper <span class="caps">API</span>.</p>
<p><code>ClapperGtkVideo</code> is the main widget exposed by <code>ClapperGtk</code> <span class="caps">API</span>. All other widgets
exposed by this library are meant to be overlaid on top of this&nbsp;widget.</p>
<p>For example a button type of widget once placed anywhere on video (can also be
nested within another widget like <a href="javascript:void(0)" data-namespace="Gtk" data-link="class.Box.html" class="external"><code>GtkBox</code></a>) automatically works and controls
<code>ClapperGtkVideo</code> widget it was overlaid on top of. This allows freely creating custom
playback control panels best suited for specific application. Additionally, pre-made
widgets such as <a href="class.SimpleControls.html"><code>ClapperGtkSimpleControls</code></a> are also&nbsp;available.</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 ClapperGtk.Video">
<?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 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="405pt" height="332pt"
viewBox="0.00 0.00 404.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="ClapperGtkVideo">
<path fill="none" stroke="black" d="M221.5,-108C221.5,-108 132.5,-108 132.5,-108 126.5,-108 120.5,-102 120.5,-96 120.5,-96 120.5,-84 120.5,-84 120.5,-78 126.5,-72 132.5,-72 132.5,-72 221.5,-72 221.5,-72 227.5,-72 233.5,-78 233.5,-84 233.5,-84 233.5,-96 233.5,-96 233.5,-102 227.5,-108 221.5,-108"/>
<text text-anchor="middle" x="177" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperGtkVideo</text>
</a>
</g>
</g>
<!-- implements_0 -->
<g id="node5" class="node">
<title>implements_0</title>
<g id="a_node5"><a xlink:title="Gtk.Accessible">
<polygon fill="none" stroke="black" points="108,-36 0,-36 0,0 108,0 108,-36"/>
<text text-anchor="middle" x="54" y="-14.3" font-family="sans-serif" font-size="14.00">GtkAccessible</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_0 -->
<g id="edge4" class="edge">
<title>this&#45;&#45;implements_0</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M146.28,-71.52C127.35,-60.74 103.18,-46.99 84.33,-36.26"/>
</g>
<!-- implements_1 -->
<g id="node6" class="node">
<title>implements_1</title>
<g id="a_node6"><a xlink:title="Gtk.Buildable">
<polygon fill="none" stroke="black" points="227.5,-36 126.5,-36 126.5,0 227.5,0 227.5,-36"/>
<text text-anchor="middle" x="177" y="-14.3" font-family="sans-serif" font-size="14.00">GtkBuildable</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_1 -->
<g id="edge5" class="edge">
<title>this&#45;&#45;implements_1</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M177,-71.7C177,-60.85 177,-46.92 177,-36.1"/>
</g>
<!-- implements_2 -->
<g id="node7" class="node">
<title>implements_2</title>
<g id="a_node7"><a xlink:title="Gtk.ConstraintTarget">
<polygon fill="none" stroke="black" points="396.5,-36 245.5,-36 245.5,0 396.5,0 396.5,-36"/>
<text text-anchor="middle" x="321" y="-14.3" font-family="sans-serif" font-size="14.00">GtkConstraintTarget</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_2 -->
<g id="edge6" class="edge">
<title>this&#45;&#45;implements_2</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M212.97,-71.52C235.12,-60.74 263.42,-46.99 285.49,-36.26"/>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gtk.Widget">
<path fill="none" stroke="black" d="M203.5,-180C203.5,-180 150.5,-180 150.5,-180 144.5,-180 138.5,-174 138.5,-168 138.5,-168 138.5,-156 138.5,-156 138.5,-150 144.5,-144 150.5,-144 150.5,-144 203.5,-144 203.5,-144 209.5,-144 215.5,-150 215.5,-156 215.5,-156 215.5,-168 215.5,-168 215.5,-174 209.5,-180 203.5,-180"/>
<text text-anchor="middle" x="177" y="-158.3" font-family="Times,serif" font-size="14.00">GtkWidget</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="M177,-143.7C177,-132.85 177,-118.92 177,-108.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="M226,-252C226,-252 128,-252 128,-252 122,-252 116,-246 116,-240 116,-240 116,-228 116,-228 116,-222 122,-216 128,-216 128,-216 226,-216 226,-216 232,-216 238,-222 238,-228 238,-228 238,-240 238,-240 238,-246 232,-252 226,-252"/>
<text text-anchor="middle" x="177" y="-230.3" 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="M177,-215.7C177,-204.85 177,-190.92 177,-180.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="M196,-324C196,-324 158,-324 158,-324 152,-324 146,-318 146,-312 146,-312 146,-300 146,-300 146,-294 152,-288 158,-288 158,-288 196,-288 196,-288 202,-288 208,-294 208,-300 208,-300 208,-312 208,-312 208,-318 202,-324 196,-324"/>
<text text-anchor="middle" x="177" y="-302.3" 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="M177,-287.7C177,-276.85 177,-262.92 177,-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 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.Video.new.html">clapper_gtk_video_new</a></h6>
<div class="docblock">
<p>Creates a new <code>ClapperGtkVideo</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.Video.add_fading_overlay.html">clapper_gtk_video_add_fading_overlay</a></h6>
<div class="docblock">
<p>Similiar as <code>clapper_gtk_video_add_overlay()</code> but will also automatically
add fading functionality to overlaid <code>GtkWidget</code> for convenience. This will
make widget reveal itself when interacting with <code>video</code> and fade otherwise.
Useful when placing widgets such as playback controls&nbsp;panels.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.add_overlay.html">clapper_gtk_video_add_overlay</a></h6>
<div class="docblock">
<p>Add another <code>GtkWidget</code> to be overlaid on top of&nbsp;video.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.get_auto_inhibit.html">clapper_gtk_video_get_auto_inhibit</a></h6>
<div class="docblock">
<p>Get whether automatic session inhibit is&nbsp;enabled.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.get_fade_delay.html">clapper_gtk_video_get_fade_delay</a></h6>
<div class="docblock">
<p>Get time in milliseconds after which fading overlays should&nbsp;fade.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.get_inhibited.html">clapper_gtk_video_get_inhibited</a></h6>
<div class="docblock">
<p>Get whether session is currently inhibited by
<code>ClapperGtkVideo:auto-inhibit</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.get_player.html">clapper_gtk_video_get_player</a></h6>
<div class="docblock">
<p>Get <code>ClapperPlayer</code> used by this <code>ClapperGtkVideo</code> instance.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.get_touch_fade_delay.html">clapper_gtk_video_get_touch_fade_delay</a></h6>
<div class="docblock">
<p>Get time in milliseconds after which fading overlays should fade
when revealed using touch&nbsp;device.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.set_auto_inhibit.html">clapper_gtk_video_set_auto_inhibit</a></h6>
<div class="docblock">
<p>Set whether video should try to automatically inhibit session
from idling (and possibly screen going black) when video is&nbsp;playing.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.set_fade_delay.html">clapper_gtk_video_set_fade_delay</a></h6>
<div class="docblock">
<p>Set time in milliseconds after which fading overlays should&nbsp;fade.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Video.set_touch_fade_delay.html">clapper_gtk_video_set_touch_fade_delay</a></h6>
<div class="docblock">
<p>Set time in milliseconds after which fading overlays should fade
when using&nbsp;touchscreen.</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.Widget.html" data-namespace="Gtk">GtkWidget</a> (161)</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> (18)</h5>
<div class="docblock">
<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>
<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: 4.10</span></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>
<div class="docblock">
<p></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 accessible implementation for the given <code>GtkAccessible</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: 4.10</span></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>
<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: 4.10</span></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>
<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: 4.10</span></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>
<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: 4.10</span></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>Query a platform state, such as&nbsp;focus.</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: 4.10</span></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 <code>property</code> to its default&nbsp;value.</p>
</div>
<div class="docblock">
<p></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 <code>relation</code> to its default&nbsp;value.</p>
</div>
<div class="docblock">
<p></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 <code>state</code> to its default&nbsp;value.</p>
</div>
<div class="docblock">
<p></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>
<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: 4.10</span></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 sibling of <code>self</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: 4.10</span></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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 states. See the <code>GtkAccessibleState</code>
documentation for the value types of accessible&nbsp;states.</p>
</div>
<div class="docblock">
<p></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 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="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 class="docblock">
<p></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.Video.auto-inhibit.html">ClapperGtk.Video:auto-inhibit</a></h6>
<div class="docblock">
<p>Try to automatically inhibit session when video is&nbsp;playing.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Video.fade-delay.html">ClapperGtk.Video:fade-delay</a></h6>
<div class="docblock">
<p>A delay in milliseconds before trying to fade all fading&nbsp;overlays.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Video.inhibited.html">ClapperGtk.Video:inhibited</a></h6>
<div class="docblock">
<p>Get whether session is currently inhibited by the&nbsp;video.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Video.player.html">ClapperGtk.Video:player</a></h6>
<div class="docblock">
<p>A <code>ClapperPlayer</code> used by&nbsp;video.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.Video.touch-fade-delay.html">ClapperGtk.Video:touch-fade-delay</a></h6>
<div class="docblock">
<p>A delay in milliseconds before trying to fade all fading overlays
after revealed using&nbsp;touchscreen.</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> (34)</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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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 ::query-tooltip signal on <code>widget</code>.</p>
</div>
<div class="docblock">
<p></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>Override for height request of the&nbsp;widget.</p>
</div>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>Override for width request of the&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="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 class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="signal.Video.toggle-fullscreen.html">ClapperGtk.Video::toggle-fullscreen</a></h6>
<div class="docblock">
<p>A signal that user requested a change in fullscreen state of the&nbsp;video.</p>
</div>
<div class="docblock">
<p></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.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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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>
<div class="docblock">
<p></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 class="docblock">
<p></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 class="docblock">
<p></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 ClapperGtkVideoClass {
GtkWidgetClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GtkWidgetClass</code></dt>
<dd>No description available.</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="#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>
<li class="toc-list-item"><a href="#signals"><span class="link-text">Signals</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>