<!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::FormatDefinition 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_1FormatDefinition.html">FormatDefinition</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="classGst_1_1FormatDefinition-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Gst::FormatDefinition Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>A class to store the details of a <a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff" title="Standard predefined formats. ">Gst::Format</a> retrieved by <a class="el" href="namespaceGst.html#ae513e2ac77677b900d96f2efb84c1939" title="Gets details about the given format. ">Gst::get_format_details()</a>. <a href="classGst_1_1FormatDefinition.html#details">More...</a></p> <p><code>#include <gstreamermm/format.h></code></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:aa19a35517ab9a2aee660b365b192fc15"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1FormatDefinition.html#aa19a35517ab9a2aee660b365b192fc15">FormatDefinition</a> ()</td></tr> <tr class="memdesc:aa19a35517ab9a2aee660b365b192fc15"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aa19a35517ab9a2aee660b365b192fc15">More...</a><br /></td></tr> <tr class="separator:aa19a35517ab9a2aee660b365b192fc15"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8e06adbf7abb9a45c0a239e67c45ce51"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1FormatDefinition.html#a8e06adbf7abb9a45c0a239e67c45ce51">FormatDefinition</a> (const GstFormatDefinition* castitem)</td></tr> <tr class="memdesc:a8e06adbf7abb9a45c0a239e67c45ce51"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classGst_1_1FormatDefinition.html" title="A class to store the details of a Gst::Format retrieved by Gst::get_format_details(). ">Gst::FormatDefinition</a> from a C GstFormatDefinition type. <a href="#a8e06adbf7abb9a45c0a239e67c45ce51">More...</a><br /></td></tr> <tr class="separator:a8e06adbf7abb9a45c0a239e67c45ce51"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:ad859e727b3376e4e6e4c26bab486a3e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1FormatDefinition.html#ad859e727b3376e4e6e4c26bab486a3e4">value</a></td></tr> <tr class="memdesc:ad859e727b3376e4e6e4c26bab486a3e4"><td class="mdescLeft"> </td><td class="mdescRight">The unique id of this format. <a href="#ad859e727b3376e4e6e4c26bab486a3e4">More...</a><br /></td></tr> <tr class="separator:ad859e727b3376e4e6e4c26bab486a3e4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a06dcc58fb07498ac2f14eb7b6b51585e"><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1FormatDefinition.html#a06dcc58fb07498ac2f14eb7b6b51585e">nick</a></td></tr> <tr class="memdesc:a06dcc58fb07498ac2f14eb7b6b51585e"><td class="mdescLeft"> </td><td class="mdescRight">A short nick of the format. <a href="#a06dcc58fb07498ac2f14eb7b6b51585e">More...</a><br /></td></tr> <tr class="separator:a06dcc58fb07498ac2f14eb7b6b51585e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a84f9fe07a59118df1966344a4cafb201"><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1FormatDefinition.html#a84f9fe07a59118df1966344a4cafb201">description</a></td></tr> <tr class="memdesc:a84f9fe07a59118df1966344a4cafb201"><td class="mdescLeft"> </td><td class="mdescRight">A longer description of the format. <a href="#a84f9fe07a59118df1966344a4cafb201">More...</a><br /></td></tr> <tr class="separator:a84f9fe07a59118df1966344a4cafb201"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a54042579178c68c9838154e3df7f9982"><td class="memItemLeft" align="right" valign="top">Glib::QueryQuark </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1FormatDefinition.html#a54042579178c68c9838154e3df7f9982">quark</a></td></tr> <tr class="memdesc:a54042579178c68c9838154e3df7f9982"><td class="mdescLeft"> </td><td class="mdescRight">A quark for the nick. <a href="#a54042579178c68c9838154e3df7f9982">More...</a><br /></td></tr> <tr class="separator:a54042579178c68c9838154e3df7f9982"><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 to store the details of a <a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff" title="Standard predefined formats. ">Gst::Format</a> retrieved by <a class="el" href="namespaceGst.html#ae513e2ac77677b900d96f2efb84c1939" title="Gets details about the given format. ">Gst::get_format_details()</a>. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="aa19a35517ab9a2aee660b365b192fc15"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa19a35517ab9a2aee660b365b192fc15">◆ </a></span>FormatDefinition() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::FormatDefinition::FormatDefinition </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Default constructor. </p> </div> </div> <a id="a8e06adbf7abb9a45c0a239e67c45ce51"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8e06adbf7abb9a45c0a239e67c45ce51">◆ </a></span>FormatDefinition() <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::FormatDefinition::FormatDefinition </td> <td>(</td> <td class="paramtype">const GstFormatDefinition * </td> <td class="paramname"><em>castitem</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">explicit</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="classGst_1_1FormatDefinition.html" title="A class to store the details of a Gst::Format retrieved by Gst::get_format_details(). ">Gst::FormatDefinition</a> from a C GstFormatDefinition type. </p> <p>The <em>castitem</em> is left unaffected; its contents are simply copied. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">castitem</td><td>The GstFormatDefinition to copy contents from. </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="a84f9fe07a59118df1966344a4cafb201"></a> <h2 class="memtitle"><span class="permalink"><a href="#a84f9fe07a59118df1966344a4cafb201">◆ </a></span>description</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::ustring Gst::FormatDefinition::description</td> </tr> </table> </div><div class="memdoc"> <p>A longer description of the format. </p> </div> </div> <a id="a06dcc58fb07498ac2f14eb7b6b51585e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a06dcc58fb07498ac2f14eb7b6b51585e">◆ </a></span>nick</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::ustring Gst::FormatDefinition::nick</td> </tr> </table> </div><div class="memdoc"> <p>A short nick of the format. </p> </div> </div> <a id="a54042579178c68c9838154e3df7f9982"></a> <h2 class="memtitle"><span class="permalink"><a href="#a54042579178c68c9838154e3df7f9982">◆ </a></span>quark</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::QueryQuark Gst::FormatDefinition::quark</td> </tr> </table> </div><div class="memdoc"> <p>A quark for the nick. </p> </div> </div> <a id="ad859e727b3376e4e6e4c26bab486a3e4"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad859e727b3376e4e6e4c26bab486a3e4">◆ </a></span>value</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a> Gst::FormatDefinition::value</td> </tr> </table> </div><div class="memdoc"> <p>The unique id of this format. </p> </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>