<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GstInfo</title><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><meta xmlns="http://www.w3.org/TR/xhtml1/transitional" name="generator" content="GTK-Doc V1.0 (XML mode)"></meta><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
border: solid 1px #aaaaaa;
padding: 0.5em;
}
.programlisting {
background: #eeeeff;
border: solid 1px #aaaaff;
padding: 0.5em;
}
.variablelist {
padding: 4px;
margin-left: 3em;
}
.navigation {
background: #ffeeee;
border: solid 1px #ffaaaa;
margin-top: 0.5em;
margin-bottom: 0.5em;
}
.navigation a {
color: #770000;
}
.navigation a:visited {
color: #550000;
}
.navigation .title {
font-size: 200%;
}
</style><link rel="home" href="index.html" title="GStreamer Core Reference Manual"><link rel="up" href="gstreamer.html" title="GStreamer Core Library"><link rel="previous" href="gstreamer-GstIndexFactory.html" title="GstIndex"><link rel="next" href="gstreamer-GstObject.html" title="GstObject"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gstreamer-GstIndexFactory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="gstreamer.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">GStreamer Core Reference Manual</th><td><a accesskey="n" href="gstreamer-GstObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="gstreamer-gstinfo"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">GstInfo</span></h2><p>GstInfo — debugging subsystem</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
#define <a href="gstreamer-gstinfo.html#GST-STR-NULL-CAPS">GST_STR_NULL</a> (str)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-PAD-NAME-CAPS">GST_DEBUG_PAD_NAME</a> (pad)
#define <a href="gstreamer-gstinfo.html#GST-FUNCTION-CAPS">GST_FUNCTION</a>
enum <a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a>;
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-LEVEL-DEFAULT-CAPS">GST_DEBUG_LEVEL_DEFAULT</a>
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* <a href="gstreamer-gstinfo.html#gst-debug-level-get-name">gst_debug_level_get_name</a> (<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);
enum <a href="gstreamer-gstinfo.html#GstDebugColorFlags">GstDebugColorFlags</a>;
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* <a href="gstreamer-gstinfo.html#gst-debug-construct-term-color">gst_debug_construct_term_color</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> colorinfo);
struct <a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a>;
extern GstDebugCategory * <a href="gstreamer-gstinfo.html#GST-CAT-DEFAULT-CAPS">GST_CAT_DEFAULT</a>;
void (<a href="gstreamer-gstinfo.html#GstLogFunction">*GstLogFunction</a>) (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *message,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> data);
void <a href="gstreamer-gstinfo.html#gst-debug-log">gst_debug_log</a> (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *format,
...);
void <a href="gstreamer-gstinfo.html#gst-debug-logv">gst_debug_logv</a> (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *format,
va_list args);
void <a href="gstreamer-gstinfo.html#gst-debug-log-default">gst_debug_log_default</a> (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *message,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> unused);
void <a href="gstreamer-gstinfo.html#gst-debug-add-log-function">gst_debug_add_log_function</a> (<a href="gstreamer-gstinfo.html#GstLogFunction">GstLogFunction</a> func,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> data);
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> <a href="gstreamer-gstinfo.html#gst-debug-remove-log-function">gst_debug_remove_log_function</a> (<a href="gstreamer-gstinfo.html#GstLogFunction">GstLogFunction</a> func);
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> <a href="gstreamer-gstinfo.html#gst-debug-remove-log-function-by-data">gst_debug_remove_log_function_by_data</a>
(<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> data);
void <a href="gstreamer-gstinfo.html#gst-debug-set-active">gst_debug_set_active</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> active);
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> <a href="gstreamer-gstinfo.html#gst-debug-is-active">gst_debug_is_active</a> (void);
void <a href="gstreamer-gstinfo.html#gst-debug-set-colored">gst_debug_set_colored</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> colored);
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> <a href="gstreamer-gstinfo.html#gst-debug-is-colored">gst_debug_is_colored</a> (void);
void <a href="gstreamer-gstinfo.html#gst-debug-set-default-threshold">gst_debug_set_default_threshold</a> (<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> <a href="gstreamer-gstinfo.html#gst-debug-get-default-threshold">gst_debug_get_default_threshold</a>
(void);
void <a href="gstreamer-gstinfo.html#gst-debug-set-threshold-for-name">gst_debug_set_threshold_for_name</a>
(const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *name,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);
void <a href="gstreamer-gstinfo.html#gst-debug-unset-threshold-for-name">gst_debug_unset_threshold_for_name</a>
(const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *name);
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-CATEGORY-CAPS">GST_DEBUG_CATEGORY</a> (cat)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-CATEGORY-EXTERN-CAPS">GST_DEBUG_CATEGORY_EXTERN</a> (cat)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-CATEGORY-STATIC-CAPS">GST_DEBUG_CATEGORY_STATIC</a> (cat)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-CATEGORY-INIT-CAPS">GST_DEBUG_CATEGORY_INIT</a> (cat,name,color,description)
void <a href="gstreamer-gstinfo.html#gst-debug-category-free">gst_debug_category_free</a> (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);
void <a href="gstreamer-gstinfo.html#gst-debug-category-set-threshold">gst_debug_category_set_threshold</a>
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);
void <a href="gstreamer-gstinfo.html#gst-debug-category-reset-threshold">gst_debug_category_reset_threshold</a>
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> <a href="gstreamer-gstinfo.html#gst-debug-category-get-threshold">gst_debug_category_get_threshold</a>
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* <a href="gstreamer-gstinfo.html#gst-debug-category-get-name">gst_debug_category_get_name</a> (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> <a href="gstreamer-gstinfo.html#gst-debug-category-get-color">gst_debug_category_get_color</a> (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* <a href="gstreamer-gstinfo.html#gst-debug-category-get-description">gst_debug_category_get_description</a>
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GSList">GSList</GTKDOCLINK>* <a href="gstreamer-gstinfo.html#gst-debug-get-all-categories">gst_debug_get_all_categories</a> (void);
#define <a href="gstreamer-gstinfo.html#GST-CAT-LEVEL-LOG-CAPS">GST_CAT_LEVEL_LOG</a> (cat,level,object,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-ERROR-OBJECT-CAPS">GST_CAT_ERROR_OBJECT</a> (cat,obj,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-WARNING-OBJECT-CAPS">GST_CAT_WARNING_OBJECT</a> (cat,obj,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-INFO-OBJECT-CAPS">GST_CAT_INFO_OBJECT</a> (cat,obj,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-DEBUG-OBJECT-CAPS">GST_CAT_DEBUG_OBJECT</a> (cat,obj,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-LOG-OBJECT-CAPS">GST_CAT_LOG_OBJECT</a> (cat,obj,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-ERROR-CAPS">GST_CAT_ERROR</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-WARNING-CAPS">GST_CAT_WARNING</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-INFO-CAPS">GST_CAT_INFO</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-DEBUG-CAPS">GST_CAT_DEBUG</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-CAT-LOG-CAPS">GST_CAT_LOG</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-ERROR-OBJECT-CAPS">GST_ERROR_OBJECT</a> (obj,...)
#define <a href="gstreamer-gstinfo.html#GST-WARNING-OBJECT-CAPS">GST_WARNING_OBJECT</a> (obj,...)
#define <a href="gstreamer-gstinfo.html#GST-INFO-OBJECT-CAPS">GST_INFO_OBJECT</a> (obj,...)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-OBJECT-CAPS">GST_DEBUG_OBJECT</a> (obj,...)
#define <a href="gstreamer-gstinfo.html#GST-LOG-OBJECT-CAPS">GST_LOG_OBJECT</a> (obj,...)
#define <a href="gstreamer-gstinfo.html#GST-ERROR-CAPS">GST_ERROR</a> (...)
#define <a href="gstreamer-gstinfo.html#GST-WARNING-CAPS">GST_WARNING</a> (...)
#define <a href="gstreamer-gstinfo.html#GST-INFO-CAPS">GST_INFO</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-CAPS">GST_DEBUG</a> (cat,...)
#define <a href="gstreamer-gstinfo.html#GST-LOG-CAPS">GST_LOG</a> (...)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-FUNCPTR-CAPS">GST_DEBUG_FUNCPTR</a> (ptr)
#define <a href="gstreamer-gstinfo.html#GST-DEBUG-FUNCPTR-NAME-CAPS">GST_DEBUG_FUNCPTR_NAME</a> (ptr)
</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
This file describes the debugging subsystem. The debugging subsystem works
only after GStreamer was initilized - for example by calling <a href="gstreamer-gst.html#gst-init">gst_init</a>.
</p><p>
The debugging subsystem is used to send informational strings to the debugging
developer. Each messages has some properties attached to it. These properties
are the debugging category, the severity (called "level" here) and an obtional
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> it belongs to. Each of these messages is sent to all registered
debugging handlers, which then handle the messages. GStreamer attaches a
default handler on startup, which outputs requested messages to stderr.
</p><p>
Messages are output by using shortcut macros like <a href="gstreamer-gstinfo.html#GST-DEBUG-CAPS">GST_DEBUG</a>,
<a href="gstreamer-gstinfo.html#GST-CAT-ERROR-OBJECT-CAPS">GST_CAT_ERROR_OBJECT</a> or similar. These all expand to calling <a href="gstreamer-gstinfo.html#gst-debug-log">gst_debug_log</a>
with the right parameters.
The only thing a developer will probably want to do is define his own
categories. This is easily done with 3 lines. At the top of your code, declare
the variables and set the default category.
</p><div class="informalexample"><pre class="programlisting">
GST_DEBUG_CATEGORY (my_category); /* define category */
#define GST_CAT_DEFAULT my_category /* set as default */
</pre></div><p>
After that you only need to initialize the category.
</p><div class="informalexample"><pre class="programlisting">
GST_DEBUG_CATEGORY_INIT (my_category, "my category", 0, "This is my very own");
</pre></div><p>
Initialization must be done before the category is used first. Plugins do this
in their plugin_init function, libraries and applications should do that
during their initialization.
</p><p>
The whole debugging subsystem can be disabled at build time with passing the
--disable-gst-debug switch to configure. If this is done, every function, macro
and even structs described in this file evaluate to default values or nothing
at all. So don't take addresses of these functions or use other tricks.
If you must do that for some reason, there is still an option. If the debugging
subsystem was compiled out, <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GST-DISABLE-GST-DEBUG-CAPS">GST_DISABLE_GST_DEBUG</GTKDOCLINK> is defined in <gst/gst.h>,
so you can check that before doing your trick.
Disabling the debugging subsystem will give you a slight (read: unnoticable)
speed increase and will reduce the size of your compiled code. The GStreamer
library itself becomes around 10% smaller.
</p><p>
Please note that there are naming conventions for the names of debugging
categories. These are explained at <a href="gstreamer-gstinfo.html#GST-DEBUG-CATEGORY-INIT-CAPS">GST_DEBUG_CATEGORY_INIT</a>().
</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="GST-STR-NULL-CAPS"></a>GST_STR_NULL()</h3><pre class="programlisting">#define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
</pre><p>
Macro to use when a string must not be NULL, but may be NULL. If the string is
NULL, "(NULL)" is printed instead.
In GStreamer printf string arguments may not be NULL, because on some platforms
(ie Solaris) the libc crashes in that case. This includes debugging strings.
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i> :</span></td><td>The string to check.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>A string that is guaranteed to be not NULL.
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-PAD-NAME-CAPS"></a>GST_DEBUG_PAD_NAME()</h3><pre class="programlisting">#define GST_DEBUG_PAD_NAME(pad)</pre><p>
Evaluates to 2 strings, that describe the pad. Often used in debugging
statements.
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>pad</tt></i> :</span></td><td>The pad to debug.
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-FUNCTION-CAPS"></a>GST_FUNCTION</h3><pre class="programlisting">#define GST_FUNCTION</pre><p>
This macro should evaluate to the name of the current function and be should
be defined when configuring your project, as it is compiler dependant. If it
is not defined, some default value is used. It is used to provide debugging
output with the function name of the message.
</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GstDebugLevel"></a>enum GstDebugLevel</h3><pre class="programlisting">typedef enum {
GST_DEBUG_NONE = 0,
GST_DEBUG_ERROR,
GST_DEBUG_WARNING,
GST_DEBUG_INFO,
GST_DEBUG_DEBUG,
GST_DEBUG_LOG,
/* add more */
GST_DEBUG_LEVELS
} GstDebugLevel;
</pre><p>
The level defines the importance of a debugging message. The more important a
message is, the greater the probability that the debugging system outputs it.
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><tt class="literal">GST_DEBUG_NONE</tt></span></td><td>No debugging level specified or desired. Used to deactivate
debugging output.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_ERROR</tt></span></td><td>Error messages are to be used only when an error occured
that stops the application from keeping working correctly.
An examples is gst_element_error, which outputs a message with this priority.
It does not mean that the application is terminating as with g_errror.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_WARNING</tt></span></td><td>Warning messages are to inform about abnormal behaviour
that could lead to problems or weird behaviour later on. An example of this
would be clocking issues ("your computer is pretty slow") or broken input
data ("Can't synchronize to stream.")
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_INFO</tt></span></td><td>Informational messages should be used to keep the developer
updated about what is happening.
Examples where this should be used are when a typefind function has
successfully determined the type of the stream or when an mp3 plugin detects
the format to be used. ("This file has mono sound.")
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_DEBUG</tt></span></td><td>Debugging messages should be used when something common
happens that is not the expected default behavior.
An example would be notifications about state changes or receiving/sending of
events.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_LOG</tt></span></td><td>Log messages are messages that are very common but might be
useful to know. As a rule of thumb a pipeline that is iterating as expected
should never output anzthing else but LOG messages.
Examples for this are referencing/dereferencing of objects or cothread switches.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_LEVELS</tt></span></td><td>The number of defined debugging levels.
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-LEVEL-DEFAULT-CAPS"></a>GST_DEBUG_LEVEL_DEFAULT</h3><pre class="programlisting">#define GST_DEBUG_LEVEL_DEFAULT GST_DEBUG_ERROR
</pre><p>
Defines the default debugging level to be used with GStreamer. It is
normally set to <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GST-DEBUG-ERROR-CAPS">GST_DEBUG_ERROR</GTKDOCLINK> so only errors are printed. Developer
builds may chose to override that though.
You can use this as an argument to <a href="gstreamer-gstinfo.html#gst-debug-set-default-threshold">gst_debug_set_default_threshold</a>() to
reset the debugging output to default behaviour.
</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-level-get-name"></a>gst_debug_level_get_name ()</h3><pre class="programlisting">const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* gst_debug_level_get_name (<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);</pre><p>
Get the string trepresentation of a debugging level</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> the level to get the name for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the name
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GstDebugColorFlags"></a>enum GstDebugColorFlags</h3><pre class="programlisting">typedef enum {
/* colors */
GST_DEBUG_COLOR_BLACK = 0x0000,
GST_DEBUG_COLOR_RED = 0x0001,
GST_DEBUG_COLOR_GREEN = 0x0002,
GST_DEBUG_COLOR_YELLOW = 0x0003,
GST_DEBUG_COLOR_BLUE = 0x0004,
GST_DEBUG_COLOR_MAGENTA = 0x0005,
GST_DEBUG_COLOR_CYAN = 0x0006,
GST_DEBUG_COLOR_WHITE = 0x0007,
/* background colors */
GST_DEBUG_BACKGROUND_BLACK = 0x0000,
GST_DEBUG_BACKGROUND_RED = 0x0010,
GST_DEBUG_BACKGROUND_GREEN = 0x0020,
GST_DEBUG_BACKGROUND_YELLOW = 0x0030,
GST_DEBUG_BACKGROUND_BLUE = 0x0040,
GST_DEBUG_BACKGROUND_MAGENTA = 0x0050,
GST_DEBUG_BACKGROUND_CYAN = 0x0060,
GST_DEBUG_BACKGROUND_WHITE = 0x0070,
/* other formats */
GST_DEBUG_BOLD = 0x0100,
GST_DEBUG_UNDERLINE = 0x0200
} GstDebugColorFlags;
</pre><p>
These are some terminal-oriented flags you can use when creating your debugging
categories to make them stand out in debugging output.
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_BLACK</tt></span></td><td>Use black as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_RED</tt></span></td><td>Use red as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_GREEN</tt></span></td><td>Use green as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_YELLOW</tt></span></td><td>Use yellow as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_BLUE</tt></span></td><td>Use blue as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_MAGENTA</tt></span></td><td>Use magenta as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_CYAN</tt></span></td><td>Use cyan as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_COLOR_WHITE</tt></span></td><td>Use white as foreground color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_BLACK</tt></span></td><td>Use black as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_RED</tt></span></td><td>Use red as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_GREEN</tt></span></td><td>Use green as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_YELLOW</tt></span></td><td>Use yellow as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_BLUE</tt></span></td><td>Use blue as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_MAGENTA</tt></span></td><td>Use magenta as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_CYAN</tt></span></td><td>Use cyan as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BACKGROUND_WHITE</tt></span></td><td>Use white as background color.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_BOLD</tt></span></td><td>Make the output bold.
</td></tr><tr><td><span class="term"><tt class="literal">GST_DEBUG_UNDERLINE</tt></span></td><td>Underline the output.
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-construct-term-color"></a>gst_debug_construct_term_color ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* gst_debug_construct_term_color (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> colorinfo);</pre><p>
Constructs a string that can be used for getting the desired color in color
terminals.
You need to free the string after use.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>colorinfo</tt></i> :</span></td><td> the color info
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a string containing the color definition
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GstDebugCategory"></a>struct GstDebugCategory</h3><pre class="programlisting">struct GstDebugCategory {
};
</pre><p>
This is the struct that describes the categories. Once initialized with
<a href="gstreamer-gstinfo.html#GST-DEBUG-CATEGORY-INIT-CAPS">GST_DEBUG_CATEGORY_INIT</a>, its values can't be changed anymore.
</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-DEFAULT-CAPS"></a>GST_CAT_DEFAULT</h3><pre class="programlisting">extern GstDebugCategory * GST_CAT_DEFAULT;
</pre><p>
The default category that is used when no other category is defined as the
default. If you want to define a default category, do it like this:
</p><div class="informalexample"><pre class="programlisting">
#define GST_CAT_DEFAULT category_to_be_default
</pre></div><p>
</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GstLogFunction"></a>GstLogFunction ()</h3><pre class="programlisting">void (*GstLogFunction) (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *message,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>file</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>function</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>line</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>object</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>message</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-log"></a>gst_debug_log ()</h3><pre class="programlisting">void gst_debug_log (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *format,
...);</pre><p>
Logs the given message using the currently registered debugging handlers.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to log
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> level of the message is in
</td></tr><tr><td><span class="term"><i class="parameter"><tt>file</tt></i> :</span></td><td> the file that emitted the message, usually the __FILE__ identifier
</td></tr><tr><td><span class="term"><i class="parameter"><tt>function</tt></i> :</span></td><td> the function that emitted the message
</td></tr><tr><td><span class="term"><i class="parameter"><tt>line</tt></i> :</span></td><td> the line from that the message was emitted, usually __LINE__
</td></tr><tr><td><span class="term"><i class="parameter"><tt>object</tt></i> :</span></td><td> the object this message relates to or NULL if none
</td></tr><tr><td><span class="term"><i class="parameter"><tt>format</tt></i> :</span></td><td> a printf style format string
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td> optional arguments for the format
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-logv"></a>gst_debug_logv ()</h3><pre class="programlisting">void gst_debug_logv (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *format,
va_list args);</pre><p>
Logs the given message using the currently registered debugging handlers.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to log
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> level of the message is in
</td></tr><tr><td><span class="term"><i class="parameter"><tt>file</tt></i> :</span></td><td> the file that emitted the message, usually the __FILE__ identifier
</td></tr><tr><td><span class="term"><i class="parameter"><tt>function</tt></i> :</span></td><td> the function that emitted the message
</td></tr><tr><td><span class="term"><i class="parameter"><tt>line</tt></i> :</span></td><td> the line from that the message was emitted, usually __LINE__
</td></tr><tr><td><span class="term"><i class="parameter"><tt>object</tt></i> :</span></td><td> the object this message relates to or NULL if none
</td></tr><tr><td><span class="term"><i class="parameter"><tt>format</tt></i> :</span></td><td> a printf style format string
</td></tr><tr><td><span class="term"><i class="parameter"><tt>args</tt></i> :</span></td><td> optional arguments for the format
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-log-default"></a>gst_debug_log_default ()</h3><pre class="programlisting">void gst_debug_log_default (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *file,
const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *function,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gint">gint</GTKDOCLINK> line,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> *object,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *message,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> unused);</pre><p>
The default logging handler used by GStreamer. Logging functions get called
whenever a macro like GST_DEBUG or similar is used. This function outputs the
message and additional info using the glib error handler.
You can add other handlers by using <a href="gstreamer-gstinfo.html#gst-debug-add-log-function">gst_debug_add_log_function</a>.
And you can remove this handler by calling
gst_debug_remove_log_function (gst_debug_log_default);</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to log
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> level of the message
</td></tr><tr><td><span class="term"><i class="parameter"><tt>file</tt></i> :</span></td><td> the file that emitted the message, usually the __FILE__ identifier
</td></tr><tr><td><span class="term"><i class="parameter"><tt>function</tt></i> :</span></td><td> the function that emitted the message
</td></tr><tr><td><span class="term"><i class="parameter"><tt>line</tt></i> :</span></td><td> the line from that the message was emitted, usually __LINE__
</td></tr><tr><td><span class="term"><i class="parameter"><tt>object</tt></i> :</span></td><td> the object this message relates to or NULL if none
</td></tr><tr><td><span class="term"><i class="parameter"><tt>message</tt></i> :</span></td><td> the actual message
</td></tr><tr><td><span class="term"><i class="parameter"><tt>unused</tt></i> :</span></td><td> an unused variable, reserved for some user_data.
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-add-log-function"></a>gst_debug_add_log_function ()</h3><pre class="programlisting">void gst_debug_add_log_function (<a href="gstreamer-gstinfo.html#GstLogFunction">GstLogFunction</a> func,
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> data);</pre><p>
Adds the logging function to the list of logging functions.
Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td> the function to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> user data
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-remove-log-function"></a>gst_debug_remove_log_function ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> gst_debug_remove_log_function (<a href="gstreamer-gstinfo.html#GstLogFunction">GstLogFunction</a> func);</pre><p>
Removes all registrered instances of the given logging functions.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td> the log function to remove
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> How many instances of the function were removed
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-remove-log-function-by-data"></a>gst_debug_remove_log_function_by_data ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> gst_debug_remove_log_function_by_data
(<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gpointer">gpointer</GTKDOCLINK> data);</pre><p>
Removes all registrered instances of log functions with the given user data.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td> user data of the log function to remove
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> How many instances of the function were removed
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-set-active"></a>gst_debug_set_active ()</h3><pre class="programlisting">void gst_debug_set_active (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> active);</pre><p>
If activated, debugging messages are sent to the debugging
handlers.
It makes sense to deactivate it for speed issues.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>active</tt></i> :</span></td><td> Whether to use debugging output or not
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-is-active"></a>gst_debug_is_active ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> gst_debug_is_active (void);</pre><p>
Checks if debugging output is activated.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE, if debugging is activated
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-set-colored"></a>gst_debug_set_colored ()</h3><pre class="programlisting">void gst_debug_set_colored (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> colored);</pre><p>
Sets or unsets the use of coloured debugging output.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>colored</tt></i> :</span></td><td> Whether to use colored output or not
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-is-colored"></a>gst_debug_is_colored ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gboolean">gboolean</GTKDOCLINK> gst_debug_is_colored (void);</pre><p>
Checks if the debugging output should be colored.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE, if the debug output should be colored.
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-set-default-threshold"></a>gst_debug_set_default_threshold ()</h3><pre class="programlisting">void gst_debug_set_default_threshold (<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);</pre><p>
Sets the default threshold to the given level and updates all categories to
use this threshold.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> level to set
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-get-default-threshold"></a>gst_debug_get_default_threshold ()</h3><pre class="programlisting"><a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> gst_debug_get_default_threshold
(void);</pre><p>
Returns the default threshold that is used for new categories.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the default threshold level
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-set-threshold-for-name"></a>gst_debug_set_threshold_for_name ()</h3><pre class="programlisting">void gst_debug_set_threshold_for_name
(const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *name,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);</pre><p>
Sets all categories which match the gven glob style pattern to the given
level.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> name of the categories to set
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> level to set them to
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-unset-threshold-for-name"></a>gst_debug_unset_threshold_for_name ()</h3><pre class="programlisting">void gst_debug_unset_threshold_for_name
(const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK> *name);</pre><p>
Resets all categories with the given name back to the default level.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> name of the categories to set
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-CATEGORY-CAPS"></a>GST_DEBUG_CATEGORY()</h3><pre class="programlisting">#define GST_DEBUG_CATEGORY(cat)</pre><p>
Defines a GstCategory variable.
This macro expands to nothing if debugging is disabled.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-CATEGORY-EXTERN-CAPS"></a>GST_DEBUG_CATEGORY_EXTERN()</h3><pre class="programlisting">#define GST_DEBUG_CATEGORY_EXTERN(cat)</pre><p>
Defines an extern GstCategory variable. Use in header files.
This macro expands to nothing if debugging is disabled.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-CATEGORY-STATIC-CAPS"></a>GST_DEBUG_CATEGORY_STATIC()</h3><pre class="programlisting">#define GST_DEBUG_CATEGORY_STATIC(cat)</pre><p>
Defines a static GstCategory variable.
This macro expands to nothing if debugging is disabled.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-CATEGORY-INIT-CAPS"></a>GST_DEBUG_CATEGORY_INIT()</h3><pre class="programlisting">#define GST_DEBUG_CATEGORY_INIT(cat,name,color,description)</pre><p>
Creates a new <a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> cat with the given properties and sets it to
the default threshold.
This macro expands to nothing if debugging is disabled.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
When naming your category, please follow the following definitions to ensure
that the pattern matching for categories works as expected. It is not
earth-shattering if you don't follow these conventions, but it would be nice
for everyone.
</p><p>
If you define a category for a plugin or a feature of it, name the category
like the feature. So if you wanted to write a "filesrc" element, you would
name the category "filesink". Use lowercase letters only.
If you define more than one category for the same element, append an
underscore and an identifier to your categories, like this: "filesrc_cache"
</p><p>
If you create a library or an application using debugging categories, use a
common prefix followed by an underscore for all your categories. GStreamer
uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
to include uppercase letters.
</p></div><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> the category to initialize
</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> the name of the category
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i> :</span></td><td> the colors to use for a color representation or 0 for no color
</td></tr><tr><td><span class="term"><i class="parameter"><tt>description</tt></i> :</span></td><td> optional description of the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-free"></a>gst_debug_category_free ()</h3><pre class="programlisting">void gst_debug_category_free (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);</pre><p>
Removes and frees the category and all associated ressources.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to remove
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-set-threshold"></a>gst_debug_category_set_threshold ()</h3><pre class="programlisting">void gst_debug_category_set_threshold
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category,
<a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> level);</pre><p>
Sets the threshold of the category to the given level. Debug information will
only be output if the threshold is lower or equal to the level of the
debugging message.
Warning: It is suggested not to rely on this function in production code,
because other functions may change the threshold of categories as side
effect. It is however a good function to use when debugging (even from gdb).</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to set threshold for
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> the threshold to set
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-reset-threshold"></a>gst_debug_category_reset_threshold ()</h3><pre class="programlisting">void gst_debug_category_reset_threshold
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);</pre><p>
Resets the threshold of the category to the default level. Debug information
will only be output if the threshold is lower or equal to the level of the
debugging message.
Use this function to set the threshold back to where it was after using
<a href="gstreamer-gstinfo.html#gst-debug-category-set-threshold">gst_debug_category_set_threshold</a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to set threshold for
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-get-threshold"></a>gst_debug_category_get_threshold ()</h3><pre class="programlisting"><a href="gstreamer-gstinfo.html#GstDebugLevel">GstDebugLevel</a> gst_debug_category_get_threshold
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);</pre><p>
Returns the threshold of a <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GstCategory">GstCategory</GTKDOCLINK>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to get threshold for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the level that is used as threshold
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-get-name"></a>gst_debug_category_get_name ()</h3><pre class="programlisting">const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* gst_debug_category_get_name (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);</pre><p>
Returns the name of a <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GstCategory">GstCategory</GTKDOCLINK>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to get name for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the name of the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-get-color"></a>gst_debug_category_get_color ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="guint">guint</GTKDOCLINK> gst_debug_category_get_color (<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);</pre><p>
Returns the color of a <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GstCategory">GstCategory</GTKDOCLINK> to use when outputting this.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to get color for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the color of the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-category-get-description"></a>gst_debug_category_get_description ()</h3><pre class="programlisting">const <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gchar">gchar</GTKDOCLINK>* gst_debug_category_get_description
(<a href="gstreamer-gstinfo.html#GstDebugCategory">GstDebugCategory</a> *category);</pre><p>
Returns the description of a <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GstCategory">GstCategory</GTKDOCLINK></p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i> :</span></td><td> category to get description for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the description of the category
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="gst-debug-get-all-categories"></a>gst_debug_get_all_categories ()</h3><pre class="programlisting"><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GSList">GSList</GTKDOCLINK>* gst_debug_get_all_categories (void);</pre><p>
Returns a snapshot of a all categories that are currently in use . This list
may change anytime.
The caller has to free the list after use.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the list of categories
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-LEVEL-LOG-CAPS"></a>GST_CAT_LEVEL_LOG()</h3><pre class="programlisting">#define GST_CAT_LEVEL_LOG(cat,level,object,...)</pre><p>
Outputs a debugging message. This is the most general macro for outputting
debugging messages. You will probably want to use one of the ones described
below.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>level</tt></i> :</span></td><td> the severity of the message
</td></tr><tr><td><span class="term"><i class="parameter"><tt>object</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to or NULL if none
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-ERROR-OBJECT-CAPS"></a>GST_CAT_ERROR_OBJECT()</h3><pre class="programlisting">#define GST_CAT_ERROR_OBJECT(cat,obj,...)</pre><p>
Output an error message belonging to the given object in the given
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-WARNING-OBJECT-CAPS"></a>GST_CAT_WARNING_OBJECT()</h3><pre class="programlisting">#define GST_CAT_WARNING_OBJECT(cat,obj,...)</pre><p>
Output a warning message belonging to the given object in the given
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-INFO-OBJECT-CAPS"></a>GST_CAT_INFO_OBJECT()</h3><pre class="programlisting">#define GST_CAT_INFO_OBJECT(cat,obj,...)</pre><p>
Output an informational message belonging to the given object in the given
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-DEBUG-OBJECT-CAPS"></a>GST_CAT_DEBUG_OBJECT()</h3><pre class="programlisting">#define GST_CAT_DEBUG_OBJECT(cat,obj,...)</pre><p>
Output a debugging message belonging to the given object in the given
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-LOG-OBJECT-CAPS"></a>GST_CAT_LOG_OBJECT()</h3><pre class="programlisting">#define GST_CAT_LOG_OBJECT(cat,obj,...)</pre><p>
Output a logging message belonging to the given object in the given
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-ERROR-CAPS"></a>GST_CAT_ERROR()</h3><pre class="programlisting">#define GST_CAT_ERROR(cat,...)</pre><p>
Output an error message in the given category</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-WARNING-CAPS"></a>GST_CAT_WARNING()</h3><pre class="programlisting">#define GST_CAT_WARNING(cat,...)</pre><p>
Output a warning message in the given category</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-INFO-CAPS"></a>GST_CAT_INFO()</h3><pre class="programlisting">#define GST_CAT_INFO(cat,...)</pre><p>
Output an informational message in the given category</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-DEBUG-CAPS"></a>GST_CAT_DEBUG()</h3><pre class="programlisting">#define GST_CAT_DEBUG(cat,...)</pre><p>
Output an debugging message in the given category</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-CAT-LOG-CAPS"></a>GST_CAT_LOG()</h3><pre class="programlisting">#define GST_CAT_LOG(cat,...)</pre><p>
Output a logging message in the given category</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td> category to use
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-ERROR-OBJECT-CAPS"></a>GST_ERROR_OBJECT()</h3><pre class="programlisting">#define GST_ERROR_OBJECT(obj,...)</pre><p>
Output an error message belonging to the given object in the default
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-WARNING-OBJECT-CAPS"></a>GST_WARNING_OBJECT()</h3><pre class="programlisting">#define GST_WARNING_OBJECT(obj,...)</pre><p>
Output a warning message belonging to the given object in the default
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-INFO-OBJECT-CAPS"></a>GST_INFO_OBJECT()</h3><pre class="programlisting">#define GST_INFO_OBJECT(obj,...)</pre><p>
Output an informational message belonging to the given object in the default
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-OBJECT-CAPS"></a>GST_DEBUG_OBJECT()</h3><pre class="programlisting">#define GST_DEBUG_OBJECT(obj,...)</pre><p>
Output a debugging message belonging to the given object in the default
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-LOG-OBJECT-CAPS"></a>GST_LOG_OBJECT()</h3><pre class="programlisting">#define GST_LOG_OBJECT(obj,...)</pre><p>
Output a logging message belonging to the given object in the default
category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>obj</tt></i> :</span></td><td> the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="GObject">GObject</GTKDOCLINK> the message belongs to
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-ERROR-CAPS"></a>GST_ERROR()</h3><pre class="programlisting">#define GST_ERROR(...)</pre><p>
Output an error message in the default category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-WARNING-CAPS"></a>GST_WARNING()</h3><pre class="programlisting">#define GST_WARNING(...)</pre><p>
Output a warning message in the default category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-INFO-CAPS"></a>GST_INFO()</h3><pre class="programlisting">#define GST_INFO(cat,...)</pre><p>
Output an informational message in the default category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-CAPS"></a>GST_DEBUG()</h3><pre class="programlisting">#define GST_DEBUG(cat,...)</pre><p>
Output a debugging message in the default category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>cat</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-LOG-CAPS"></a>GST_LOG()</h3><pre class="programlisting">#define GST_LOG(...)</pre><p>
Output a logging message in the default category.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>...</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-FUNCPTR-CAPS"></a>GST_DEBUG_FUNCPTR()</h3><pre class="programlisting">#define GST_DEBUG_FUNCPTR(ptr)</pre><p>
Register a pointer to a function with its name, so it can later be used by
<a href="gstreamer-gstinfo.html#GST-DEBUG-FUNCPTR-NAME-CAPS">GST_DEBUG_FUNCPTR_NAME</a>().</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ptr</tt></i> :</span></td><td> The function to register
</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="GST-DEBUG-FUNCPTR-NAME-CAPS"></a>GST_DEBUG_FUNCPTR_NAME()</h3><pre class="programlisting">#define GST_DEBUG_FUNCPTR_NAME(ptr)</pre><p>
Retrieves the name of the function, if it was previously registered with
<a href="gstreamer-gstinfo.html#GST-DEBUG-FUNCPTR-CAPS">GST_DEBUG_FUNCPTR</a>(). If not, it returns a description of the pointer.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Make sure you free the string after use.
</p></div><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ptr</tt></i> :</span></td><td> pointer to the function
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><h2>See Also</h2><p>
<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="gstreamer-gstconfig">configuration</GTKDOCLINK>,
<a href="gstreamer-gst.html" title="Gstreamer">initialization</a> for command line parameters
and environment variables that affect the debugging output.
</p></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gstreamer-GstIndexFactory.html"><b><< GstIndex</b></a></td><td align="right"><a accesskey="n" href="gstreamer-GstObject.html"><b>GstObject >></b></a></td></tr></table></body></html>