<!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::Parse 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_1Parse.html">Parse</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classGst_1_1Parse-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Gst::Parse Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that gets a pipeline from a text pipeline description.
<a href="classGst_1_1Parse.html#details">More...</a></p>
<p><code>#include <gstreamermm/parse.h></code></p>
<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:a8694c65abfdc1a36fd9a5a73dd270818"><td class="memItemLeft" align="right" valign="top">static Glib::QueryQuark </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Parse.html#a8694c65abfdc1a36fd9a5a73dd270818">error_quark</a> ()</td></tr>
<tr class="memdesc:a8694c65abfdc1a36fd9a5a73dd270818"><td class="mdescLeft"> </td><td class="mdescRight">Get the error quark used by the parsing subsystem. <a href="#a8694c65abfdc1a36fd9a5a73dd270818">More...</a><br /></td></tr>
<tr class="separator:a8694c65abfdc1a36fd9a5a73dd270818"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca096b4b23818a77d3405a53b06015b4"><td class="memItemLeft" align="right" valign="top">static Glib::RefPtr< <a class="el" href="classGst_1_1Element.html">Gst::Element</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Parse.html#aca096b4b23818a77d3405a53b06015b4">launch</a> (const Glib::ustring& pipeline_description)</td></tr>
<tr class="memdesc:aca096b4b23818a77d3405a53b06015b4"><td class="mdescLeft"> </td><td class="mdescRight">Create a new pipeline based on command line syntax. <a href="#aca096b4b23818a77d3405a53b06015b4">More...</a><br /></td></tr>
<tr class="separator:aca096b4b23818a77d3405a53b06015b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2d721de450830b53ec6d362cd8cb863"><td class="memItemLeft" align="right" valign="top">static Glib::RefPtr< <a class="el" href="classGst_1_1Element.html">Gst::Element</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Parse.html#ab2d721de450830b53ec6d362cd8cb863">launchv</a> (const gchar* argv[])</td></tr>
<tr class="memdesc:ab2d721de450830b53ec6d362cd8cb863"><td class="mdescLeft"> </td><td class="mdescRight">Create a new element based on command line syntax. <a href="#ab2d721de450830b53ec6d362cd8cb863">More...</a><br /></td></tr>
<tr class="separator:ab2d721de450830b53ec6d362cd8cb863"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6113c683762b14e2724497830fe9244"><td class="memItemLeft" align="right" valign="top">static Glib::RefPtr< <a class="el" href="classGst_1_1Element.html">Gst::Element</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Parse.html#ad6113c683762b14e2724497830fe9244">create_bin</a> (const Glib::ustring& bin_description, bool ghost_unconnected_pads)</td></tr>
<tr class="memdesc:ad6113c683762b14e2724497830fe9244"><td class="mdescLeft"> </td><td class="mdescRight">This is a convenience wrapper around <a class="el" href="classGst_1_1Parse.html#aca096b4b23818a77d3405a53b06015b4" title="Create a new pipeline based on command line syntax. ">launch()</a> to create a <a class="el" href="classGst_1_1Bin.html" title="Base class and element that can contain other elements. ">Gst::Bin</a> from a gst-launch-style pipeline description. <a href="#ad6113c683762b14e2724497830fe9244">More...</a><br /></td></tr>
<tr class="separator:ad6113c683762b14e2724497830fe9244"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that gets a pipeline from a text pipeline description. </p>
<p>The methods in this class allow to create a pipeline based on the syntax used in the gst-launch utillity. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad6113c683762b14e2724497830fe9244"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6113c683762b14e2724497830fe9244">◆ </a></span>create_bin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classGst_1_1Element.html">Gst::Element</a>> Gst::Parse::create_bin </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"><em>bin_description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ghost_unconnected_pads</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>This is a convenience wrapper around <a class="el" href="classGst_1_1Parse.html#aca096b4b23818a77d3405a53b06015b4" title="Create a new pipeline based on command line syntax. ">launch()</a> to create a <a class="el" href="classGst_1_1Bin.html" title="Base class and element that can contain other elements. ">Gst::Bin</a> from a gst-launch-style pipeline description. </p>
<p>See <a class="el" href="classGst_1_1Parse.html#aca096b4b23818a77d3405a53b06015b4" title="Create a new pipeline based on command line syntax. ">launch()</a> and the gst-launch man page for details about the syntax. Ghost pads on the bin for unconnected source or sink pads within the bin can automatically be created (but only a maximum of one ghost pad for each direction will be created; if you expect multiple unconnected source pads or multiple unconnected sink pads and want them all ghosted, you will have to create the ghost pads yourself).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bin_description</td><td>Command line describing the bin. </td></tr>
<tr><td class="paramname">ghost_unconnected_pads</td><td>Whether to automatically create ghost pads for unconnected source or sink pads within the bin. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A newly-created bin, or a null RefPtr<> if an error occurred. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classGst_1_1CoreError.html" title="The GStreamer core GError type. ">Gst::CoreError</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="classGst_1_1ParseError.html" title="The different parsing errors that can occur. ">Gst::ParseError</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8694c65abfdc1a36fd9a5a73dd270818"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8694c65abfdc1a36fd9a5a73dd270818">◆ </a></span>error_quark()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Glib::QueryQuark Gst::Parse::error_quark </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 error quark used by the parsing subsystem. </p>
<dl class="section return"><dt>Returns</dt><dd>The quark of the parse errors. </dd></dl>
</div>
</div>
<a id="aca096b4b23818a77d3405a53b06015b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca096b4b23818a77d3405a53b06015b4">◆ </a></span>launch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classGst_1_1Element.html">Gst::Element</a>> Gst::Parse::launch </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"><em>pipeline_description</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">
<p>Create a new pipeline based on command line syntax. </p>
<p>Please note that you might get a return value that is not a null RefPtr<> even though the error is set. In this case there was a recoverable parsing error and you can try to play the pipeline. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pipeline_description</td><td>The command line describing the pipeline. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new element on success, a null RefPtr<> on failure. If more than one toplevel element is specified by the pipeline_description, all elements are put into a <a class="el" href="classGst_1_1Pipeline.html" title="A top-level bin with clocking and bus management functionality. ">Gst::Pipeline</a>, which than is returned. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classGst_1_1CoreError.html" title="The GStreamer core GError type. ">Gst::CoreError</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="classGst_1_1ParseError.html" title="The different parsing errors that can occur. ">Gst::ParseError</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab2d721de450830b53ec6d362cd8cb863"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2d721de450830b53ec6d362cd8cb863">◆ </a></span>launchv()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classGst_1_1Element.html">Gst::Element</a>> Gst::Parse::launchv </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>argv</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">
<p>Create a new element based on command line syntax. </p>
<p>An error does not mean that the pipeline could not be constructed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">argv</td><td>null-terminated array of arguments. specified. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new element on success and null on failure. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classGst_1_1CoreError.html" title="The GStreamer core GError type. ">Gst::CoreError</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="classGst_1_1ParseError.html" title="The different parsing errors that can occur. ">Gst::ParseError</a></td><td></td></tr>
</table>
</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>
