Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame] | 5 | <title>GstFormat: GStreamer 1.0 Core Reference Manual</title> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 7 | <link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual"> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 8 | <link rel="up" href="libgstreamer.html" title="GStreamer Core Library"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 9 | <link rel="prev" href="GstEvent.html" title="GstEvent"> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 10 | <link rel="next" href="GstGhostPad.html" title="GstGhostPad"> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame] | 11 | <meta name="generator" content="GTK-Doc V1.24 (XML mode)"> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 12 | <link rel="stylesheet" href="style.css" type="text/css"> |
| 13 | </head> |
| 14 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 15 | <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 16 | <td width="100%" align="left" class="shortcuts"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 17 | <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 | <a href="#gstreamer-GstFormat.description" class="shortcut">Description</a></span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 19 | </td> |
| 20 | <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 21 | <td><a accesskey="u" href="libgstreamer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 22 | <td><a accesskey="p" href="GstEvent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 23 | <td><a accesskey="n" href="GstGhostPad.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 24 | </tr></table> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 25 | <div class="refentry"> |
| 26 | <a name="gstreamer-GstFormat"></a><div class="titlepage"></div> |
| 27 | <div class="refnamediv"><table width="100%"><tr> |
| 28 | <td valign="top"> |
| 29 | <h2><span class="refentrytitle"><a name="gstreamer-GstFormat.top_of_page"></a>GstFormat</span></h2> |
| 30 | <p>GstFormat — Dynamically register new data formats</p> |
| 31 | </td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 32 | <td class="gallery_image" valign="top" align="right"></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 33 | </tr></table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 34 | <div class="refsect1"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 35 | <a name="gstreamer-GstFormat.functions"></a><h2>Functions</h2> |
| 36 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 37 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 38 | <col width="150px" class="functions_return"> |
| 39 | <col class="functions_name"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 40 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 41 | <tbody> |
| 42 | <tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 43 | <td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 44 | </td> |
| 45 | <td class="function_name"> |
| 46 | <a class="link" href="gstreamer-GstFormat.html#gst-format-get-name" title="gst_format_get_name ()">gst_format_get_name</a> <span class="c_punctuation">()</span> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 47 | </td> |
| 48 | </tr> |
| 49 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 50 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 51 | <a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 52 | </td> |
| 53 | <td class="function_name"> |
| 54 | <a class="link" href="gstreamer-GstFormat.html#gst-format-to-quark" title="gst_format_to_quark ()">gst_format_to_quark</a> <span class="c_punctuation">()</span> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 55 | </td> |
| 56 | </tr> |
| 57 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 58 | <td class="function_type"> |
| 59 | <a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="returnvalue">GstFormat</span></a> |
| 60 | </td> |
| 61 | <td class="function_name"> |
| 62 | <a class="link" href="gstreamer-GstFormat.html#gst-format-register" title="gst_format_register ()">gst_format_register</a> <span class="c_punctuation">()</span> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 63 | </td> |
| 64 | </tr> |
| 65 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 66 | <td class="function_type"> |
| 67 | <a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="returnvalue">GstFormat</span></a> |
| 68 | </td> |
| 69 | <td class="function_name"> |
| 70 | <a class="link" href="gstreamer-GstFormat.html#gst-format-get-by-nick" title="gst_format_get_by_nick ()">gst_format_get_by_nick</a> <span class="c_punctuation">()</span> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 71 | </td> |
| 72 | </tr> |
| 73 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 74 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 75 | <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 76 | </td> |
| 77 | <td class="function_name"> |
| 78 | <a class="link" href="gstreamer-GstFormat.html#gst-formats-contains" title="gst_formats_contains ()">gst_formats_contains</a> <span class="c_punctuation">()</span> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 79 | </td> |
| 80 | </tr> |
| 81 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 82 | <td class="function_type">const <a class="link" href="gstreamer-GstFormat.html#GstFormatDefinition" title="struct GstFormatDefinition"><span class="returnvalue">GstFormatDefinition</span></a> * |
| 83 | </td> |
| 84 | <td class="function_name"> |
| 85 | <a class="link" href="gstreamer-GstFormat.html#gst-format-get-details" title="gst_format_get_details ()">gst_format_get_details</a> <span class="c_punctuation">()</span> |
| 86 | </td> |
| 87 | </tr> |
| 88 | <tr> |
| 89 | <td class="function_type"> |
| 90 | <a class="link" href="gstreamer-GstIterator.html#GstIterator" title="struct GstIterator"><span class="returnvalue">GstIterator</span></a> * |
| 91 | </td> |
| 92 | <td class="function_name"> |
| 93 | <a class="link" href="gstreamer-GstFormat.html#gst-format-iterate-definitions" title="gst_format_iterate_definitions ()">gst_format_iterate_definitions</a> <span class="c_punctuation">()</span> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 94 | </td> |
| 95 | </tr> |
| 96 | </tbody> |
| 97 | </table></div> |
| 98 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 99 | <div class="refsect1"> |
| 100 | <a name="gstreamer-GstFormat.other"></a><h2>Types and Values</h2> |
| 101 | <div class="informaltable"><table width="100%" border="0"> |
| 102 | <colgroup> |
| 103 | <col width="150px" class="name"> |
| 104 | <col class="description"> |
| 105 | </colgroup> |
| 106 | <tbody> |
| 107 | <tr> |
| 108 | <td class="datatype_keyword">enum</td> |
| 109 | <td class="function_name"><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat">GstFormat</a></td> |
| 110 | </tr> |
| 111 | <tr> |
| 112 | <td class="define_keyword">#define</td> |
| 113 | <td class="function_name"><a class="link" href="gstreamer-GstFormat.html#GST-FORMAT-PERCENT-MAX:CAPS" title="GST_FORMAT_PERCENT_MAX">GST_FORMAT_PERCENT_MAX</a></td> |
| 114 | </tr> |
| 115 | <tr> |
| 116 | <td class="define_keyword">#define</td> |
| 117 | <td class="function_name"><a class="link" href="gstreamer-GstFormat.html#GST-FORMAT-PERCENT-SCALE:CAPS" title="GST_FORMAT_PERCENT_SCALE">GST_FORMAT_PERCENT_SCALE</a></td> |
| 118 | </tr> |
| 119 | <tr> |
| 120 | <td class="datatype_keyword">struct</td> |
| 121 | <td class="function_name"><a class="link" href="gstreamer-GstFormat.html#GstFormatDefinition" title="struct GstFormatDefinition">GstFormatDefinition</a></td> |
| 122 | </tr> |
| 123 | </tbody> |
| 124 | </table></div> |
| 125 | </div> |
| 126 | <div class="refsect1"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 127 | <a name="gstreamer-GstFormat.includes"></a><h2>Includes</h2> |
| 128 | <pre class="synopsis">#include <gst/gst.h> |
| 129 | </pre> |
| 130 | </div> |
| 131 | <div class="refsect1"> |
| 132 | <a name="gstreamer-GstFormat.description"></a><h2>Description</h2> |
| 133 | <p>GstFormats functions are used to register a new format to the gstreamer |
| 134 | core. Formats can be used to perform seeking or conversions/query |
| 135 | operations.</p> |
| 136 | </div> |
| 137 | <div class="refsect1"> |
| 138 | <a name="gstreamer-GstFormat.functions_details"></a><h2>Functions</h2> |
| 139 | <div class="refsect2"> |
| 140 | <a name="gst-format-get-name"></a><h3>gst_format_get_name ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 141 | <pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 142 | gst_format_get_name (<em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>);</pre> |
| 143 | <p>Get a printable name for the given format. Do not modify or free.</p> |
| 144 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 145 | <a name="id-1.3.25.7.2.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 146 | <div class="informaltable"><table width="100%" border="0"> |
| 147 | <colgroup> |
| 148 | <col width="150px" class="parameters_name"> |
| 149 | <col class="parameters_description"> |
| 150 | <col width="200px" class="parameters_annotations"> |
| 151 | </colgroup> |
| 152 | <tbody><tr> |
| 153 | <td class="parameter_name"><p>format</p></td> |
| 154 | <td class="parameter_description"><p>a <a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a></p></td> |
| 155 | <td class="parameter_annotations"> </td> |
| 156 | </tr></tbody> |
| 157 | </table></div> |
| 158 | </div> |
| 159 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 160 | <a name="id-1.3.25.7.2.6"></a><h4>Returns</h4> |
| 161 | <p> a reference to the static name of the format |
| 162 | or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the format is unknown. </p> |
| 163 | <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 164 | </div> |
| 165 | </div> |
| 166 | <hr> |
| 167 | <div class="refsect2"> |
| 168 | <a name="gst-format-to-quark"></a><h3>gst_format_to_quark ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 169 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 170 | gst_format_to_quark (<em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>);</pre> |
| 171 | <p>Get the unique quark for the given format.</p> |
| 172 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 173 | <a name="id-1.3.25.7.3.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 174 | <div class="informaltable"><table width="100%" border="0"> |
| 175 | <colgroup> |
| 176 | <col width="150px" class="parameters_name"> |
| 177 | <col class="parameters_description"> |
| 178 | <col width="200px" class="parameters_annotations"> |
| 179 | </colgroup> |
| 180 | <tbody><tr> |
| 181 | <td class="parameter_name"><p>format</p></td> |
| 182 | <td class="parameter_description"><p>a <a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a></p></td> |
| 183 | <td class="parameter_annotations"> </td> |
| 184 | </tr></tbody> |
| 185 | </table></div> |
| 186 | </div> |
| 187 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 188 | <a name="id-1.3.25.7.3.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 189 | <p> the quark associated with the format or 0 if the format |
| 190 | is unknown.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 191 | </div> |
| 192 | </div> |
| 193 | <hr> |
| 194 | <div class="refsect2"> |
| 195 | <a name="gst-format-register"></a><h3>gst_format_register ()</h3> |
| 196 | <pre class="programlisting"><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="returnvalue">GstFormat</span></a> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 197 | gst_format_register (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>, |
| 198 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 199 | <p>Create a new GstFormat based on the nick or return an |
| 200 | already registered format with that nick.</p> |
| 201 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 202 | <a name="id-1.3.25.7.4.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 203 | <div class="informaltable"><table width="100%" border="0"> |
| 204 | <colgroup> |
| 205 | <col width="150px" class="parameters_name"> |
| 206 | <col class="parameters_description"> |
| 207 | <col width="200px" class="parameters_annotations"> |
| 208 | </colgroup> |
| 209 | <tbody> |
| 210 | <tr> |
| 211 | <td class="parameter_name"><p>nick</p></td> |
| 212 | <td class="parameter_description"><p>The nick of the new format</p></td> |
| 213 | <td class="parameter_annotations"> </td> |
| 214 | </tr> |
| 215 | <tr> |
| 216 | <td class="parameter_name"><p>description</p></td> |
| 217 | <td class="parameter_description"><p>The description of the new format</p></td> |
| 218 | <td class="parameter_annotations"> </td> |
| 219 | </tr> |
| 220 | </tbody> |
| 221 | </table></div> |
| 222 | </div> |
| 223 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 224 | <a name="id-1.3.25.7.4.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 225 | <p> A new GstFormat or an already registered format |
| 226 | with the same nick.</p> |
| 227 | <p>MT safe.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 228 | </div> |
| 229 | </div> |
| 230 | <hr> |
| 231 | <div class="refsect2"> |
| 232 | <a name="gst-format-get-by-nick"></a><h3>gst_format_get_by_nick ()</h3> |
| 233 | <pre class="programlisting"><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="returnvalue">GstFormat</span></a> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 234 | gst_format_get_by_nick (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 235 | <p>Return the format registered with the given nick.</p> |
| 236 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 237 | <a name="id-1.3.25.7.5.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 238 | <div class="informaltable"><table width="100%" border="0"> |
| 239 | <colgroup> |
| 240 | <col width="150px" class="parameters_name"> |
| 241 | <col class="parameters_description"> |
| 242 | <col width="200px" class="parameters_annotations"> |
| 243 | </colgroup> |
| 244 | <tbody><tr> |
| 245 | <td class="parameter_name"><p>nick</p></td> |
| 246 | <td class="parameter_description"><p>The nick of the format</p></td> |
| 247 | <td class="parameter_annotations"> </td> |
| 248 | </tr></tbody> |
| 249 | </table></div> |
| 250 | </div> |
| 251 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 252 | <a name="id-1.3.25.7.5.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 253 | <p> The format with <em class="parameter"><code>nick</code></em> |
| 254 | or GST_FORMAT_UNDEFINED |
| 255 | if the format was not registered.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 256 | </div> |
| 257 | </div> |
| 258 | <hr> |
| 259 | <div class="refsect2"> |
| 260 | <a name="gst-formats-contains"></a><h3>gst_formats_contains ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 261 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 262 | gst_formats_contains (<em class="parameter"><code>const <a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> *formats</code></em>, |
| 263 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>);</pre> |
| 264 | <p>See if the given format is inside the format array.</p> |
| 265 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 266 | <a name="id-1.3.25.7.6.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 267 | <div class="informaltable"><table width="100%" border="0"> |
| 268 | <colgroup> |
| 269 | <col width="150px" class="parameters_name"> |
| 270 | <col class="parameters_description"> |
| 271 | <col width="200px" class="parameters_annotations"> |
| 272 | </colgroup> |
| 273 | <tbody> |
| 274 | <tr> |
| 275 | <td class="parameter_name"><p>formats</p></td> |
| 276 | <td class="parameter_description"><p> The format array to search. </p></td> |
| 277 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> |
| 278 | </tr> |
| 279 | <tr> |
| 280 | <td class="parameter_name"><p>format</p></td> |
| 281 | <td class="parameter_description"><p>the format to find</p></td> |
| 282 | <td class="parameter_annotations"> </td> |
| 283 | </tr> |
| 284 | </tbody> |
| 285 | </table></div> |
| 286 | </div> |
| 287 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 288 | <a name="id-1.3.25.7.6.6"></a><h4>Returns</h4> |
| 289 | <p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the format is found inside the array</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 290 | </div> |
| 291 | </div> |
| 292 | <hr> |
| 293 | <div class="refsect2"> |
| 294 | <a name="gst-format-get-details"></a><h3>gst_format_get_details ()</h3> |
| 295 | <pre class="programlisting">const <a class="link" href="gstreamer-GstFormat.html#GstFormatDefinition" title="struct GstFormatDefinition"><span class="returnvalue">GstFormatDefinition</span></a> * |
| 296 | gst_format_get_details (<em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>);</pre> |
| 297 | <p>Get details about the given format.</p> |
| 298 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 299 | <a name="id-1.3.25.7.7.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 300 | <div class="informaltable"><table width="100%" border="0"> |
| 301 | <colgroup> |
| 302 | <col width="150px" class="parameters_name"> |
| 303 | <col class="parameters_description"> |
| 304 | <col width="200px" class="parameters_annotations"> |
| 305 | </colgroup> |
| 306 | <tbody><tr> |
| 307 | <td class="parameter_name"><p>format</p></td> |
| 308 | <td class="parameter_description"><p>The format to get details of</p></td> |
| 309 | <td class="parameter_annotations"> </td> |
| 310 | </tr></tbody> |
| 311 | </table></div> |
| 312 | </div> |
| 313 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 314 | <a name="id-1.3.25.7.7.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 315 | <p> The <a class="link" href="gstreamer-GstFormat.html#GstFormatDefinition" title="struct GstFormatDefinition"><span class="type">GstFormatDefinition</span></a> for <em class="parameter"><code>format</code></em> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 316 | or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> |
| 317 | on failure.</p> |
| 318 | <p>MT safe. </p> |
| 319 | <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 320 | </div> |
| 321 | </div> |
| 322 | <hr> |
| 323 | <div class="refsect2"> |
| 324 | <a name="gst-format-iterate-definitions"></a><h3>gst_format_iterate_definitions ()</h3> |
| 325 | <pre class="programlisting"><a class="link" href="gstreamer-GstIterator.html#GstIterator" title="struct GstIterator"><span class="returnvalue">GstIterator</span></a> * |
| 326 | gst_format_iterate_definitions (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 327 | <p>Iterate all the registered formats. The format definition is read |
| 328 | only.</p> |
| 329 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 330 | <a name="id-1.3.25.7.8.5"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 331 | <p> a GstIterator of <a class="link" href="gstreamer-GstFormat.html#GstFormatDefinition" title="struct GstFormatDefinition"><span class="type">GstFormatDefinition</span></a>. </p> |
| 332 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 333 | </div> |
| 334 | </div> |
| 335 | </div> |
| 336 | <div class="refsect1"> |
| 337 | <a name="gstreamer-GstFormat.other_details"></a><h2>Types and Values</h2> |
| 338 | <div class="refsect2"> |
| 339 | <a name="GstFormat"></a><h3>enum GstFormat</h3> |
| 340 | <p>Standard predefined formats</p> |
| 341 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 342 | <a name="id-1.3.25.8.2.4"></a><h4>Members</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 343 | <div class="informaltable"><table width="100%" border="0"> |
| 344 | <colgroup> |
| 345 | <col width="300px" class="enum_members_name"> |
| 346 | <col class="enum_members_description"> |
| 347 | <col width="200px" class="enum_members_annotations"> |
| 348 | </colgroup> |
| 349 | <tbody> |
| 350 | <tr> |
| 351 | <td class="enum_member_name"><p><a name="GST-FORMAT-UNDEFINED:CAPS"></a>GST_FORMAT_UNDEFINED</p></td> |
| 352 | <td class="enum_member_description"> |
| 353 | <p>undefined format</p> |
| 354 | </td> |
| 355 | <td class="enum_member_annotations"> </td> |
| 356 | </tr> |
| 357 | <tr> |
| 358 | <td class="enum_member_name"><p><a name="GST-FORMAT-DEFAULT:CAPS"></a>GST_FORMAT_DEFAULT</p></td> |
| 359 | <td class="enum_member_description"> |
| 360 | <p>the default format of the pad/element. This can be |
| 361 | samples for raw audio, frames/fields for raw video (some, but not all, |
| 362 | elements support this; use <em class="parameter"><code>GST_FORMAT_TIME</code></em> |
| 363 | if you don't have a good |
| 364 | reason to query for samples/frames)</p> |
| 365 | </td> |
| 366 | <td class="enum_member_annotations"> </td> |
| 367 | </tr> |
| 368 | <tr> |
| 369 | <td class="enum_member_name"><p><a name="GST-FORMAT-BYTES:CAPS"></a>GST_FORMAT_BYTES</p></td> |
| 370 | <td class="enum_member_description"> |
| 371 | <p>bytes</p> |
| 372 | </td> |
| 373 | <td class="enum_member_annotations"> </td> |
| 374 | </tr> |
| 375 | <tr> |
| 376 | <td class="enum_member_name"><p><a name="GST-FORMAT-TIME:CAPS"></a>GST_FORMAT_TIME</p></td> |
| 377 | <td class="enum_member_description"> |
| 378 | <p>time in nanoseconds</p> |
| 379 | </td> |
| 380 | <td class="enum_member_annotations"> </td> |
| 381 | </tr> |
| 382 | <tr> |
| 383 | <td class="enum_member_name"><p><a name="GST-FORMAT-BUFFERS:CAPS"></a>GST_FORMAT_BUFFERS</p></td> |
| 384 | <td class="enum_member_description"> |
| 385 | <p>buffers (few, if any, elements implement this as of |
| 386 | May 2009)</p> |
| 387 | </td> |
| 388 | <td class="enum_member_annotations"> </td> |
| 389 | </tr> |
| 390 | <tr> |
| 391 | <td class="enum_member_name"><p><a name="GST-FORMAT-PERCENT:CAPS"></a>GST_FORMAT_PERCENT</p></td> |
| 392 | <td class="enum_member_description"> |
| 393 | <p>percentage of stream (few, if any, elements implement |
| 394 | this as of May 2009)</p> |
| 395 | </td> |
| 396 | <td class="enum_member_annotations"> </td> |
| 397 | </tr> |
| 398 | </tbody> |
| 399 | </table></div> |
| 400 | </div> |
| 401 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 402 | <hr> |
| 403 | <div class="refsect2"> |
| 404 | <a name="GST-FORMAT-PERCENT-MAX:CAPS"></a><h3>GST_FORMAT_PERCENT_MAX</h3> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 405 | <pre class="programlisting">#define GST_FORMAT_PERCENT_MAX G_GINT64_CONSTANT (1000000) |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 406 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 407 | <p>The PERCENT format is between 0 and this value</p> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 408 | </div> |
| 409 | <hr> |
| 410 | <div class="refsect2"> |
| 411 | <a name="GST-FORMAT-PERCENT-SCALE:CAPS"></a><h3>GST_FORMAT_PERCENT_SCALE</h3> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 412 | <pre class="programlisting">#define GST_FORMAT_PERCENT_SCALE G_GINT64_CONSTANT (10000) |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 413 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 414 | <p>The value used to scale down the reported PERCENT format value to |
| 415 | its real value.</p> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 416 | </div> |
| 417 | <hr> |
| 418 | <div class="refsect2"> |
| 419 | <a name="GstFormatDefinition"></a><h3>struct GstFormatDefinition</h3> |
| 420 | <pre class="programlisting">struct GstFormatDefinition { |
| 421 | GstFormat value; |
| 422 | const gchar *nick; |
| 423 | const gchar *description; |
| 424 | GQuark quark; |
| 425 | }; |
| 426 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 427 | <p>A format definition</p> |
| 428 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 429 | <a name="id-1.3.25.8.5.5"></a><h4>Members</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 430 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 431 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 432 | <col width="300px" class="struct_members_name"> |
| 433 | <col class="struct_members_description"> |
| 434 | <col width="200px" class="struct_members_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 435 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 436 | <tbody> |
| 437 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 438 | <td class="struct_member_name"><p><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> <em class="structfield"><code><a name="GstFormatDefinition.value"></a>value</code></em>;</p></td> |
| 439 | <td class="struct_member_description"><p>The unique id of this format</p></td> |
| 440 | <td class="struct_member_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 441 | </tr> |
| 442 | <tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 443 | <td class="struct_member_name"><p>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstFormatDefinition.nick"></a>nick</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 444 | <td class="struct_member_description"><p>A short nick of the format</p></td> |
| 445 | <td class="struct_member_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 446 | </tr> |
| 447 | <tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 448 | <td class="struct_member_name"><p>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstFormatDefinition.description"></a>description</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 449 | <td class="struct_member_description"><p>A longer description of the format</p></td> |
| 450 | <td class="struct_member_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 451 | </tr> |
| 452 | <tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 453 | <td class="struct_member_name"><p><a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> <em class="structfield"><code><a name="GstFormatDefinition.quark"></a>quark</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 454 | <td class="struct_member_description"><p>A quark for the nick</p></td> |
| 455 | <td class="struct_member_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 456 | </tr> |
| 457 | </tbody> |
| 458 | </table></div> |
| 459 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 460 | </div> |
| 461 | </div> |
| 462 | <div class="refsect1"> |
| 463 | <a name="gstreamer-GstFormat.see-also"></a><h2>See Also</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 464 | <p><a class="link" href="GstPad.html" title="GstPad"><span class="type">GstPad</span></a>, <a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a></p> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 465 | </div> |
| 466 | </div> |
| 467 | <div class="footer"> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame] | 468 | <hr>Generated by GTK-Doc V1.24</div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 469 | </body> |
| 470 | </html> |