<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>gstreamermm: Gst::TocSetter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">gstreamermm
 <span id="projectnumber">1.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGst.html">Gst</a></li><li class="navelem"><a class="el" href="classGst_1_1TocSetter.html">TocSetter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> |
<a href="classGst_1_1TocSetter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Gst::TocSetter Class Reference<div class="ingroups"><a class="el" href="group__GstInterfaces.html">gstreamermm Interfaces</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>An interface that allows setting and retrieval of the TOC.
<a href="classGst_1_1TocSetter.html#details">More...</a></p>
<p><code>#include <gstreamermm/tocsetter.h></code></p>
<p>Inherits Interface.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4ac9abd020bff42ffb5f1e2b89d6ee2f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a4ac9abd020bff42ffb5f1e2b89d6ee2f">TocSetter</a> (<a class="el" href="classGst_1_1TocSetter.html">TocSetter</a>&& src) noexcept</td></tr>
<tr class="separator:a4ac9abd020bff42ffb5f1e2b89d6ee2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a794cbfd44548afcaa5854481e938f954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGst_1_1TocSetter.html">TocSetter</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a794cbfd44548afcaa5854481e938f954">operator=</a> (<a class="el" href="classGst_1_1TocSetter.html">TocSetter</a>&& src) noexcept</td></tr>
<tr class="separator:a794cbfd44548afcaa5854481e938f954"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77df256f14f7ae2a64929cff365b1813"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a77df256f14f7ae2a64929cff365b1813">~TocSetter</a> () noexcept override</td></tr>
<tr class="separator:a77df256f14f7ae2a64929cff365b1813"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1131d80003ef12c514db9c3532be9c87"><td class="memItemLeft" align="right" valign="top">GstTocSetter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a1131d80003ef12c514db9c3532be9c87">gobj</a> ()</td></tr>
<tr class="memdesc:a1131d80003ef12c514db9c3532be9c87"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a1131d80003ef12c514db9c3532be9c87">More...</a><br /></td></tr>
<tr class="separator:a1131d80003ef12c514db9c3532be9c87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c0401cd1d8202978d281be436318c3f"><td class="memItemLeft" align="right" valign="top">const GstTocSetter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a6c0401cd1d8202978d281be436318c3f">gobj</a> () const</td></tr>
<tr class="memdesc:a6c0401cd1d8202978d281be436318c3f"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6c0401cd1d8202978d281be436318c3f">More...</a><br /></td></tr>
<tr class="separator:a6c0401cd1d8202978d281be436318c3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf4854ad5ef6bf2d52ae0a40d3783316"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#abf4854ad5ef6bf2d52ae0a40d3783316">set_toc</a> (const Glib::RefPtr< <a class="el" href="classGst_1_1Toc.html">Gst::Toc</a> >& toc)</td></tr>
<tr class="memdesc:abf4854ad5ef6bf2d52ae0a40d3783316"><td class="mdescLeft"> </td><td class="mdescRight">Set the given TOC on the setter. <a href="#abf4854ad5ef6bf2d52ae0a40d3783316">More...</a><br /></td></tr>
<tr class="separator:abf4854ad5ef6bf2d52ae0a40d3783316"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73794f2ad1f5fe25d6a658f772fea696"><td class="memItemLeft" align="right" valign="top">Glib::RefPtr< <a class="el" href="classGst_1_1Toc.html">Gst::Toc</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a73794f2ad1f5fe25d6a658f772fea696">get_toc</a> () const</td></tr>
<tr class="memdesc:a73794f2ad1f5fe25d6a658f772fea696"><td class="mdescLeft"> </td><td class="mdescRight">Return current TOC the setter uses. <a href="#a73794f2ad1f5fe25d6a658f772fea696">More...</a><br /></td></tr>
<tr class="separator:a73794f2ad1f5fe25d6a658f772fea696"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ad105f01cc1e59c048cde5ff9d9a411"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a3ad105f01cc1e59c048cde5ff9d9a411">reset</a> ()</td></tr>
<tr class="memdesc:a3ad105f01cc1e59c048cde5ff9d9a411"><td class="mdescLeft"> </td><td class="mdescRight">Reset the internal TOC. <a href="#a3ad105f01cc1e59c048cde5ff9d9a411">More...</a><br /></td></tr>
<tr class="separator:a3ad105f01cc1e59c048cde5ff9d9a411"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa54b873cc5d579c567c22711b22dd20b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#aa54b873cc5d579c567c22711b22dd20b">add_interface</a> (GType gtype_implementer)</td></tr>
<tr class="separator:aa54b873cc5d579c567c22711b22dd20b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f70102aafa59f7323d6102618e76741"><td class="memItemLeft" align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a4f70102aafa59f7323d6102618e76741">get_type</a> ()</td></tr>
<tr class="memdesc:a4f70102aafa59f7323d6102618e76741"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <a href="#a4f70102aafa59f7323d6102618e76741">More...</a><br /></td></tr>
<tr class="separator:a4f70102aafa59f7323d6102618e76741"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a34f4e630f7f9b1e6489917445ba6c800"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a34f4e630f7f9b1e6489917445ba6c800">TocSetter</a> ()</td></tr>
<tr class="memdesc:a34f4e630f7f9b1e6489917445ba6c800"><td class="mdescLeft"> </td><td class="mdescRight">You should derive from this class to use it. <a href="#a34f4e630f7f9b1e6489917445ba6c800">More...</a><br /></td></tr>
<tr class="separator:a34f4e630f7f9b1e6489917445ba6c800"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a311434f1e346a62c2b7b622021dc4fc9"><td class="memItemLeft" align="right" valign="top">Glib::RefPtr< <a class="el" href="classGst_1_1TocSetter.html">Gst::TocSetter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1TocSetter.html#a311434f1e346a62c2b7b622021dc4fc9">wrap</a> (GstTocSetter* object, bool take_copy=false)</td></tr>
<tr class="memdesc:a311434f1e346a62c2b7b622021dc4fc9"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a43fcab2a44083e8b7b6a1c8193acae2b">Glib::wrap()</a> method for this object. <a href="#a311434f1e346a62c2b7b622021dc4fc9">More...</a><br /></td></tr>
<tr class="separator:a311434f1e346a62c2b7b622021dc4fc9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An interface that allows setting and retrieval of the TOC. </p>
<p>Elements that support some kind of chapters or editions (or tracks like in the FLAC cue sheet) will implement this interface.</p>
<p>If you just want to retrieve the TOC in your application then all you need to do is watch for TOC messages on your pipeline's bus (or you can perform TOC query). This interface is only for setting TOC data, not for extracting it. To set TOC from the application, find proper tocsetter element and set TOC using <a class="el" href="classGst_1_1TocSetter.html#abf4854ad5ef6bf2d52ae0a40d3783316" title="Set the given TOC on the setter. ">set_toc()</a>.</p>
<p>Elements implementing the <a class="el" href="classGst_1_1TocSetter.html" title="An interface that allows setting and retrieval of the TOC. ">Gst::TocSetter</a> interface can extend existing TOC by getting extend UID for that (you can use gst_toc_find_entry() to retrieve it) with any TOC entries received from downstream.</p>
<p>Last reviewed on 2016-08-27 (1.8.0) </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a34f4e630f7f9b1e6489917445ba6c800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34f4e630f7f9b1e6489917445ba6c800">◆ </a></span>TocSetter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Gst::TocSetter::TocSetter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>You should derive from this class to use it. </p>
</div>
</div>
<a id="a4ac9abd020bff42ffb5f1e2b89d6ee2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ac9abd020bff42ffb5f1e2b89d6ee2f">◆ </a></span>TocSetter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Gst::TocSetter::TocSetter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1TocSetter.html">TocSetter</a>&& </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a77df256f14f7ae2a64929cff365b1813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77df256f14f7ae2a64929cff365b1813">◆ </a></span>~TocSetter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Gst::TocSetter::~TocSetter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa54b873cc5d579c567c22711b22dd20b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa54b873cc5d579c567c22711b22dd20b">◆ </a></span>add_interface()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void Gst::TocSetter::add_interface </td>
<td>(</td>
<td class="paramtype">GType </td>
<td class="paramname"><em>gtype_implementer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a73794f2ad1f5fe25d6a658f772fea696"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73794f2ad1f5fe25d6a658f772fea696">◆ </a></span>get_toc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::RefPtr<<a class="el" href="classGst_1_1Toc.html">Gst::Toc</a>> Gst::TocSetter::get_toc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return current TOC the setter uses. </p>
<p>The TOC should not be modified without making it writable first.</p>
<dl class="section return"><dt>Returns</dt><dd>TOC set, or <code>nullptr</code>. Unref with gst_toc_unref() when no longer needed. </dd></dl>
</div>
</div>
<a id="a4f70102aafa59f7323d6102618e76741"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f70102aafa59f7323d6102618e76741">◆ </a></span>get_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static GType Gst::TocSetter::get_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the GType for this class, for use with the underlying GObject type system. </p>
</div>
</div>
<a id="a1131d80003ef12c514db9c3532be9c87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1131d80003ef12c514db9c3532be9c87">◆ </a></span>gobj() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GstTocSetter* Gst::TocSetter::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
</div>
</div>
<a id="a6c0401cd1d8202978d281be436318c3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c0401cd1d8202978d281be436318c3f">◆ </a></span>gobj() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const GstTocSetter* Gst::TocSetter::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
</div>
</div>
<a id="a794cbfd44548afcaa5854481e938f954"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a794cbfd44548afcaa5854481e938f954">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGst_1_1TocSetter.html">TocSetter</a>& Gst::TocSetter::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1TocSetter.html">TocSetter</a>&& </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3ad105f01cc1e59c048cde5ff9d9a411"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ad105f01cc1e59c048cde5ff9d9a411">◆ </a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::TocSetter::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the internal TOC. </p>
<p>Elements should call this from within the state-change handler. </p>
</div>
</div>
<a id="abf4854ad5ef6bf2d52ae0a40d3783316"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf4854ad5ef6bf2d52ae0a40d3783316">◆ </a></span>set_toc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::TocSetter::set_toc </td>
<td>(</td>
<td class="paramtype">const Glib::RefPtr< <a class="el" href="classGst_1_1Toc.html">Gst::Toc</a> >& </td>
<td class="paramname"><em>toc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the given TOC on the setter. </p>
<p>Previously set TOC will be unreffed before setting a new one.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toc</td><td>A <a class="el" href="classGst_1_1Toc.html" title="Gst::Toc lets you to inform other elements in pipeline or application that playing source has some ki...">Gst::Toc</a> to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a311434f1e346a62c2b7b622021dc4fc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a311434f1e346a62c2b7b622021dc4fc9">◆ </a></span>wrap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Glib::RefPtr< <a class="el" href="classGst_1_1TocSetter.html">Gst::TocSetter</a> > wrap </td>
<td>(</td>
<td class="paramtype">GstTocSetter * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="namespaceGlib.html#a43fcab2a44083e8b7b6a1c8193acae2b">Glib::wrap()</a> method for this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 21 2017 12:59:01 for gstreamermm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
