34
31
<p>gstpbutilsdescriptions — Provides human-readable descriptions for caps/codecs
35
32
and encoder, decoder, URI source and URI sink elements</p>
37
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
38
35
</tr></table></div>
39
<div class="refsynopsisdiv">
40
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.synopsis"></a><h2>Synopsis</h2>
41
<pre class="synopsis">
42
#include <gst/pbutils/descriptions.h>
44
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-source-description" title="gst_pb_utils_get_source_description ()">gst_pb_utils_get_source_description</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);
45
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-sink-description" title="gst_pb_utils_get_sink_description ()">gst_pb_utils_get_sink_description</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);
46
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-decoder-description" title="gst_pb_utils_get_decoder_description ()">gst_pb_utils_get_decoder_description</a>
47
(<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-encoder-description" title="gst_pb_utils_get_encoder_description ()">gst_pb_utils_get_encoder_description</a>
49
(<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-element-description" title="gst_pb_utils_get_element_description ()">gst_pb_utils_get_element_description</a>
51
(<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *factory_name</code></em>);
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-add-codec-description-to-tag-list" title="gst_pb_utils_add_codec_description_to_tag_list ()">gst_pb_utils_add_codec_description_to_tag_list</a>
54
(<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *taglist</code></em>,
55
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *codec_tag</code></em>,
56
<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-codec-description" title="gst_pb_utils_get_codec_description ()">gst_pb_utils_get_codec_description</a> (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
36
<div class="refsect1">
37
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
45
<td class="function_type">
46
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
48
<td class="function_name">
49
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-source-description" title="gst_pb_utils_get_source_description ()">gst_pb_utils_get_source_description</a> <span class="c_punctuation">()</span>
53
<td class="function_type">
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
56
<td class="function_name">
57
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-sink-description" title="gst_pb_utils_get_sink_description ()">gst_pb_utils_get_sink_description</a> <span class="c_punctuation">()</span>
61
<td class="function_type">
62
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
64
<td class="function_name">
65
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-decoder-description" title="gst_pb_utils_get_decoder_description ()">gst_pb_utils_get_decoder_description</a> <span class="c_punctuation">()</span>
69
<td class="function_type">
70
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
72
<td class="function_name">
73
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-encoder-description" title="gst_pb_utils_get_encoder_description ()">gst_pb_utils_get_encoder_description</a> <span class="c_punctuation">()</span>
77
<td class="function_type">
78
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
80
<td class="function_name">
81
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-element-description" title="gst_pb_utils_get_element_description ()">gst_pb_utils_get_element_description</a> <span class="c_punctuation">()</span>
85
<td class="function_type">
86
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
88
<td class="function_name">
89
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-add-codec-description-to-tag-list" title="gst_pb_utils_add_codec_description_to_tag_list ()">gst_pb_utils_add_codec_description_to_tag_list</a> <span class="c_punctuation">()</span>
93
<td class="function_type">
94
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
96
<td class="function_name">
97
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-get-codec-description" title="gst_pb_utils_get_codec_description ()">gst_pb_utils_get_codec_description</a> <span class="c_punctuation">()</span>
103
<div class="refsect1">
104
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.object-hierarchy"></a><h2>Object Hierarchy</h2>
108
<div class="refsect1">
109
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.includes"></a><h2>Includes</h2>
110
<pre class="synopsis">#include <gst/pbutils/descriptions.h>
60
113
<div class="refsect1">
61
114
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.description"></a><h2>Description</h2>
64
115
<div class="refsect2">
65
<a name="id-1.2.13.6.4.2.1"></a><p>
116
<a name="id-1.2.13.6.6.2"></a><p>
66
117
The above functions provide human-readable strings for media formats
67
118
and decoder/demuxer/depayloader/encoder/muxer/payloader elements for use
68
119
in error dialogs or other messages shown to users.
71
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-add-codec-description-to-tag-list" title="gst_pb_utils_add_codec_description_to_tag_list ()"><code class="function">gst_pb_utils_add_codec_description_to_tag_list()</code></a> is a utility function
122
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-add-codec-description-to-tag-list" title="gst_pb_utils_add_codec_description_to_tag_list ()"><code class="function">gst_pb_utils_add_codec_description_to_tag_list()</code></a> is a utility function
72
123
for demuxer and decoder elements to add audio/video codec tags from a
73
124
given (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>.
79
128
<div class="refsect1">
80
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.details"></a><h2>Details</h2>
81
<div class="refsect2">
82
<a name="gst-pb-utils-get-source-description"></a><h3>gst_pb_utils_get_source_description ()</h3>
83
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_pb_utils_get_source_description (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
85
Returns a localised string describing a source element handling the protocol
86
specified in <em class="parameter"><code>protocol</code></em>, for use in error dialogs or other messages to be
87
seen by the user. Should never return NULL unless <em class="parameter"><code>protocol</code></em> is invalid.
90
This function is mainly for internal use, applications would typically
91
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
92
a missing feature from a missing-plugin message.
94
<div class="variablelist"><table border="0" class="variablelist">
96
<col align="left" valign="top">
101
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
102
<td>the protocol the source element needs to handle, e.g. "http"</td>
105
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
106
<td>a newly-allocated description string, or NULL on error. Free
107
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</td>
113
<div class="refsect2">
114
<a name="gst-pb-utils-get-sink-description"></a><h3>gst_pb_utils_get_sink_description ()</h3>
115
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_pb_utils_get_sink_description (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
117
Returns a localised string describing a sink element handling the protocol
118
specified in <em class="parameter"><code>protocol</code></em>, for use in error dialogs or other messages to be
119
seen by the user. Should never return NULL unless <em class="parameter"><code>protocol</code></em> is invalid.
122
This function is mainly for internal use, applications would typically
123
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
124
a missing feature from a missing-plugin message.
126
<div class="variablelist"><table border="0" class="variablelist">
128
<col align="left" valign="top">
133
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
134
<td>the protocol the sink element needs to handle, e.g. "http"</td>
137
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
138
<td>a newly-allocated description string, or NULL on error. Free
139
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</td>
145
<div class="refsect2">
146
<a name="gst-pb-utils-get-decoder-description"></a><h3>gst_pb_utils_get_decoder_description ()</h3>
147
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_pb_utils_get_decoder_description
148
(<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
150
Returns a localised string describing an decoder for the format specified
151
in <em class="parameter"><code>caps</code></em>, for use in error dialogs or other messages to be seen by the user.
152
Should never return NULL unless <em class="parameter"><code>factory_name</code></em> or <em class="parameter"><code>caps</code></em> are invalid.
155
This function is mainly for internal use, applications would typically
156
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
157
a missing feature from a missing-plugin message.
159
<div class="variablelist"><table border="0" class="variablelist">
161
<col align="left" valign="top">
166
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
167
<td>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which an decoder description is needed</td>
170
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
171
<td>a newly-allocated description string, or NULL on error. Free
172
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</td>
178
<div class="refsect2">
179
<a name="gst-pb-utils-get-encoder-description"></a><h3>gst_pb_utils_get_encoder_description ()</h3>
180
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_pb_utils_get_encoder_description
181
(<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
183
Returns a localised string describing an encoder for the format specified
184
in <em class="parameter"><code>caps</code></em>, for use in error dialogs or other messages to be seen by the user.
185
Should never return NULL unless <em class="parameter"><code>factory_name</code></em> or <em class="parameter"><code>caps</code></em> are invalid.
188
This function is mainly for internal use, applications would typically
189
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
190
a missing feature from a missing-plugin message.
192
<div class="variablelist"><table border="0" class="variablelist">
194
<col align="left" valign="top">
199
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
200
<td>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which an encoder description is needed</td>
203
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
204
<td>a newly-allocated description string, or NULL on error. Free
205
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</td>
211
<div class="refsect2">
212
<a name="gst-pb-utils-get-element-description"></a><h3>gst_pb_utils_get_element_description ()</h3>
213
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_pb_utils_get_element_description
214
(<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *factory_name</code></em>);</pre>
216
Returns a localised string describing the given element, for use in
129
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.functions_details"></a><h2>Functions</h2>
130
<div class="refsect2">
131
<a name="gst-pb-utils-get-source-description"></a><h3>gst_pb_utils_get_source_description ()</h3>
132
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
133
gst_pb_utils_get_source_description (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
134
<p>Returns a localised string describing a source element handling the protocol
135
specified in <em class="parameter"><code>protocol</code></em>
136
, for use in error dialogs or other messages to be
137
seen by the user. Should never return NULL unless <em class="parameter"><code>protocol</code></em>
139
<p>This function is mainly for internal use, applications would typically
140
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
141
a missing feature from a missing-plugin message.</p>
142
<div class="refsect3">
143
<a name="id-1.2.13.6.7.2.6"></a><h4>Parameters</h4>
144
<div class="informaltable"><table width="100%" border="0">
146
<col width="150px" class="parameters_name">
147
<col class="parameters_description">
148
<col width="200px" class="parameters_annotations">
151
<td class="parameter_name"><p>protocol</p></td>
152
<td class="parameter_description"><p>the protocol the source element needs to handle, e.g. "http"</p></td>
153
<td class="parameter_annotations"> </td>
157
<div class="refsect3">
158
<a name="id-1.2.13.6.7.2.7"></a><h4>Returns</h4>
159
<p> a newly-allocated description string, or NULL on error. Free
160
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</p>
165
<div class="refsect2">
166
<a name="gst-pb-utils-get-sink-description"></a><h3>gst_pb_utils_get_sink_description ()</h3>
167
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
168
gst_pb_utils_get_sink_description (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
169
<p>Returns a localised string describing a sink element handling the protocol
170
specified in <em class="parameter"><code>protocol</code></em>
171
, for use in error dialogs or other messages to be
172
seen by the user. Should never return NULL unless <em class="parameter"><code>protocol</code></em>
174
<p>This function is mainly for internal use, applications would typically
175
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
176
a missing feature from a missing-plugin message.</p>
177
<div class="refsect3">
178
<a name="id-1.2.13.6.7.3.6"></a><h4>Parameters</h4>
179
<div class="informaltable"><table width="100%" border="0">
181
<col width="150px" class="parameters_name">
182
<col class="parameters_description">
183
<col width="200px" class="parameters_annotations">
186
<td class="parameter_name"><p>protocol</p></td>
187
<td class="parameter_description"><p>the protocol the sink element needs to handle, e.g. "http"</p></td>
188
<td class="parameter_annotations"> </td>
192
<div class="refsect3">
193
<a name="id-1.2.13.6.7.3.7"></a><h4>Returns</h4>
194
<p> a newly-allocated description string, or NULL on error. Free
195
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</p>
200
<div class="refsect2">
201
<a name="gst-pb-utils-get-decoder-description"></a><h3>gst_pb_utils_get_decoder_description ()</h3>
202
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
203
gst_pb_utils_get_decoder_description (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
204
<p>Returns a localised string describing an decoder for the format specified
205
in <em class="parameter"><code>caps</code></em>
206
, for use in error dialogs or other messages to be seen by the user.
207
Should never return NULL unless <em class="parameter"><code>factory_name</code></em>
208
or <em class="parameter"><code>caps</code></em>
210
<p>This function is mainly for internal use, applications would typically
211
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
212
a missing feature from a missing-plugin message.</p>
213
<div class="refsect3">
214
<a name="id-1.2.13.6.7.4.6"></a><h4>Parameters</h4>
215
<div class="informaltable"><table width="100%" border="0">
217
<col width="150px" class="parameters_name">
218
<col class="parameters_description">
219
<col width="200px" class="parameters_annotations">
222
<td class="parameter_name"><p>caps</p></td>
223
<td class="parameter_description"><p>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which an decoder description is needed</p></td>
224
<td class="parameter_annotations"> </td>
228
<div class="refsect3">
229
<a name="id-1.2.13.6.7.4.7"></a><h4>Returns</h4>
230
<p> a newly-allocated description string, or NULL on error. Free
231
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</p>
236
<div class="refsect2">
237
<a name="gst-pb-utils-get-encoder-description"></a><h3>gst_pb_utils_get_encoder_description ()</h3>
238
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
239
gst_pb_utils_get_encoder_description (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
240
<p>Returns a localised string describing an encoder for the format specified
241
in <em class="parameter"><code>caps</code></em>
242
, for use in error dialogs or other messages to be seen by the user.
243
Should never return NULL unless <em class="parameter"><code>factory_name</code></em>
244
or <em class="parameter"><code>caps</code></em>
246
<p>This function is mainly for internal use, applications would typically
247
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
248
a missing feature from a missing-plugin message.</p>
249
<div class="refsect3">
250
<a name="id-1.2.13.6.7.5.6"></a><h4>Parameters</h4>
251
<div class="informaltable"><table width="100%" border="0">
253
<col width="150px" class="parameters_name">
254
<col class="parameters_description">
255
<col width="200px" class="parameters_annotations">
258
<td class="parameter_name"><p>caps</p></td>
259
<td class="parameter_description"><p>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which an encoder description is needed</p></td>
260
<td class="parameter_annotations"> </td>
264
<div class="refsect3">
265
<a name="id-1.2.13.6.7.5.7"></a><h4>Returns</h4>
266
<p> a newly-allocated description string, or NULL on error. Free
267
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</p>
272
<div class="refsect2">
273
<a name="gst-pb-utils-get-element-description"></a><h3>gst_pb_utils_get_element_description ()</h3>
274
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
275
gst_pb_utils_get_element_description (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *factory_name</code></em>);</pre>
276
<p>Returns a localised string describing the given element, for use in
217
277
error dialogs or other messages to be seen by the user. Should never
218
return NULL unless <em class="parameter"><code>factory_name</code></em> is invalid.
221
This function is mainly for internal use, applications would typically
222
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
223
a missing feature from a missing-plugin message.
225
<div class="variablelist"><table border="0" class="variablelist">
278
return NULL unless <em class="parameter"><code>factory_name</code></em>
280
<p>This function is mainly for internal use, applications would typically
281
use <a class="link" href="gst-plugins-base-libs-gstpbutilsmissingplugins.html#gst-missing-plugin-message-get-description" title="gst_missing_plugin_message_get_description ()"><code class="function">gst_missing_plugin_message_get_description()</code></a> to get a description of
282
a missing feature from a missing-plugin message.</p>
283
<div class="refsect3">
284
<a name="id-1.2.13.6.7.6.6"></a><h4>Parameters</h4>
285
<div class="informaltable"><table width="100%" border="0">
227
<col align="left" valign="top">
287
<col width="150px" class="parameters_name">
288
<col class="parameters_description">
289
<col width="200px" class="parameters_annotations">
232
<td><p><span class="term"><em class="parameter"><code>factory_name</code></em> :</span></p></td>
233
<td>the name of the element, e.g. "giosrc"</td>
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
237
<td>a newly-allocated description string, or NULL on error. Free
238
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</td>
292
<td class="parameter_name"><p>factory_name</p></td>
293
<td class="parameter_description"><p>the name of the element, e.g. "giosrc"</p></td>
294
<td class="parameter_annotations"> </td>
298
<div class="refsect3">
299
<a name="id-1.2.13.6.7.6.7"></a><h4>Returns</h4>
300
<p> a newly-allocated description string, or NULL on error. Free
301
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</p>
244
306
<div class="refsect2">
245
<a name="gst-pb-utils-add-codec-description-to-tag-list"></a><h3>gst_pb_utils_add_codec_description_to_tag_list ()</h3>
246
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_pb_utils_add_codec_description_to_tag_list
247
(<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *taglist</code></em>,
248
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *codec_tag</code></em>,
249
<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
251
Adds a codec tag describing the format specified by <em class="parameter"><code>caps</code></em> to <em class="parameter"><code>taglist</code></em>.
253
<div class="variablelist"><table border="0" class="variablelist">
307
<a name="gst-pb-utils-add-codec-description-to-tag-list"></a><h3>gst_pb_utils_add_codec_description_to_tag_list ()</h3>
308
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
309
gst_pb_utils_add_codec_description_to_tag_list
310
(<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *taglist</code></em>,
311
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *codec_tag</code></em>,
312
<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
313
<p>Adds a codec tag describing the format specified by <em class="parameter"><code>caps</code></em>
314
to <em class="parameter"><code>taglist</code></em>
316
<div class="refsect3">
317
<a name="id-1.2.13.6.7.7.5"></a><h4>Parameters</h4>
318
<div class="informaltable"><table width="100%" border="0">
255
<col align="left" valign="top">
320
<col width="150px" class="parameters_name">
321
<col class="parameters_description">
322
<col width="200px" class="parameters_annotations">
260
<td><p><span class="term"><em class="parameter"><code>taglist</code></em> :</span></p></td>
261
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
326
<td class="parameter_name"><p>taglist</p></td>
327
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a></p></td>
328
<td class="parameter_annotations"> </td>
265
<td><p><span class="term"><em class="parameter"><code>codec_tag</code></em> :</span></p></td>
266
<td>a GStreamer codec tag such as <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GST-TAG-AUDIO-CODEC:CAPS"><span class="type">GST_TAG_AUDIO_CODEC</span></a>,
331
<td class="parameter_name"><p>codec_tag</p></td>
332
<td class="parameter_description"><p> a GStreamer codec tag such as <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GST-TAG-AUDIO-CODEC:CAPS"><span class="type">GST_TAG_AUDIO_CODEC</span></a>,
267
333
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GST-TAG-VIDEO-CODEC:CAPS"><span class="type">GST_TAG_VIDEO_CODEC</span></a> or <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GST-TAG-CODEC:CAPS"><span class="type">GST_TAG_CODEC</span></a>. If none is specified,
268
the function will attempt to detect the appropriate category. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
272
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
273
<td>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which a codec tag should be added.</td>
276
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
277
<td>TRUE if a codec tag was added, FALSE otherwise.</td>
334
the function will attempt to detect the appropriate category. </p></td>
335
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
338
<td class="parameter_name"><p>caps</p></td>
339
<td class="parameter_description"><p>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which a codec tag should be added.</p></td>
340
<td class="parameter_annotations"> </td>
345
<div class="refsect3">
346
<a name="id-1.2.13.6.7.7.6"></a><h4>Returns</h4>
347
<p> TRUE if a codec tag was added, FALSE otherwise.</p>
283
352
<div class="refsect2">
284
<a name="gst-pb-utils-get-codec-description"></a><h3>gst_pb_utils_get_codec_description ()</h3>
285
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_pb_utils_get_codec_description (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
287
Returns a localised (as far as this is possible) string describing the
288
media format specified in <em class="parameter"><code>caps</code></em>, for use in error dialogs or other messages
289
to be seen by the user. Should never return NULL unless <em class="parameter"><code>caps</code></em> is invalid.
292
Also see the convenience function
293
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-add-codec-description-to-tag-list" title="gst_pb_utils_add_codec_description_to_tag_list ()"><code class="function">gst_pb_utils_add_codec_description_to_tag_list()</code></a>.
295
<div class="variablelist"><table border="0" class="variablelist">
353
<a name="gst-pb-utils-get-codec-description"></a><h3>gst_pb_utils_get_codec_description ()</h3>
354
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
355
gst_pb_utils_get_codec_description (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
356
<p>Returns a localised (as far as this is possible) string describing the
357
media format specified in <em class="parameter"><code>caps</code></em>
358
, for use in error dialogs or other messages
359
to be seen by the user. Should never return NULL unless <em class="parameter"><code>caps</code></em>
361
<p>Also see the convenience function
362
<a class="link" href="gst-plugins-base-libs-gstpbutilsdescriptions.html#gst-pb-utils-add-codec-description-to-tag-list" title="gst_pb_utils_add_codec_description_to_tag_list ()"><code class="function">gst_pb_utils_add_codec_description_to_tag_list()</code></a>.</p>
363
<div class="refsect3">
364
<a name="id-1.2.13.6.7.8.6"></a><h4>Parameters</h4>
365
<div class="informaltable"><table width="100%" border="0">
297
<col align="left" valign="top">
367
<col width="150px" class="parameters_name">
368
<col class="parameters_description">
369
<col width="200px" class="parameters_annotations">
302
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
303
<td>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which an format description is needed</td>
306
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
307
<td>a newly-allocated description string, or NULL on error. Free
308
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</td>
372
<td class="parameter_name"><p>caps</p></td>
373
<td class="parameter_description"><p>the (fixed) <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> for which an format description is needed</p></td>
374
<td class="parameter_annotations"> </td>
378
<div class="refsect3">
379
<a name="id-1.2.13.6.7.8.7"></a><h4>Returns</h4>
380
<p> a newly-allocated description string, or NULL on error. Free
381
string with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when not needed any longer.</p>
386
<div class="refsect1">
387
<a name="gst-plugins-base-libs-gstpbutilsdescriptions.other_details"></a><h2>Types and Values</h2>
315
390
<div class="footer">
317
Generated by GTK-Doc V1.19</div>
392
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'
added
removed
docs/libs/html/gst-plugins-base-libs-gstpbutilsdescriptions.html
