Files
clapper/doc/clapper/class.MediaItem.html
github-actions[bot] ac9ae9c4c7 doc: Update
2024-06-27 20:14:53 +00:00

749 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.MediaItem</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.MediaItem"/>
<meta property="og:description" content="Reference for Clapper.MediaItem"/>
<meta name="twitter:title" content="Clapper.MediaItem"/>
<meta name="twitter:description" content="Reference for Clapper.MediaItem"/>
<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.MediaItem.html#description">MediaItem</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.MediaItem.new.html">new</a>
<a class="ctor" href="ctor.MediaItem.new_cached.html">new_cached</a>
<a class="ctor" href="ctor.MediaItem.new_from_file.html">new_from_file</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.MediaItem.get_container_format.html">get_container_format</a>
<a class="method" href="method.MediaItem.get_duration.html">get_duration</a>
<a class="method" href="method.MediaItem.get_id.html">get_id</a>
<a class="method" href="method.MediaItem.get_suburi.html">get_suburi</a>
<a class="method" href="method.MediaItem.get_timeline.html">get_timeline</a>
<a class="method" href="method.MediaItem.get_title.html">get_title</a>
<a class="method" href="method.MediaItem.get_uri.html">get_uri</a>
<a class="method" href="method.MediaItem.set_suburi.html">set_suburi</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.MediaItem.cache-location.html">cache-location</a>
<a class="property" href="property.MediaItem.container-format.html">container-format</a>
<a class="property" href="property.MediaItem.duration.html">duration</a>
<a class="property" href="property.MediaItem.id.html">id</a>
<a class="property" href="property.MediaItem.suburi.html">suburi</a>
<a class="property" href="property.MediaItem.timeline.html">timeline</a>
<a class="property" href="property.MediaItem.title.html">title</a>
<a class="property" href="property.MediaItem.uri.html">uri</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>MediaItem</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-media-item.c#L20">[src]</a>
</h4>
<pre><code>final class Clapper.MediaItem : Gst.Object
{
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Represents a media&nbsp;item.</p>
<p>A newly created media item must be added to player <a href="class.Queue.html"><code>ClapperQueue</code></a>
first in order to be&nbsp;played.</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.MediaItem">
<?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="129pt" height="260pt"
viewBox="0.00 0.00 129.00 260.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 256)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperMediaItem">
<path fill="none" stroke="black" d="M108.25,-36C108.25,-36 12.75,-36 12.75,-36 6.75,-36 0.75,-30 0.75,-24 0.75,-24 0.75,-12 0.75,-12 0.75,-6 6.75,0 12.75,0 12.75,0 108.25,0 108.25,0 114.25,0 120.25,-6 120.25,-12 120.25,-12 120.25,-24 120.25,-24 120.25,-30 114.25,-36 108.25,-36"/>
<text text-anchor="middle" x="60.5" y="-11.82" font-family="Times,serif" font-size="14.00">ClapperMediaItem</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="Gst.Object">
<path fill="none" stroke="black" d="M83.88,-108C83.88,-108 37.12,-108 37.12,-108 31.12,-108 25.12,-102 25.12,-96 25.12,-96 25.12,-84 25.12,-84 25.12,-78 31.12,-72 37.12,-72 37.12,-72 83.88,-72 83.88,-72 89.88,-72 95.88,-78 95.88,-84 95.88,-84 95.88,-96 95.88,-96 95.88,-102 89.88,-108 83.88,-108"/>
<text text-anchor="middle" x="60.5" y="-83.83" font-family="Times,serif" font-size="14.00">GstObject</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="M60.5,-71.7C60.5,-60.85 60.5,-46.92 60.5,-36.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="M109,-180C109,-180 12,-180 12,-180 6,-180 0,-174 0,-168 0,-168 0,-156 0,-156 0,-150 6,-144 12,-144 12,-144 109,-144 109,-144 115,-144 121,-150 121,-156 121,-156 121,-168 121,-168 121,-174 115,-180 109,-180"/>
<text text-anchor="middle" x="60.5" y="-155.82" 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="M60.5,-143.7C60.5,-132.85 60.5,-118.92 60.5,-108.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="M79.38,-252C79.38,-252 41.62,-252 41.62,-252 35.62,-252 29.62,-246 29.62,-240 29.62,-240 29.62,-228 29.62,-228 29.62,-222 35.62,-216 41.62,-216 41.62,-216 79.38,-216 79.38,-216 85.38,-216 91.38,-222 91.38,-228 91.38,-228 91.38,-240 91.38,-240 91.38,-246 85.38,-252 79.38,-252"/>
<text text-anchor="middle" x="60.5" y="-227.82" 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="M60.5,-215.7C60.5,-204.85 60.5,-190.92 60.5,-180.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.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 constructors">
<h4 id="constructors">
Constructors
<a href="#constructors" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="ctor.MediaItem.new.html">clapper_media_item_new</a></h6>
<div class="docblock">
<p>Creates new <code>ClapperMediaItem</code> from <span class="caps">URI</span>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="ctor.MediaItem.new_cached.html">clapper_media_item_new_cached</a></h6>
<div class="docblock">
<p>Same as <code>clapper_media_item_new()</code>, but allows to provide
a location of a cache file where particular media at <code>uri</code>
is supposed to be&nbsp;found.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This constructor will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.8</span></p>
</div>
</div>
<div class="">
<h6><a href="ctor.MediaItem.new_from_file.html">clapper_media_item_new_from_file</a></h6>
<div class="docblock">
<p>Creates new <code>ClapperMediaItem</code> from <code>GFile</code>.</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.MediaItem.get_container_format.html">clapper_media_item_get_container_format</a></h6>
<div class="docblock">
<p>Get media item container&nbsp;format.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_duration.html">clapper_media_item_get_duration</a></h6>
<div class="docblock">
<p>Get media item duration as decimal number in&nbsp;seconds.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_id.html">clapper_media_item_get_id</a></h6>
<div class="docblock">
<p>Get the unique <span class="caps">ID</span> of <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_suburi.html">clapper_media_item_get_suburi</a></h6>
<div class="docblock">
<p>Get the additional <span class="caps">URI</span> of <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_timeline.html">clapper_media_item_get_timeline</a></h6>
<div class="docblock">
<p>Get the <code>ClapperTimeline</code> assosiated with <code>item</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_title.html">clapper_media_item_get_title</a></h6>
<div class="docblock">
<p>Get media item&nbsp;title.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.get_uri.html">clapper_media_item_get_uri</a></h6>
<div class="docblock">
<p>Get the <span class="caps">URI</span> of <code>ClapperMediaItem</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.MediaItem.set_suburi.html">clapper_media_item_set_suburi</a></h6>
<div class="docblock">
<p>Set the additional <span class="caps">URI</span> of <code>ClapperMediaItem</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 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.MediaItem.cache-location.html">Clapper.MediaItem:cache-location</a></h6>
<div class="docblock">
<p>Media downloaded cache file&nbsp;location.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This property will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.8</span></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.container-format.html">Clapper.MediaItem:container-format</a></h6>
<div class="docblock">
<p>Media container&nbsp;format.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.duration.html">Clapper.MediaItem:duration</a></h6>
<div class="docblock">
<p>Media duration as a decimal number in&nbsp;seconds.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.id.html">Clapper.MediaItem:id</a></h6>
<div class="docblock">
<p>Media Item <span class="caps">ID</span>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.suburi.html">Clapper.MediaItem:suburi</a></h6>
<div class="docblock">
<p>Media additional <span class="caps">URI</span>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.timeline.html">Clapper.MediaItem:timeline</a></h6>
<div class="docblock">
<p>Media&nbsp;timeline.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.title.html">Clapper.MediaItem:title</a></h6>
<div class="docblock">
<p>Media&nbsp;title.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.MediaItem.uri.html">Clapper.MediaItem:uri</a></h6>
<div class="docblock">
<p>Media <span class="caps">URI</span>.</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 ClapperMediaItemClass {
GstObjectClass 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: GstObjectClass</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="#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>