|
Packit |
971217 |
|
|
Packit |
971217 |
<html>
|
|
Packit |
971217 |
<head>
|
|
Packit |
971217 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
971217 |
<title>Descriptions: GStreamer Base Plugins 1.0 Library Reference Manual</title>
|
|
Packit |
971217 |
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
Packit |
971217 |
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
|
|
Packit |
971217 |
<link rel="up" href="gstreamer-base-utils.html" title="Base Utils Library">
|
|
Packit |
971217 |
<link rel="prev" href="gst-plugins-base-libs-Codec-utilities.html" title="Codec utilities">
|
|
Packit |
971217 |
<link rel="next" href="gst-plugins-base-libs-Missing-plugins.html" title="Missing plugins">
|
|
Packit |
971217 |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
971217 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
971217 |
</head>
|
|
Packit |
971217 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Top |
|
|
Packit |
971217 |
Description
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Descriptions
|
|
Packit |
971217 |
Descriptions — Provides human-readable descriptions for caps/codecs
|
|
Packit |
971217 |
and encoder, decoder, URI source and URI sink elements
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Functions
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_source_description ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_sink_description ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_decoder_description ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_encoder_description ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_element_description ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_add_codec_description_to_tag_list ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_codec_description ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Includes
|
|
Packit |
971217 |
#include <gst/pbutils/descriptions.h>
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Description
|
|
Packit |
971217 |
The above functions provide human-readable strings for media formats
|
|
Packit |
971217 |
and decoder/demuxer/depayloader/encoder/muxer/payloader elements for use
|
|
Packit |
971217 |
in error dialogs or other messages shown to users.
|
|
Packit |
971217 |
gst_pb_utils_add_codec_description_to_tag_list() is a utility function
|
|
Packit |
971217 |
for demuxer and decoder elements to add audio/video codec tags from a
|
|
Packit |
971217 |
given (fixed) GstCaps.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Functions
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_source_description ()
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
gst_pb_utils_get_source_description (const gchar *protocol);
|
|
Packit |
971217 |
Returns a localised string describing a source element handling the protocol
|
|
Packit |
971217 |
specified in protocol
|
|
Packit |
971217 |
, for use in error dialogs or other messages to be
|
|
Packit |
971217 |
seen by the user. Should never return NULL unless protocol
|
|
Packit |
971217 |
is invalid.
|
|
Packit |
971217 |
This function is mainly for internal use, applications would typically
|
|
Packit |
971217 |
use gst_missing_plugin_message_get_description() to get a description of
|
|
Packit |
971217 |
a missing feature from a missing-plugin message.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
protocol
|
|
Packit |
971217 |
the protocol the source element needs to handle, e.g. "http"
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a newly-allocated description string, or NULL on error. Free
|
|
Packit |
971217 |
string with g_free() when not needed any longer.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_sink_description ()
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
gst_pb_utils_get_sink_description (const gchar *protocol);
|
|
Packit |
971217 |
Returns a localised string describing a sink element handling the protocol
|
|
Packit |
971217 |
specified in protocol
|
|
Packit |
971217 |
, for use in error dialogs or other messages to be
|
|
Packit |
971217 |
seen by the user. Should never return NULL unless protocol
|
|
Packit |
971217 |
is invalid.
|
|
Packit |
971217 |
This function is mainly for internal use, applications would typically
|
|
Packit |
971217 |
use gst_missing_plugin_message_get_description() to get a description of
|
|
Packit |
971217 |
a missing feature from a missing-plugin message.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
protocol
|
|
Packit |
971217 |
the protocol the sink element needs to handle, e.g. "http"
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a newly-allocated description string, or NULL on error. Free
|
|
Packit |
971217 |
string with g_free() when not needed any longer.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_decoder_description ()
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
gst_pb_utils_get_decoder_description (const GstCaps *caps);
|
|
Packit |
971217 |
Returns a localised string describing an decoder for the format specified
|
|
Packit |
971217 |
in caps
|
|
Packit |
971217 |
, for use in error dialogs or other messages to be seen by the user.
|
|
Packit |
971217 |
Should never return NULL unless factory_name
|
|
Packit |
971217 |
or caps
|
|
Packit |
971217 |
are invalid.
|
|
Packit |
971217 |
This function is mainly for internal use, applications would typically
|
|
Packit |
971217 |
use gst_missing_plugin_message_get_description() to get a description of
|
|
Packit |
971217 |
a missing feature from a missing-plugin message.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
caps
|
|
Packit |
971217 |
the (fixed) GstCaps for which an decoder description is needed
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a newly-allocated description string, or NULL on error. Free
|
|
Packit |
971217 |
string with g_free() when not needed any longer.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_encoder_description ()
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
gst_pb_utils_get_encoder_description (const GstCaps *caps);
|
|
Packit |
971217 |
Returns a localised string describing an encoder for the format specified
|
|
Packit |
971217 |
in caps
|
|
Packit |
971217 |
, for use in error dialogs or other messages to be seen by the user.
|
|
Packit |
971217 |
Should never return NULL unless factory_name
|
|
Packit |
971217 |
or caps
|
|
Packit |
971217 |
are invalid.
|
|
Packit |
971217 |
This function is mainly for internal use, applications would typically
|
|
Packit |
971217 |
use gst_missing_plugin_message_get_description() to get a description of
|
|
Packit |
971217 |
a missing feature from a missing-plugin message.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
caps
|
|
Packit |
971217 |
the (fixed) GstCaps for which an encoder description is needed
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a newly-allocated description string, or NULL on error. Free
|
|
Packit |
971217 |
string with g_free() when not needed any longer.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_element_description ()
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
gst_pb_utils_get_element_description (const gchar *factory_name);
|
|
Packit |
971217 |
Returns a localised string describing the given element, for use in
|
|
Packit |
971217 |
error dialogs or other messages to be seen by the user. Should never
|
|
Packit |
971217 |
return NULL unless factory_name
|
|
Packit |
971217 |
is invalid.
|
|
Packit |
971217 |
This function is mainly for internal use, applications would typically
|
|
Packit |
971217 |
use gst_missing_plugin_message_get_description() to get a description of
|
|
Packit |
971217 |
a missing feature from a missing-plugin message.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
factory_name
|
|
Packit |
971217 |
the name of the element, e.g. "giosrc"
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a newly-allocated description string, or NULL on error. Free
|
|
Packit |
971217 |
string with g_free() when not needed any longer.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_add_codec_description_to_tag_list ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_pb_utils_add_codec_description_to_tag_list
|
|
Packit |
971217 |
(GstTagList *taglist,
|
|
Packit |
971217 |
const gchar *codec_tag,
|
|
Packit |
971217 |
const GstCaps *caps);
|
|
Packit |
971217 |
Adds a codec tag describing the format specified by caps
|
|
Packit |
971217 |
to taglist
|
|
Packit |
971217 |
.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
taglist
|
|
Packit |
971217 |
a GstTagList
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
codec_tag
|
|
Packit |
971217 |
a GStreamer codec tag such as GST_TAG_AUDIO_CODEC,
|
|
Packit |
971217 |
GST_TAG_VIDEO_CODEC or GST_TAG_CODEC. If none is specified,
|
|
Packit |
971217 |
the function will attempt to detect the appropriate category.
|
|
Packit |
971217 |
[allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
caps
|
|
Packit |
971217 |
the (fixed) GstCaps for which a codec tag should be added.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE if a codec tag was added, FALSE otherwise.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_pb_utils_get_codec_description ()
|
|
Packit |
971217 |
gchar *
|
|
Packit |
971217 |
gst_pb_utils_get_codec_description (const GstCaps *caps);
|
|
Packit |
971217 |
Returns a localised (as far as this is possible) string describing the
|
|
Packit |
971217 |
media format specified in caps
|
|
Packit |
971217 |
, for use in error dialogs or other messages
|
|
Packit |
971217 |
to be seen by the user. Should never return NULL unless caps
|
|
Packit |
971217 |
is invalid.
|
|
Packit |
971217 |
Also see the convenience function
|
|
Packit |
971217 |
gst_pb_utils_add_codec_description_to_tag_list().
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
caps
|
|
Packit |
971217 |
the (fixed) GstCaps for which an format description is needed
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a newly-allocated description string, or NULL on error. Free
|
|
Packit |
971217 |
string with g_free() when not needed any longer.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Types and Values
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Generated by GTK-Doc V1.27
|
|
Packit |
971217 |
</body>
|
|
Packit |
971217 |
</html>
|