mobile/docs/gst/html/gstreamer-GstInfo.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GstInfo</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Core Reference Manual">
   8 <link rel="up" href="gstreamer-support.html" title="GStreamer Core Support">
   9 <link rel="prev" href="gstreamer-support.html" title="GStreamer Core Support">
  10 <link rel="next" href="gstreamer-GstTrace.html" title="GstTrace">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gstreamer-support.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-support.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer 0.10 Core Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-GstTrace.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gstreamer-GstInfo.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-GstInfo.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gstreamer-GstInfo"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gstreamer-GstInfo.top_of_page"></a>GstInfo</span></h2>
  34 <p>GstInfo — Debugging and logging facilities</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gstreamer-GstInfo.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/gst.h&gt;
  42
  43 enum                <a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel">GstDebugLevel</a>;
  44 #define             <a class="link" href="gstreamer-GstInfo.html#GST-LEVEL-DEFAULT:CAPS" title="GST_LEVEL_DEFAULT">GST_LEVEL_DEFAULT</a>
  45 enum                <a class="link" href="gstreamer-GstInfo.html#GstDebugColorFlags" title="enum GstDebugColorFlags">GstDebugColorFlags</a>;
  46 struct              <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory">GstDebugCategory</a>;
  47 enum                <a class="link" href="gstreamer-GstInfo.html#GstDebugGraphDetails" title="enum GstDebugGraphDetails">GstDebugGraphDetails</a>;
  48 #define             <a class="link" href="gstreamer-GstInfo.html#GST-STR-NULL:CAPS" title="GST_STR_NULL()">GST_STR_NULL</a>                        (str)
  49 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-PAD-NAME:CAPS" title="GST_DEBUG_PAD_NAME()">GST_DEBUG_PAD_NAME</a>                  (pad)
  50 #define             <a class="link" href="gstreamer-GstInfo.html#GST-FUNCTION:CAPS" title="GST_FUNCTION">GST_FUNCTION</a>
  51 <span class="returnvalue">void</span>                (<a class="link" href="gstreamer-GstInfo.html#GstLogFunction" title="GstLogFunction ()">*GstLogFunction</a>)                   (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
  52                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
  53                                                          <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> *file</code></em>,
  54                                                          <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> *function</code></em>,
  55                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
  56                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  57                                                          <em class="parameter"><code><span class="type">GstDebugMessage</span> *message</code></em>,
  58                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-log" title="gst_debug_log ()">gst_debug_log</a>                       (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
  60                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
  61                                                          <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> *file</code></em>,
  62                                                          <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> *function</code></em>,
  63                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
  64                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  65                                                          <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> *format</code></em>,
  66                                                          <em class="parameter"><code>...</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-log-valist" title="gst_debug_log_valist ()">gst_debug_log_valist</a>                (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
  68                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
  69                                                          <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> *file</code></em>,
  70                                                          <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> *function</code></em>,
  71                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
  72                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  73                                                          <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> *format</code></em>,
  74                                                          <em class="parameter"><code><span class="type">va_list</span> args</code></em>);
  75 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gstreamer-GstInfo.html#gst-debug-message-get" title="gst_debug_message_get ()">gst_debug_message_get</a>               (<em class="parameter"><code><span class="type">GstDebugMessage</span> *message</code></em>);
  76 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-log-default" title="gst_debug_log_default ()">gst_debug_log_default</a>               (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
  77                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
  78                                                          <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> *file</code></em>,
  79                                                          <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> *function</code></em>,
  80                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
  81                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
  82                                                          <em class="parameter"><code><span class="type">GstDebugMessage</span> *message</code></em>,
  83                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> unused</code></em>);
  84 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gstreamer-GstInfo.html#gst-debug-level-get-name" title="gst_debug_level_get_name ()">gst_debug_level_get_name</a>            (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);
  85 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-add-log-function" title="gst_debug_add_log_function ()">gst_debug_add_log_function</a>          (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstLogFunction" title="GstLogFunction ()"><span class="type">GstLogFunction</span></a> func</code></em>,
  86                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
  87 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gstreamer-GstInfo.html#gst-debug-remove-log-function" title="gst_debug_remove_log_function ()">gst_debug_remove_log_function</a>       (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstLogFunction" title="GstLogFunction ()"><span class="type">GstLogFunction</span></a> func</code></em>);
  88 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gstreamer-GstInfo.html#gst-debug-remove-log-function-by-data" title="gst_debug_remove_log_function_by_data ()">gst_debug_remove_log_function_by_data</a>
  89                                                         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
  90 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-set-active" title="gst_debug_set_active ()">gst_debug_set_active</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> active</code></em>);
  91 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gstreamer-GstInfo.html#gst-debug-is-active" title="gst_debug_is_active ()">gst_debug_is_active</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
  92 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-set-colored" title="gst_debug_set_colored ()">gst_debug_set_colored</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> colored</code></em>);
  93 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gstreamer-GstInfo.html#gst-debug-is-colored" title="gst_debug_is_colored ()">gst_debug_is_colored</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
  94 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-set-default-threshold" title="gst_debug_set_default_threshold ()">gst_debug_set_default_threshold</a>     (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);
  95 <a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="returnvalue">GstDebugLevel</span></a>       <a class="link" href="gstreamer-GstInfo.html#gst-debug-get-default-threshold" title="gst_debug_get_default_threshold ()">gst_debug_get_default_threshold</a>     (<em class="parameter"><code><span class="type">void</span></code></em>);
  96 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-set-threshold-for-name" title="gst_debug_set_threshold_for_name ()">gst_debug_set_threshold_for_name</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> *name</code></em>,
  97                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);
  98 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-unset-threshold-for-name" title="gst_debug_unset_threshold_for_name ()">gst_debug_unset_threshold_for_name</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> *name</code></em>);
  99 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY:CAPS" title="GST_DEBUG_CATEGORY()">GST_DEBUG_CATEGORY</a>                  (cat)
 100 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-EXTERN:CAPS" title="GST_DEBUG_CATEGORY_EXTERN()">GST_DEBUG_CATEGORY_EXTERN</a>           (cat)
 101 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-STATIC:CAPS" title="GST_DEBUG_CATEGORY_STATIC()">GST_DEBUG_CATEGORY_STATIC</a>           (cat)
 102 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-INIT:CAPS" title="GST_DEBUG_CATEGORY_INIT()">GST_DEBUG_CATEGORY_INIT</a>             (cat,
 103                                                          name,
 104                                                          color,
 105                                                          description)
 106 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-GET:CAPS" title="GST_DEBUG_CATEGORY_GET()">GST_DEBUG_CATEGORY_GET</a>              (cat,
 107                                                          name)
 108 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-free" title="gst_debug_category_free ()">gst_debug_category_free</a>             (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);
 109 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-set-threshold" title="gst_debug_category_set_threshold ()">gst_debug_category_set_threshold</a>    (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
 110                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);
 111 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-reset-threshold" title="gst_debug_category_reset_threshold ()">gst_debug_category_reset_threshold</a>  (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);
 112 <a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="returnvalue">GstDebugLevel</span></a>       <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-get-threshold" title="gst_debug_category_get_threshold ()">gst_debug_category_get_threshold</a>    (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);
 113 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-get-name" title="gst_debug_category_get_name ()">gst_debug_category_get_name</a>         (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);
 114 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-get-color" title="gst_debug_category_get_color ()">gst_debug_category_get_color</a>        (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);
 115 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-get-description" title="gst_debug_category_get_description ()">gst_debug_category_get_description</a>  (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);
 116 <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="gstreamer-GstInfo.html#gst-debug-get-all-categories" title="gst_debug_get_all_categories ()">gst_debug_get_all_categories</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
 117 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gstreamer-GstInfo.html#gst-debug-construct-term-color" title="gst_debug_construct_term_color ()">gst_debug_construct_term_color</a>      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> colorinfo</code></em>);
 118 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-construct-win-color" title="gst_debug_construct_win_color ()">gst_debug_construct_win_color</a>       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> colorinfo</code></em>);
 119 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-LEVEL-LOG:CAPS" title="GST_CAT_LEVEL_LOG()">GST_CAT_LEVEL_LOG</a>                   (cat,
 120                                                          level,
 121                                                          object,
 122                                                          ...)
 123 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-ERROR-OBJECT:CAPS" title="GST_CAT_ERROR_OBJECT()">GST_CAT_ERROR_OBJECT</a>                (cat,
 124                                                          obj,
 125                                                          ...)
 126 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-WARNING-OBJECT:CAPS" title="GST_CAT_WARNING_OBJECT()">GST_CAT_WARNING_OBJECT</a>              (cat,
 127                                                          obj,
 128                                                          ...)
 129 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-INFO-OBJECT:CAPS" title="GST_CAT_INFO_OBJECT()">GST_CAT_INFO_OBJECT</a>                 (cat,
 130                                                          obj,
 131                                                          ...)
 132 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-DEBUG-OBJECT:CAPS" title="GST_CAT_DEBUG_OBJECT()">GST_CAT_DEBUG_OBJECT</a>                (cat,
 133                                                          obj,
 134                                                          ...)
 135 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-LOG-OBJECT:CAPS" title="GST_CAT_LOG_OBJECT()">GST_CAT_LOG_OBJECT</a>                  (cat,
 136                                                          obj,
 137                                                          ...)
 138 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-FIXME-OBJECT:CAPS" title="GST_CAT_FIXME_OBJECT()">GST_CAT_FIXME_OBJECT</a>                (cat,
 139                                                          obj,
 140                                                          ...)
 141 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-TRACE-OBJECT:CAPS" title="GST_CAT_TRACE_OBJECT()">GST_CAT_TRACE_OBJECT</a>                (cat,
 142                                                          obj,
 143                                                          ...)
 144 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-MEMDUMP-OBJECT:CAPS" title="GST_CAT_MEMDUMP_OBJECT()">GST_CAT_MEMDUMP_OBJECT</a>              (cat,
 145                                                          obj,
 146                                                          msg,
 147                                                          data,
 148                                                          length)
 149 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-ERROR:CAPS" title="GST_CAT_ERROR()">GST_CAT_ERROR</a>                       (cat,
 150                                                          ...)
 151 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-WARNING:CAPS" title="GST_CAT_WARNING()">GST_CAT_WARNING</a>                     (cat,
 152                                                          ...)
 153 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-INFO:CAPS" title="GST_CAT_INFO()">GST_CAT_INFO</a>                        (cat,
 154                                                          ...)
 155 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-DEBUG:CAPS" title="GST_CAT_DEBUG()">GST_CAT_DEBUG</a>                       (cat,
 156                                                          ...)
 157 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-LOG:CAPS" title="GST_CAT_LOG()">GST_CAT_LOG</a>                         (cat,
 158                                                          ...)
 159 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-FIXME:CAPS" title="GST_CAT_FIXME()">GST_CAT_FIXME</a>                       (cat,
 160                                                          ...)
 161 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-TRACE:CAPS" title="GST_CAT_TRACE()">GST_CAT_TRACE</a>                       (cat,
 162                                                          ...)
 163 #define             <a class="link" href="gstreamer-GstInfo.html#GST-CAT-MEMDUMP:CAPS" title="GST_CAT_MEMDUMP()">GST_CAT_MEMDUMP</a>                     (cat,
 164                                                          msg,
 165                                                          data,
 166                                                          length)
 167 #define             <a class="link" href="gstreamer-GstInfo.html#GST-ERROR-OBJECT:CAPS" title="GST_ERROR_OBJECT()">GST_ERROR_OBJECT</a>                    (obj,
 168                                                          ...)
 169 #define             <a class="link" href="gstreamer-GstInfo.html#GST-WARNING-OBJECT:CAPS" title="GST_WARNING_OBJECT()">GST_WARNING_OBJECT</a>                  (obj,
 170                                                          ...)
 171 #define             <a class="link" href="gstreamer-GstInfo.html#GST-INFO-OBJECT:CAPS" title="GST_INFO_OBJECT()">GST_INFO_OBJECT</a>                     (obj,
 172                                                          ...)
 173 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-OBJECT:CAPS" title="GST_DEBUG_OBJECT()">GST_DEBUG_OBJECT</a>                    (obj,
 174                                                          ...)
 175 #define             <a class="link" href="gstreamer-GstInfo.html#GST-LOG-OBJECT:CAPS" title="GST_LOG_OBJECT()">GST_LOG_OBJECT</a>                      (obj,
 176                                                          ...)
 177 #define             <a class="link" href="gstreamer-GstInfo.html#GST-FIXME-OBJECT:CAPS" title="GST_FIXME_OBJECT()">GST_FIXME_OBJECT</a>                    (obj,
 178                                                          ...)
 179 #define             <a class="link" href="gstreamer-GstInfo.html#GST-TRACE-OBJECT:CAPS" title="GST_TRACE_OBJECT()">GST_TRACE_OBJECT</a>                    (obj,
 180                                                          ...)
 181 #define             <a class="link" href="gstreamer-GstInfo.html#GST-MEMDUMP-OBJECT:CAPS" title="GST_MEMDUMP_OBJECT()">GST_MEMDUMP_OBJECT</a>                  (obj,
 182                                                          msg,
 183                                                          data,
 184                                                          length)
 185 #define             <a class="link" href="gstreamer-GstInfo.html#GST-ERROR:CAPS" title="GST_ERROR()">GST_ERROR</a>                           (...)
 186 #define             <a class="link" href="gstreamer-GstInfo.html#GST-WARNING:CAPS" title="GST_WARNING()">GST_WARNING</a>                         (...)
 187 #define             <a class="link" href="gstreamer-GstInfo.html#GST-INFO:CAPS" title="GST_INFO()">GST_INFO</a>                            (...)
 188 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG:CAPS" title="GST_DEBUG()">GST_DEBUG</a>                           (...)
 189 #define             <a class="link" href="gstreamer-GstInfo.html#GST-LOG:CAPS" title="GST_LOG()">GST_LOG</a>                             (...)
 190 #define             <a class="link" href="gstreamer-GstInfo.html#GST-FIXME:CAPS" title="GST_FIXME()">GST_FIXME</a>                           (...)
 191 #define             <a class="link" href="gstreamer-GstInfo.html#GST-TRACE:CAPS" title="GST_TRACE()">GST_TRACE</a>                           (...)
 192 #define             <a class="link" href="gstreamer-GstInfo.html#GST-MEMDUMP:CAPS" title="GST_MEMDUMP()">GST_MEMDUMP</a>                         (msg,
 193                                                          data,
 194                                                          length)
 195 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-REGISTER-FUNCPTR:CAPS" title="GST_DEBUG_REGISTER_FUNCPTR()">GST_DEBUG_REGISTER_FUNCPTR</a>          (ptr)
 196 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-FUNCPTR:CAPS" title="GST_DEBUG_FUNCPTR()">GST_DEBUG_FUNCPTR</a>                   (ptr)
 197 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-FUNCPTR-NAME:CAPS" title="GST_DEBUG_FUNCPTR_NAME()">GST_DEBUG_FUNCPTR_NAME</a>              (ptr)
 198 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-BIN-TO-DOT-FILE:CAPS" title="GST_DEBUG_BIN_TO_DOT_FILE()">GST_DEBUG_BIN_TO_DOT_FILE</a>           (bin,
 199                                                          details,
 200                                                          file_name)
 201 #define             <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-BIN-TO-DOT-FILE-WITH-TS:CAPS" title="GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS()">GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS</a>   (bin,
 202                                                          details,
 203                                                          file_name)
 204 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-GstInfo.html#gst-debug-print-stack-trace" title="gst_debug_print_stack_trace ()">gst_debug_print_stack_trace</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
 205 #define             <a class="link" href="gstreamer-GstInfo.html#GST-TIME-FORMAT:CAPS" title="GST_TIME_FORMAT">GST_TIME_FORMAT</a>
 206 #define             <a class="link" href="gstreamer-GstInfo.html#GST-TIME-ARGS:CAPS" title="GST_TIME_ARGS()">GST_TIME_ARGS</a>                       (t)
 207 </pre>
 208 </div>
 209 <div class="refsect1">
 210 <a name="gstreamer-GstInfo.description"></a><h2>Description</h2>
 211 <p>
 212 GStreamer's debugging subsystem is an easy way to get information about what
 213 the application is doing.  It is not meant for programming errors. Use GLib
 214 methods (g_warning and friends) for that.
 215 </p>
 216 <p>
 217 The debugging subsystem works only after GStreamer has been initialized
 218 </p>
 219 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>for example by calling <a class="link" href="gstreamer-Gst.html#gst-init" title="gst_init ()"><code class="function">gst_init()</code></a>.</p></li></ul></div>
 220 <p>
 221 </p>
 222 <p>
 223 The debugging subsystem is used to log informational messages while the
 224 application runs.  Each messages has some properties attached to it. Among
 225 these properties are the debugging category, the severity (called "level"
 226 here) and an optional <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> it belongs to. Each of these messages is sent
 227 to all registered debugging handlers, which then handle the messages.
 228 GStreamer attaches a default handler on startup, which outputs requested
 229 messages to stderr.
 230 </p>
 231 <p>
 232 Messages are output by using shortcut macros like <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG:CAPS" title="GST_DEBUG()"><span class="type">GST_DEBUG</span></a>,
 233 <a class="link" href="gstreamer-GstInfo.html#GST-CAT-ERROR-OBJECT:CAPS" title="GST_CAT_ERROR_OBJECT()"><span class="type">GST_CAT_ERROR_OBJECT</span></a> or similar. These all expand to calling <a class="link" href="gstreamer-GstInfo.html#gst-debug-log" title="gst_debug_log ()"><code class="function">gst_debug_log()</code></a>
 234 with the right parameters.
 235 The only thing a developer will probably want to do is define his own
 236 categories. This is easily done with 3 lines. At the top of your code,
 237 declare
 238 the variables and set the default category.
 239 </p>
 240 <div class="informalexample">
 241   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 242     <tbody>
 243       <tr>
 244         <td class="listing_lines" align="right"><pre>1
 245 2</pre></td>
 246         <td class="listing_code"><pre class="programlisting"><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-STATIC:CAPS">GST_DEBUG_CATEGORY_STATIC</a></span> <span class="gtkdoc opt">(</span>my_category<span class="gtkdoc opt">);</span>     <span class="gtkdoc slc">// define category (statically)</span>
 247 <span class="gtkdoc ppc">#define GST_CAT_DEFAULT my_category</span>     <span class="gtkdoc slc">// set as default</span><span class="gtkdoc ppc"></span></pre></td>
 248       </tr>
 249     </tbody>
 250   </table>
 251 </div>
 252
 253 <p>
 254 After that you only need to initialize the category.
 255 </p>
 256 <div class="informalexample">
 257   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 258     <tbody>
 259       <tr>
 260         <td class="listing_lines" align="right"><pre>1
 261 2</pre></td>
 262         <td class="listing_code"><pre class="programlisting"><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-INIT:CAPS">GST_DEBUG_CATEGORY_INIT</a></span> <span class="gtkdoc opt">(</span>my_category<span class="gtkdoc opt">,</span> <span class="string">&quot;my category&quot;</span><span class="gtkdoc opt">,</span>
 263                          <span class="number">0</span><span class="gtkdoc opt">,</span> <span class="string">&quot;This is my very own&quot;</span><span class="gtkdoc opt">);</span></pre></td>
 264       </tr>
 265     </tbody>
 266   </table>
 267 </div>
 268
 269 <p>
 270 Initialization must be done before the category is used first.
 271 Plugins do this
 272 in their plugin_init function, libraries and applications should do that
 273 during their initialization.
 274 </p>
 275 <p>
 276 The whole debugging subsystem can be disabled at build time with passing the
 277 --disable-gst-debug switch to configure. If this is done, every function,
 278 macro and even structs described in this file evaluate to default values or
 279 nothing at all.
 280 So don't take addresses of these functions or use other tricks.
 281 If you must do that for some reason, there is still an option.
 282 If the debugging
 283 subsystem was compiled out, <a class="link" href="gstreamer-gstconfig.html#GST-DISABLE-GST-DEBUG:CAPS" title="GST_DISABLE_GST_DEBUG"><span class="type">GST_DISABLE_GST_DEBUG</span></a> is defined in
 284 &lt;gst/gst.h&gt;,
 285 so you can check that before doing your trick.
 286 Disabling the debugging subsystem will give you a slight (read: unnoticeable)
 287 speed increase and will reduce the size of your compiled code. The GStreamer
 288 library itself becomes around 10% smaller.
 289 </p>
 290 <p>
 291 Please note that there are naming conventions for the names of debugging
 292 categories. These are explained at <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-INIT:CAPS" title="GST_DEBUG_CATEGORY_INIT()"><code class="function">GST_DEBUG_CATEGORY_INIT()</code></a>.
 293 </p>
 294 </div>
 295 <div class="refsect1">
 296 <a name="gstreamer-GstInfo.details"></a><h2>Details</h2>
 297 <div class="refsect2">
 298 <a name="GstDebugLevel"></a><h3>enum GstDebugLevel</h3>
 299 <pre class="programlisting">typedef enum {
 300   GST_LEVEL_NONE = 0,
 301   GST_LEVEL_ERROR,
 302   GST_LEVEL_WARNING,
 303   GST_LEVEL_INFO,
 304   GST_LEVEL_DEBUG,
 305   GST_LEVEL_LOG,
 306   GST_LEVEL_FIXME = 6,
 307   GST_LEVEL_TRACE = 7,
 308   /* add more */
 309   GST_LEVEL_MEMDUMP = 9,
 310   /* add more */
 311   GST_LEVEL_COUNT
 312 } GstDebugLevel;
 313 </pre>
 314 <p>
 315 The level defines the importance of a debugging message. The more important a
 316 message is, the greater the probability that the debugging system outputs it.
 317 </p>
 318 <div class="variablelist"><table border="0">
 319 <col align="left" valign="top">
 320 <tbody>
 321 <tr>
 322 <td><p><a name="GST-LEVEL-NONE:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_NONE</code></span></p></td>
 323 <td>No debugging level specified or desired. Used to deactivate
 324  debugging output.
 325 </td>
 326 </tr>
 327 <tr>
 328 <td><p><a name="GST-LEVEL-ERROR:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_ERROR</code></span></p></td>
 329 <td>Error messages are to be used only when an error occured
 330  that stops the application from keeping working correctly.
 331  An examples is gst_element_error, which outputs a message with this priority.
 332  It does not mean that the application is terminating as with g_errror.
 333 </td>
 334 </tr>
 335 <tr>
 336 <td><p><a name="GST-LEVEL-WARNING:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_WARNING</code></span></p></td>
 337 <td>Warning messages are to inform about abnormal behaviour
 338  that could lead to problems or weird behaviour later on. An example of this
 339  would be clocking issues ("your computer is pretty slow") or broken input
 340  data ("Can't synchronize to stream.")
 341 </td>
 342 </tr>
 343 <tr>
 344 <td><p><a name="GST-LEVEL-INFO:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_INFO</code></span></p></td>
 345 <td>Informational messages should be used to keep the developer
 346  updated about what is happening.
 347  Examples where this should be used are when a typefind function has
 348  successfully determined the type of the stream or when an mp3 plugin detects
 349  the format to be used. ("This file has mono sound.")
 350 </td>
 351 </tr>
 352 <tr>
 353 <td><p><a name="GST-LEVEL-DEBUG:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_DEBUG</code></span></p></td>
 354 <td>Debugging messages should be used when something common
 355  happens that is not the expected default behavior, or something that's
 356  useful to know but doesn't happen all the time (ie. per loop iteration or
 357  buffer processed or event handled).
 358  An example would be notifications about state changes or receiving/sending
 359  of events.
 360 </td>
 361 </tr>
 362 <tr>
 363 <td><p><a name="GST-LEVEL-LOG:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_LOG</code></span></p></td>
 364 <td>Log messages are messages that are very common but might be
 365  useful to know. As a rule of thumb a pipeline that is iterating as expected
 366  should never output anything else but LOG messages. Use this log level to
 367  log recurring information in chain functions and loop functions, for
 368  example.
 369 </td>
 370 </tr>
 371 <tr>
 372 <td><p><a name="GST-LEVEL-FIXME:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_FIXME</code></span></p></td>
 373 <td>Fixme messages are messages that indicate that something
 374  in the executed code path is not fully implemented or handled yet. Note
 375  that this does not replace proper error handling in any way, the purpose
 376  of this message is to make it easier to spot incomplete/unfinished pieces
 377  of code when reading the debug log. (Since: 0.10.23)
 378 </td>
 379 </tr>
 380 <tr>
 381 <td><p><a name="GST-LEVEL-TRACE:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_TRACE</code></span></p></td>
 382 <td>Tracing-related messages (Since: 0.10.30)
 383  Examples for this are referencing/dereferencing of objects.
 384 </td>
 385 </tr>
 386 <tr>
 387 <td><p><a name="GST-LEVEL-MEMDUMP:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_MEMDUMP</code></span></p></td>
 388 <td>memory dump messages are used to log (small) chunks of
 389  data as memory dumps in the log. They will be displayed as hexdump with
 390  ASCII characters. (Since: 0.10.23)
 391 </td>
 392 </tr>
 393 <tr>
 394 <td><p><a name="GST-LEVEL-COUNT:CAPS"></a><span class="term"><code class="literal">GST_LEVEL_COUNT</code></span></p></td>
 395 <td>The number of defined debugging levels.
 396 </td>
 397 </tr>
 398 </tbody>
 399 </table></div>
 400 </div>
 401 <hr>
 402 <div class="refsect2">
 403 <a name="GST-LEVEL-DEFAULT:CAPS"></a><h3>GST_LEVEL_DEFAULT</h3>
 404 <pre class="programlisting">#define GST_LEVEL_DEFAULT GST_LEVEL_NONE
 405 </pre>
 406 <p>
 407 Defines the default debugging level to be used with GStreamer. It is normally
 408 set to <a class="link" href="gstreamer-GstInfo.html#GST-LEVEL-NONE:CAPS"><span class="type">GST_LEVEL_NONE</span></a> so nothing get printed.
 409 As it can be configured at compile time, developer builds may chose to
 410 override that though.
 411 You can use this as an argument to <a class="link" href="gstreamer-GstInfo.html#gst-debug-set-default-threshold" title="gst_debug_set_default_threshold ()"><code class="function">gst_debug_set_default_threshold()</code></a> to
 412 reset the debugging output to default behaviour.
 413 </p>
 414 </div>
 415 <hr>
 416 <div class="refsect2">
 417 <a name="GstDebugColorFlags"></a><h3>enum GstDebugColorFlags</h3>
 418 <pre class="programlisting">typedef enum {
 419   /* colors */
 420   GST_DEBUG_FG_BLACK            = 0x0000,
 421   GST_DEBUG_FG_RED              = 0x0001,
 422   GST_DEBUG_FG_GREEN            = 0x0002,
 423   GST_DEBUG_FG_YELLOW           = 0x0003,
 424   GST_DEBUG_FG_BLUE             = 0x0004,
 425   GST_DEBUG_FG_MAGENTA          = 0x0005,
 426   GST_DEBUG_FG_CYAN             = 0x0006,
 427   GST_DEBUG_FG_WHITE            = 0x0007,
 428   /* background colors */
 429   GST_DEBUG_BG_BLACK            = 0x0000,
 430   GST_DEBUG_BG_RED              = 0x0010,
 431   GST_DEBUG_BG_GREEN            = 0x0020,
 432   GST_DEBUG_BG_YELLOW           = 0x0030,
 433   GST_DEBUG_BG_BLUE             = 0x0040,
 434   GST_DEBUG_BG_MAGENTA          = 0x0050,
 435   GST_DEBUG_BG_CYAN             = 0x0060,
 436   GST_DEBUG_BG_WHITE            = 0x0070,
 437   /* other formats */
 438   GST_DEBUG_BOLD                = 0x0100,
 439   GST_DEBUG_UNDERLINE           = 0x0200
 440 } GstDebugColorFlags;
 441 </pre>
 442 <p>
 443 These are some terminal style flags you can use when creating your
 444 debugging categories to make them stand out in debugging output.
 445 </p>
 446 <div class="variablelist"><table border="0">
 447 <col align="left" valign="top">
 448 <tbody>
 449 <tr>
 450 <td><p><a name="GST-DEBUG-FG-BLACK:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_BLACK</code></span></p></td>
 451 <td>Use black as foreground color.
 452 </td>
 453 </tr>
 454 <tr>
 455 <td><p><a name="GST-DEBUG-FG-RED:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_RED</code></span></p></td>
 456 <td>Use red as foreground color.
 457 </td>
 458 </tr>
 459 <tr>
 460 <td><p><a name="GST-DEBUG-FG-GREEN:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_GREEN</code></span></p></td>
 461 <td>Use green as foreground color.
 462 </td>
 463 </tr>
 464 <tr>
 465 <td><p><a name="GST-DEBUG-FG-YELLOW:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_YELLOW</code></span></p></td>
 466 <td>Use yellow as foreground color.
 467 </td>
 468 </tr>
 469 <tr>
 470 <td><p><a name="GST-DEBUG-FG-BLUE:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_BLUE</code></span></p></td>
 471 <td>Use blue as foreground color.
 472 </td>
 473 </tr>
 474 <tr>
 475 <td><p><a name="GST-DEBUG-FG-MAGENTA:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_MAGENTA</code></span></p></td>
 476 <td>Use magenta as foreground color.
 477 </td>
 478 </tr>
 479 <tr>
 480 <td><p><a name="GST-DEBUG-FG-CYAN:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_CYAN</code></span></p></td>
 481 <td>Use cyan as foreground color.
 482 </td>
 483 </tr>
 484 <tr>
 485 <td><p><a name="GST-DEBUG-FG-WHITE:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_FG_WHITE</code></span></p></td>
 486 <td>Use white as foreground color.
 487 </td>
 488 </tr>
 489 <tr>
 490 <td><p><a name="GST-DEBUG-BG-BLACK:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_BLACK</code></span></p></td>
 491 <td>Use black as background color.
 492 </td>
 493 </tr>
 494 <tr>
 495 <td><p><a name="GST-DEBUG-BG-RED:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_RED</code></span></p></td>
 496 <td>Use red as background color.
 497 </td>
 498 </tr>
 499 <tr>
 500 <td><p><a name="GST-DEBUG-BG-GREEN:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_GREEN</code></span></p></td>
 501 <td>Use green as background color.
 502 </td>
 503 </tr>
 504 <tr>
 505 <td><p><a name="GST-DEBUG-BG-YELLOW:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_YELLOW</code></span></p></td>
 506 <td>Use yellow as background color.
 507 </td>
 508 </tr>
 509 <tr>
 510 <td><p><a name="GST-DEBUG-BG-BLUE:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_BLUE</code></span></p></td>
 511 <td>Use blue as background color.
 512 </td>
 513 </tr>
 514 <tr>
 515 <td><p><a name="GST-DEBUG-BG-MAGENTA:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_MAGENTA</code></span></p></td>
 516 <td>Use magenta as background color.
 517 </td>
 518 </tr>
 519 <tr>
 520 <td><p><a name="GST-DEBUG-BG-CYAN:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_CYAN</code></span></p></td>
 521 <td>Use cyan as background color.
 522 </td>
 523 </tr>
 524 <tr>
 525 <td><p><a name="GST-DEBUG-BG-WHITE:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BG_WHITE</code></span></p></td>
 526 <td>Use white as background color.
 527 </td>
 528 </tr>
 529 <tr>
 530 <td><p><a name="GST-DEBUG-BOLD:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_BOLD</code></span></p></td>
 531 <td>Make the output bold.
 532 </td>
 533 </tr>
 534 <tr>
 535 <td><p><a name="GST-DEBUG-UNDERLINE:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_UNDERLINE</code></span></p></td>
 536 <td>Underline the output.
 537 </td>
 538 </tr>
 539 </tbody>
 540 </table></div>
 541 </div>
 542 <hr>
 543 <div class="refsect2">
 544 <a name="GstDebugCategory"></a><h3>struct GstDebugCategory</h3>
 545 <pre class="programlisting">struct GstDebugCategory {
 546 };
 547 </pre>
 548 <p>
 549 This is the struct that describes the categories. Once initialized with
 550 <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-INIT:CAPS" title="GST_DEBUG_CATEGORY_INIT()"><span class="type">GST_DEBUG_CATEGORY_INIT</span></a>, its values can't be changed anymore.
 551 </p>
 552 </div>
 553 <hr>
 554 <div class="refsect2">
 555 <a name="GstDebugGraphDetails"></a><h3>enum GstDebugGraphDetails</h3>
 556 <pre class="programlisting">typedef enum {
 557   GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE         = (1&lt;&lt;0),
 558   GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS       = (1&lt;&lt;1),
 559   GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS = (1&lt;&lt;2),
 560   GST_DEBUG_GRAPH_SHOW_STATES             = (1&lt;&lt;3),
 561   GST_DEBUG_GRAPH_SHOW_ALL                = ((1&lt;&lt;4)-1)
 562 } GstDebugGraphDetails;
 563 </pre>
 564 <p>
 565 Available details for pipeline graphs produced by <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-BIN-TO-DOT-FILE:CAPS" title="GST_DEBUG_BIN_TO_DOT_FILE()"><code class="function">GST_DEBUG_BIN_TO_DOT_FILE()</code></a>
 566 and <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-BIN-TO-DOT-FILE-WITH-TS:CAPS" title="GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS()"><code class="function">GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS()</code></a>.
 567 </p>
 568 <div class="variablelist"><table border="0">
 569 <col align="left" valign="top">
 570 <tbody>
 571 <tr>
 572 <td><p><a name="GST-DEBUG-GRAPH-SHOW-MEDIA-TYPE:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE</code></span></p></td>
 573 <td>show caps-name on edges
 574 </td>
 575 </tr>
 576 <tr>
 577 <td><p><a name="GST-DEBUG-GRAPH-SHOW-CAPS-DETAILS:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS</code></span></p></td>
 578 <td>show caps-details on edges
 579 </td>
 580 </tr>
 581 <tr>
 582 <td><p><a name="GST-DEBUG-GRAPH-SHOW-NON-DEFAULT-PARAMS:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS</code></span></p></td>
 583 <td>show modified parameters on elements
 584 </td>
 585 </tr>
 586 <tr>
 587 <td><p><a name="GST-DEBUG-GRAPH-SHOW-STATES:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_GRAPH_SHOW_STATES</code></span></p></td>
 588 <td>show element states
 589 </td>
 590 </tr>
 591 <tr>
 592 <td><p><a name="GST-DEBUG-GRAPH-SHOW-ALL:CAPS"></a><span class="term"><code class="literal">GST_DEBUG_GRAPH_SHOW_ALL</code></span></p></td>
 593 <td>show all details
 594 </td>
 595 </tr>
 596 </tbody>
 597 </table></div>
 598 <p class="since">Since 0.10.15</p>
 599 </div>
 600 <hr>
 601 <div class="refsect2">
 602 <a name="GST-STR-NULL:CAPS"></a><h3>GST_STR_NULL()</h3>
 603 <pre class="programlisting">#define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
 604 </pre>
 605 <p>
 606 Macro to use when a string must not be NULL, but may be NULL. If the string
 607 is NULL, "(NULL)" is printed instead.
 608 In GStreamer printf string arguments may not be NULL, because on some
 609 platforms (ie Solaris) the libc crashes in that case. This includes debugging
 610 strings.
 611 </p>
 612 <div class="variablelist"><table border="0">
 613 <col align="left" valign="top">
 614 <tbody><tr>
 615 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 616 <td>The string to check.</td>
 617 </tr></tbody>
 618 </table></div>
 619 </div>
 620 <hr>
 621 <div class="refsect2">
 622 <a name="GST-DEBUG-PAD-NAME:CAPS"></a><h3>GST_DEBUG_PAD_NAME()</h3>
 623 <pre class="programlisting">#define             GST_DEBUG_PAD_NAME(pad)</pre>
 624 <p>
 625 Evaluates to 2 strings, that describe the pad. Often used in debugging
 626 statements.
 627 </p>
 628 <div class="variablelist"><table border="0">
 629 <col align="left" valign="top">
 630 <tbody><tr>
 631 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 632 <td>The pad to debug.</td>
 633 </tr></tbody>
 634 </table></div>
 635 </div>
 636 <hr>
 637 <div class="refsect2">
 638 <a name="GST-FUNCTION:CAPS"></a><h3>GST_FUNCTION</h3>
 639 <pre class="programlisting">#  define GST_FUNCTION     ((const char*) (__FUNCTION__))
 640 </pre>
 641 <p>
 642 This macro should evaluate to the name of the current function and be should
 643 be defined when configuring your project, as it is compiler dependant. If it
 644 is not defined, some default value is used. It is used to provide debugging
 645 output with the function name of the message.
 646 </p>
 647 <p>
 648 Note that this is different from G_STRFUNC as we do not want the full
 649 function signature in C++ code.
 650 </p>
 651 </div>
 652 <hr>
 653 <div class="refsect2">
 654 <a name="GstLogFunction"></a><h3>GstLogFunction ()</h3>
 655 <pre class="programlisting"><span class="returnvalue">void</span>                (*GstLogFunction)                   (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
 656                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
 657                                                          <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> *file</code></em>,
 658                                                          <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> *function</code></em>,
 659                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
 660                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 661                                                          <em class="parameter"><code><span class="type">GstDebugMessage</span> *message</code></em>,
 662                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 663 <p>
 664 Function prototype for a logging function that can be registered with
 665 <a class="link" href="gstreamer-GstInfo.html#gst-debug-add-log-function" title="gst_debug_add_log_function ()"><code class="function">gst_debug_add_log_function()</code></a>.
 666 Use G_GNUC_NO_INSTRUMENT on that function.
 667 </p>
 668 <div class="variablelist"><table border="0">
 669 <col align="left" valign="top">
 670 <tbody>
 671 <tr>
 672 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
 673 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a>
 674 </td>
 675 </tr>
 676 <tr>
 677 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 678 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a>
 679 </td>
 680 </tr>
 681 <tr>
 682 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 683 <td>file name</td>
 684 </tr>
 685 <tr>
 686 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
 687 <td>function name</td>
 688 </tr>
 689 <tr>
 690 <td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
 691 <td>line number</td>
 692 </tr>
 693 <tr>
 694 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 695 <td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
 696 </td>
 697 </tr>
 698 <tr>
 699 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 700 <td>the message</td>
 701 </tr>
 702 <tr>
 703 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 704 <td>user data for the log function</td>
 705 </tr>
 706 </tbody>
 707 </table></div>
 708 </div>
 709 <hr>
 710 <div class="refsect2">
 711 <a name="gst-debug-log"></a><h3>gst_debug_log ()</h3>
 712 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_log                       (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
 713                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
 714                                                          <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> *file</code></em>,
 715                                                          <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> *function</code></em>,
 716                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
 717                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 718                                                          <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> *format</code></em>,
 719                                                          <em class="parameter"><code>...</code></em>);</pre>
 720 <p>
 721 Logs the given message using the currently registered debugging handlers.
 722 </p>
 723 <div class="variablelist"><table border="0">
 724 <col align="left" valign="top">
 725 <tbody>
 726 <tr>
 727 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
 728 <td>category to log</td>
 729 </tr>
 730 <tr>
 731 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 732 <td>level of the message is in</td>
 733 </tr>
 734 <tr>
 735 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 736 <td>the file that emitted the message, usually the __FILE__ identifier</td>
 737 </tr>
 738 <tr>
 739 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
 740 <td>the function that emitted the message</td>
 741 </tr>
 742 <tr>
 743 <td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
 744 <td>the line from that the message was emitted, usually __LINE__</td>
 745 </tr>
 746 <tr>
 747 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 748 <td>the object this message relates to,
 749 or NULL if none. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 750 </td>
 751 </tr>
 752 <tr>
 753 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 754 <td>a printf style format string</td>
 755 </tr>
 756 <tr>
 757 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 758 <td>optional arguments for the format</td>
 759 </tr>
 760 </tbody>
 761 </table></div>
 762 </div>
 763 <hr>
 764 <div class="refsect2">
 765 <a name="gst-debug-log-valist"></a><h3>gst_debug_log_valist ()</h3>
 766 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_log_valist                (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
 767                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
 768                                                          <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> *file</code></em>,
 769                                                          <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> *function</code></em>,
 770                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
 771                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 772                                                          <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> *format</code></em>,
 773                                                          <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
 774 <p>
 775 Logs the given message using the currently registered debugging handlers.
 776 </p>
 777 <div class="variablelist"><table border="0">
 778 <col align="left" valign="top">
 779 <tbody>
 780 <tr>
 781 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
 782 <td>category to log</td>
 783 </tr>
 784 <tr>
 785 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 786 <td>level of the message is in</td>
 787 </tr>
 788 <tr>
 789 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 790 <td>the file that emitted the message, usually the __FILE__ identifier</td>
 791 </tr>
 792 <tr>
 793 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
 794 <td>the function that emitted the message</td>
 795 </tr>
 796 <tr>
 797 <td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
 798 <td>the line from that the message was emitted, usually __LINE__</td>
 799 </tr>
 800 <tr>
 801 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 802 <td>the object this message relates to,
 803 or NULL if none. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 804 </td>
 805 </tr>
 806 <tr>
 807 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 808 <td>a printf style format string</td>
 809 </tr>
 810 <tr>
 811 <td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
 812 <td>optional arguments for the format</td>
 813 </tr>
 814 </tbody>
 815 </table></div>
 816 </div>
 817 <hr>
 818 <div class="refsect2">
 819 <a name="gst-debug-message-get"></a><h3>gst_debug_message_get ()</h3>
 820 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_debug_message_get               (<em class="parameter"><code><span class="type">GstDebugMessage</span> *message</code></em>);</pre>
 821 <p>
 822 Gets the string representation of a <span class="type">GstDebugMessage</span>. This function is used
 823 in debug handlers to extract the message.
 824 </p>
 825 <div class="variablelist"><table border="0">
 826 <col align="left" valign="top">
 827 <tbody>
 828 <tr>
 829 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 830 <td>a debug message</td>
 831 </tr>
 832 <tr>
 833 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 834 <td>the string representation of a <span class="type">GstDebugMessage</span>.</td>
 835 </tr>
 836 </tbody>
 837 </table></div>
 838 </div>
 839 <hr>
 840 <div class="refsect2">
 841 <a name="gst-debug-log-default"></a><h3>gst_debug_log_default ()</h3>
 842 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_log_default               (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
 843                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>,
 844                                                          <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> *file</code></em>,
 845                                                          <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> *function</code></em>,
 846                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
 847                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
 848                                                          <em class="parameter"><code><span class="type">GstDebugMessage</span> *message</code></em>,
 849                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> unused</code></em>);</pre>
 850 <p>
 851 The default logging handler used by GStreamer. Logging functions get called
 852 whenever a macro like GST_DEBUG or similar is used. This function outputs the
 853 message and additional info to stderr (or the log file specified via the
 854 GST_DEBUG_FILE environment variable).
 855 </p>
 856 <p>
 857 You can add other handlers by using <a class="link" href="gstreamer-GstInfo.html#gst-debug-add-log-function" title="gst_debug_add_log_function ()"><code class="function">gst_debug_add_log_function()</code></a>.
 858 And you can remove this handler by calling
 859 gst_debug_remove_log_function(gst_debug_log_default);
 860 </p>
 861 <div class="variablelist"><table border="0">
 862 <col align="left" valign="top">
 863 <tbody>
 864 <tr>
 865 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
 866 <td>category to log</td>
 867 </tr>
 868 <tr>
 869 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 870 <td>level of the message</td>
 871 </tr>
 872 <tr>
 873 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 874 <td>the file that emitted the message, usually the __FILE__ identifier</td>
 875 </tr>
 876 <tr>
 877 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
 878 <td>the function that emitted the message</td>
 879 </tr>
 880 <tr>
 881 <td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
 882 <td>the line from that the message was emitted, usually __LINE__</td>
 883 </tr>
 884 <tr>
 885 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 886 <td>the actual message</td>
 887 </tr>
 888 <tr>
 889 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 890 <td>the object this message relates to,
 891 or NULL if none. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 892 </td>
 893 </tr>
 894 <tr>
 895 <td><p><span class="term"><em class="parameter"><code>unused</code></em> :</span></p></td>
 896 <td>an unused variable, reserved for some user_data.</td>
 897 </tr>
 898 </tbody>
 899 </table></div>
 900 </div>
 901 <hr>
 902 <div class="refsect2">
 903 <a name="gst-debug-level-get-name"></a><h3>gst_debug_level_get_name ()</h3>
 904 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_debug_level_get_name            (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);</pre>
 905 <p>
 906 Get the string representation of a debugging level
 907 </p>
 908 <div class="variablelist"><table border="0">
 909 <col align="left" valign="top">
 910 <tbody>
 911 <tr>
 912 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 913 <td>the level to get the name for</td>
 914 </tr>
 915 <tr>
 916 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 917 <td>the name</td>
 918 </tr>
 919 </tbody>
 920 </table></div>
 921 </div>
 922 <hr>
 923 <div class="refsect2">
 924 <a name="gst-debug-add-log-function"></a><h3>gst_debug_add_log_function ()</h3>
 925 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_add_log_function          (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstLogFunction" title="GstLogFunction ()"><span class="type">GstLogFunction</span></a> func</code></em>,
 926                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 927 <p>
 928 Adds the logging function to the list of logging functions.
 929 Be sure to use <a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Macros.html#G-GNUC-NO-INSTRUMENT:CAPS"><span class="type">G_GNUC_NO_INSTRUMENT</span></a> on that function, it is needed.
 930 </p>
 931 <div class="variablelist"><table border="0">
 932 <col align="left" valign="top">
 933 <tbody>
 934 <tr>
 935 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 936 <td>the function to use</td>
 937 </tr>
 938 <tr>
 939 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 940 <td>user data. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 941 </td>
 942 </tr>
 943 </tbody>
 944 </table></div>
 945 </div>
 946 <hr>
 947 <div class="refsect2">
 948 <a name="gst-debug-remove-log-function"></a><h3>gst_debug_remove_log_function ()</h3>
 949 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_debug_remove_log_function       (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstLogFunction" title="GstLogFunction ()"><span class="type">GstLogFunction</span></a> func</code></em>);</pre>
 950 <p>
 951 Removes all registered instances of the given logging functions.
 952 </p>
 953 <div class="variablelist"><table border="0">
 954 <col align="left" valign="top">
 955 <tbody>
 956 <tr>
 957 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 958 <td>the log function to remove</td>
 959 </tr>
 960 <tr>
 961 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 962 <td>How many instances of the function were removed</td>
 963 </tr>
 964 </tbody>
 965 </table></div>
 966 </div>
 967 <hr>
 968 <div class="refsect2">
 969 <a name="gst-debug-remove-log-function-by-data"></a><h3>gst_debug_remove_log_function_by_data ()</h3>
 970 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_debug_remove_log_function_by_data
 971                                                         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 972 <p>
 973 Removes all registered instances of log functions with the given user data.
 974 </p>
 975 <div class="variablelist"><table border="0">
 976 <col align="left" valign="top">
 977 <tbody>
 978 <tr>
 979 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 980 <td>user data of the log function to remove</td>
 981 </tr>
 982 <tr>
 983 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 984 <td>How many instances of the function were removed</td>
 985 </tr>
 986 </tbody>
 987 </table></div>
 988 </div>
 989 <hr>
 990 <div class="refsect2">
 991 <a name="gst-debug-set-active"></a><h3>gst_debug_set_active ()</h3>
 992 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_set_active                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> active</code></em>);</pre>
 993 <p>
 994 If activated, debugging messages are sent to the debugging
 995 handlers.
 996 It makes sense to deactivate it for speed issues.
 997 </p>
 998 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 999 <h3 class="title">Note</h3>
1000 <p>This function is not threadsafe. It makes sense to only call it
1001 during initialization.</p>
1002 </div>
1003 <p>
1004 </p>
1005 <div class="variablelist"><table border="0">
1006 <col align="left" valign="top">
1007 <tbody><tr>
1008 <td><p><span class="term"><em class="parameter"><code>active</code></em> :</span></p></td>
1009 <td>Whether to use debugging output or not</td>
1010 </tr></tbody>
1011 </table></div>
1012 </div>
1013 <hr>
1014 <div class="refsect2">
1015 <a name="gst-debug-is-active"></a><h3>gst_debug_is_active ()</h3>
1016 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_debug_is_active                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1017 <p>
1018 Checks if debugging output is activated.
1019 </p>
1020 <div class="variablelist"><table border="0">
1021 <col align="left" valign="top">
1022 <tbody><tr>
1023 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1024 <td>TRUE, if debugging is activated</td>
1025 </tr></tbody>
1026 </table></div>
1027 </div>
1028 <hr>
1029 <div class="refsect2">
1030 <a name="gst-debug-set-colored"></a><h3>gst_debug_set_colored ()</h3>
1031 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_set_colored               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> colored</code></em>);</pre>
1032 <p>
1033 Sets or unsets the use of coloured debugging output.
1034 </p>
1035 <p>
1036 This function may be called before <a class="link" href="gstreamer-Gst.html#gst-init" title="gst_init ()"><code class="function">gst_init()</code></a>.
1037 </p>
1038 <div class="variablelist"><table border="0">
1039 <col align="left" valign="top">
1040 <tbody><tr>
1041 <td><p><span class="term"><em class="parameter"><code>colored</code></em> :</span></p></td>
1042 <td>Whether to use colored output or not</td>
1043 </tr></tbody>
1044 </table></div>
1045 </div>
1046 <hr>
1047 <div class="refsect2">
1048 <a name="gst-debug-is-colored"></a><h3>gst_debug_is_colored ()</h3>
1049 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_debug_is_colored                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1050 <p>
1051 Checks if the debugging output should be colored.
1052 </p>
1053 <div class="variablelist"><table border="0">
1054 <col align="left" valign="top">
1055 <tbody><tr>
1056 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1057 <td>TRUE, if the debug output should be colored.</td>
1058 </tr></tbody>
1059 </table></div>
1060 </div>
1061 <hr>
1062 <div class="refsect2">
1063 <a name="gst-debug-set-default-threshold"></a><h3>gst_debug_set_default_threshold ()</h3>
1064 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_set_default_threshold     (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);</pre>
1065 <p>
1066 Sets the default threshold to the given level and updates all categories to
1067 use this threshold.
1068 </p>
1069 <p>
1070 This function may be called before <a class="link" href="gstreamer-Gst.html#gst-init" title="gst_init ()"><code class="function">gst_init()</code></a>.
1071 </p>
1072 <div class="variablelist"><table border="0">
1073 <col align="left" valign="top">
1074 <tbody><tr>
1075 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
1076 <td>level to set</td>
1077 </tr></tbody>
1078 </table></div>
1079 </div>
1080 <hr>
1081 <div class="refsect2">
1082 <a name="gst-debug-get-default-threshold"></a><h3>gst_debug_get_default_threshold ()</h3>
1083 <pre class="programlisting"><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="returnvalue">GstDebugLevel</span></a>       gst_debug_get_default_threshold     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1084 <p>
1085 Returns the default threshold that is used for new categories.
1086 </p>
1087 <div class="variablelist"><table border="0">
1088 <col align="left" valign="top">
1089 <tbody><tr>
1090 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1091 <td>the default threshold level</td>
1092 </tr></tbody>
1093 </table></div>
1094 </div>
1095 <hr>
1096 <div class="refsect2">
1097 <a name="gst-debug-set-threshold-for-name"></a><h3>gst_debug_set_threshold_for_name ()</h3>
1098 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_set_threshold_for_name    (<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> *name</code></em>,
1099                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);</pre>
1100 <p>
1101 Sets all categories which match the given glob style pattern to the given
1102 level.
1103 </p>
1104 <div class="variablelist"><table border="0">
1105 <col align="left" valign="top">
1106 <tbody>
1107 <tr>
1108 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1109 <td>name of the categories to set</td>
1110 </tr>
1111 <tr>
1112 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
1113 <td>level to set them to</td>
1114 </tr>
1115 </tbody>
1116 </table></div>
1117 </div>
1118 <hr>
1119 <div class="refsect2">
1120 <a name="gst-debug-unset-threshold-for-name"></a><h3>gst_debug_unset_threshold_for_name ()</h3>
1121 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_unset_threshold_for_name  (<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> *name</code></em>);</pre>
1122 <p>
1123 Resets all categories with the given name back to the default level.
1124 </p>
1125 <div class="variablelist"><table border="0">
1126 <col align="left" valign="top">
1127 <tbody><tr>
1128 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1129 <td>name of the categories to set</td>
1130 </tr></tbody>
1131 </table></div>
1132 </div>
1133 <hr>
1134 <div class="refsect2">
1135 <a name="GST-DEBUG-CATEGORY:CAPS"></a><h3>GST_DEBUG_CATEGORY()</h3>
1136 <pre class="programlisting">#define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL
1137 </pre>
1138 <p>
1139 Defines a GstDebugCategory variable.
1140 This macro expands to nothing if debugging is disabled.
1141 </p>
1142 <div class="variablelist"><table border="0">
1143 <col align="left" valign="top">
1144 <tbody><tr>
1145 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1146 <td>the category</td>
1147 </tr></tbody>
1148 </table></div>
1149 </div>
1150 <hr>
1151 <div class="refsect2">
1152 <a name="GST-DEBUG-CATEGORY-EXTERN:CAPS"></a><h3>GST_DEBUG_CATEGORY_EXTERN()</h3>
1153 <pre class="programlisting">#define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat
1154 </pre>
1155 <p>
1156 Declares a GstDebugCategory variable as extern. Use in header files.
1157 This macro expands to nothing if debugging is disabled.
1158 </p>
1159 <div class="variablelist"><table border="0">
1160 <col align="left" valign="top">
1161 <tbody><tr>
1162 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1163 <td>the category</td>
1164 </tr></tbody>
1165 </table></div>
1166 </div>
1167 <hr>
1168 <div class="refsect2">
1169 <a name="GST-DEBUG-CATEGORY-STATIC:CAPS"></a><h3>GST_DEBUG_CATEGORY_STATIC()</h3>
1170 <pre class="programlisting">#define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
1171 </pre>
1172 <p>
1173 Defines a static GstDebugCategory variable.
1174 This macro expands to nothing if debugging is disabled.
1175 </p>
1176 <div class="variablelist"><table border="0">
1177 <col align="left" valign="top">
1178 <tbody><tr>
1179 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1180 <td>the category</td>
1181 </tr></tbody>
1182 </table></div>
1183 </div>
1184 <hr>
1185 <div class="refsect2">
1186 <a name="GST-DEBUG-CATEGORY-INIT:CAPS"></a><h3>GST_DEBUG_CATEGORY_INIT()</h3>
1187 <pre class="programlisting">#define             GST_DEBUG_CATEGORY_INIT(cat,name,color,description)</pre>
1188 <p>
1189 Initializes a new <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> with the given properties and set to
1190 the default threshold.
1191 </p>
1192 <p>
1193 </p>
1194 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1195 <h3 class="title">Note</h3>
1196 <p>
1197 This macro expands to nothing if debugging is disabled.
1198 </p>
1199 <p>
1200 When naming your category, please follow the following conventions to ensure
1201 that the pattern matching for categories works as expected. It is not
1202 earth-shattering if you don't follow these conventions, but it would be nice
1203 for everyone.
1204 </p>
1205 <p>
1206 If you define a category for a plugin or a feature of it, name the category
1207 like the feature. So if you wanted to write a "filesrc" element, you would
1208 name the category "filesrc". Use lowercase letters only.
1209 If you define more than one category for the same element, append an
1210 underscore and an identifier to your categories, like this: "filesrc_cache"
1211 </p>
1212 <p>
1213 If you create a library or an application using debugging categories, use a
1214 common prefix followed by an underscore for all your categories. GStreamer
1215 uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
1216 to include uppercase letters.
1217 </p>
1218 </div>
1219 <p>
1220 </p>
1221 <div class="variablelist"><table border="0">
1222 <col align="left" valign="top">
1223 <tbody>
1224 <tr>
1225 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1226 <td>the category to initialize.</td>
1227 </tr>
1228 <tr>
1229 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1230 <td>the name of the category.</td>
1231 </tr>
1232 <tr>
1233 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1234 <td>the colors to use for a color representation or 0 for no color.</td>
1235 </tr>
1236 <tr>
1237 <td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
1238 <td>optional description of the category.</td>
1239 </tr>
1240 </tbody>
1241 </table></div>
1242 </div>
1243 <hr>
1244 <div class="refsect2">
1245 <a name="GST-DEBUG-CATEGORY-GET:CAPS"></a><h3>GST_DEBUG_CATEGORY_GET()</h3>
1246 <pre class="programlisting">#define             GST_DEBUG_CATEGORY_GET(cat,name)</pre>
1247 <p>
1248 Looks up an existing <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> by its <em class="parameter"><code>name</code></em> and sets <em class="parameter"><code>cat</code></em>. If the
1249 category is not found, but GST_CAT_DEFAULT is defined, that is assigned to
1250 <em class="parameter"><code>cat</code></em>. Otherwise <em class="parameter"><code>cat</code></em> will be NULL.
1251 </p>
1252 <p>
1253 </p>
1254 <div class="informalexample">
1255   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
1256     <tbody>
1257       <tr>
1258         <td class="listing_lines" align="right"><pre>1
1259 2
1260 3
1261 4
1262 5
1263 6</pre></td>
1264         <td class="listing_code"><pre class="programlisting"><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-STATIC:CAPS">GST_DEBUG_CATEGORY_STATIC</a></span> <span class="gtkdoc opt">(</span>gst_myplugin_debug<span class="gtkdoc opt">);</span>
1265 <span class="gtkdoc ppc">#define GST_CAT_DEFAULT gst_myplugin_debug</span>
1266 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-STATIC:CAPS">GST_DEBUG_CATEGORY_STATIC</a></span> <span class="gtkdoc opt">(</span>GST_CAT_PERFORMANCE<span class="gtkdoc opt">);</span>
1267 <span class="gtkdoc opt">...</span>
1268 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-INIT:CAPS">GST_DEBUG_CATEGORY_INIT</a></span> <span class="gtkdoc opt">(</span>gst_myplugin_debug<span class="gtkdoc opt">,</span> <span class="string">&quot;myplugin&quot;</span><span class="gtkdoc opt">,</span> <span class="number">0</span><span class="gtkdoc opt">,</span> <span class="string">&quot;nice element&quot;</span><span class="gtkdoc opt">);</span>
1269 <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-DEBUG-CATEGORY-GET:CAPS">GST_DEBUG_CATEGORY_GET</a></span> <span class="gtkdoc opt">(</span>GST_CAT_PERFORMANCE<span class="gtkdoc opt">,</span> <span class="string">&quot;GST_PERFORMANCE&quot;</span><span class="gtkdoc opt">);</span></pre></td>
1270       </tr>
1271     </tbody>
1272   </table>
1273 </div>
1274
1275 <p>
1276 </p>
1277 <div class="variablelist"><table border="0">
1278 <col align="left" valign="top">
1279 <tbody>
1280 <tr>
1281 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1282 <td>the category to initialize.</td>
1283 </tr>
1284 <tr>
1285 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1286 <td>log category name</td>
1287 </tr>
1288 </tbody>
1289 </table></div>
1290 <p class="since">Since 0.10.24</p>
1291 </div>
1292 <hr>
1293 <div class="refsect2">
1294 <a name="gst-debug-category-free"></a><h3>gst_debug_category_free ()</h3>
1295 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_category_free             (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);</pre>
1296 <p>
1297 Removes and frees the category and all associated resources.
1298 </p>
1299 <div class="variablelist"><table border="0">
1300 <col align="left" valign="top">
1301 <tbody><tr>
1302 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1303 <td>
1304 <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to free.</td>
1305 </tr></tbody>
1306 </table></div>
1307 </div>
1308 <hr>
1309 <div class="refsect2">
1310 <a name="gst-debug-category-set-threshold"></a><h3>gst_debug_category_set_threshold ()</h3>
1311 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_category_set_threshold    (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>,
1312                                                          <em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> level</code></em>);</pre>
1313 <p>
1314 Sets the threshold of the category to the given level. Debug information will
1315 only be output if the threshold is lower or equal to the level of the
1316 debugging message.
1317 </p>
1318 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1319 <h3 class="title">Note</h3>
1320 <p>
1321 Do not use this function in production code, because other functions may
1322 change the threshold of categories as side effect. It is however a nice
1323 function to use when debugging (even from gdb).
1324 </p>
1325 </div>
1326 <p>
1327 </p>
1328 <div class="variablelist"><table border="0">
1329 <col align="left" valign="top">
1330 <tbody>
1331 <tr>
1332 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1333 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to set threshold of.</td>
1334 </tr>
1335 <tr>
1336 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
1337 <td>the <a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> threshold to set.</td>
1338 </tr>
1339 </tbody>
1340 </table></div>
1341 </div>
1342 <hr>
1343 <div class="refsect2">
1344 <a name="gst-debug-category-reset-threshold"></a><h3>gst_debug_category_reset_threshold ()</h3>
1345 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_category_reset_threshold  (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);</pre>
1346 <p>
1347 Resets the threshold of the category to the default level. Debug information
1348 will only be output if the threshold is lower or equal to the level of the
1349 debugging message.
1350 Use this function to set the threshold back to where it was after using
1351 <a class="link" href="gstreamer-GstInfo.html#gst-debug-category-set-threshold" title="gst_debug_category_set_threshold ()"><code class="function">gst_debug_category_set_threshold()</code></a>.
1352 </p>
1353 <div class="variablelist"><table border="0">
1354 <col align="left" valign="top">
1355 <tbody><tr>
1356 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1357 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to reset threshold of.</td>
1358 </tr></tbody>
1359 </table></div>
1360 </div>
1361 <hr>
1362 <div class="refsect2">
1363 <a name="gst-debug-category-get-threshold"></a><h3>gst_debug_category_get_threshold ()</h3>
1364 <pre class="programlisting"><a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="returnvalue">GstDebugLevel</span></a>       gst_debug_category_get_threshold    (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);</pre>
1365 <p>
1366 Returns the threshold of a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a>.
1367 </p>
1368 <div class="variablelist"><table border="0">
1369 <col align="left" valign="top">
1370 <tbody>
1371 <tr>
1372 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1373 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to get threshold of.</td>
1374 </tr>
1375 <tr>
1376 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1377 <td>the <a class="link" href="gstreamer-GstInfo.html#GstDebugLevel" title="enum GstDebugLevel"><span class="type">GstDebugLevel</span></a> that is used as threshold.</td>
1378 </tr>
1379 </tbody>
1380 </table></div>
1381 </div>
1382 <hr>
1383 <div class="refsect2">
1384 <a name="gst-debug-category-get-name"></a><h3>gst_debug_category_get_name ()</h3>
1385 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_debug_category_get_name         (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);</pre>
1386 <p>
1387 Returns the name of a debug category.
1388 </p>
1389 <div class="variablelist"><table border="0">
1390 <col align="left" valign="top">
1391 <tbody>
1392 <tr>
1393 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1394 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to get name of.</td>
1395 </tr>
1396 <tr>
1397 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1398 <td>the name of the category.</td>
1399 </tr>
1400 </tbody>
1401 </table></div>
1402 </div>
1403 <hr>
1404 <div class="refsect2">
1405 <a name="gst-debug-category-get-color"></a><h3>gst_debug_category_get_color ()</h3>
1406 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_debug_category_get_color        (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);</pre>
1407 <p>
1408 Returns the color of a debug category used when printing output in this
1409 category.
1410 </p>
1411 <div class="variablelist"><table border="0">
1412 <col align="left" valign="top">
1413 <tbody>
1414 <tr>
1415 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1416 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to get the color of.</td>
1417 </tr>
1418 <tr>
1419 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1420 <td>the color of the category.</td>
1421 </tr>
1422 </tbody>
1423 </table></div>
1424 </div>
1425 <hr>
1426 <div class="refsect2">
1427 <a name="gst-debug-category-get-description"></a><h3>gst_debug_category_get_description ()</h3>
1428 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_debug_category_get_description  (<em class="parameter"><code><a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> *category</code></em>);</pre>
1429 <p>
1430 Returns the description of a debug category.
1431 </p>
1432 <div class="variablelist"><table border="0">
1433 <col align="left" valign="top">
1434 <tbody>
1435 <tr>
1436 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
1437 <td>a <a class="link" href="gstreamer-GstInfo.html#GstDebugCategory" title="struct GstDebugCategory"><span class="type">GstDebugCategory</span></a> to get the description of.</td>
1438 </tr>
1439 <tr>
1440 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1441 <td>the description of the category.</td>
1442 </tr>
1443 </tbody>
1444 </table></div>
1445 </div>
1446 <hr>
1447 <div class="refsect2">
1448 <a name="gst-debug-get-all-categories"></a><h3>gst_debug_get_all_categories ()</h3>
1449 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            gst_debug_get_all_categories        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1450 <p>
1451 Returns a snapshot of a all categories that are currently in use . This list
1452 may change anytime.
1453 The caller has to free the list after use.
1454 </p>
1455 <div class="variablelist"><table border="0">
1456 <col align="left" valign="top">
1457 <tbody><tr>
1458 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1459 <td>the list of
1460 debug categories. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gst.DebugCategory]</span>
1461 </td>
1462 </tr></tbody>
1463 </table></div>
1464 </div>
1465 <hr>
1466 <div class="refsect2">
1467 <a name="gst-debug-construct-term-color"></a><h3>gst_debug_construct_term_color ()</h3>
1468 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gst_debug_construct_term_color      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> colorinfo</code></em>);</pre>
1469 <p>
1470 Constructs a string that can be used for getting the desired color in color
1471 terminals.
1472 You need to free the string after use.
1473 </p>
1474 <div class="variablelist"><table border="0">
1475 <col align="left" valign="top">
1476 <tbody>
1477 <tr>
1478 <td><p><span class="term"><em class="parameter"><code>colorinfo</code></em> :</span></p></td>
1479 <td>the color info</td>
1480 </tr>
1481 <tr>
1482 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1483 <td>a string containing the color
1484 definition. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> gchar*]</span>
1485 </td>
1486 </tr>
1487 </tbody>
1488 </table></div>
1489 </div>
1490 <hr>
1491 <div class="refsect2">
1492 <a name="gst-debug-construct-win-color"></a><h3>gst_debug_construct_win_color ()</h3>
1493 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gst_debug_construct_win_color       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> colorinfo</code></em>);</pre>
1494 <p>
1495 Constructs an integer that can be used for getting the desired color in
1496 windows' terminals (cmd.exe). As there is no mean to underline, we simply
1497 ignore this attribute.
1498 </p>
1499 <p>
1500 This function returns 0 on non-windows machines.
1501 </p>
1502 <div class="variablelist"><table border="0">
1503 <col align="left" valign="top">
1504 <tbody>
1505 <tr>
1506 <td><p><span class="term"><em class="parameter"><code>colorinfo</code></em> :</span></p></td>
1507 <td>the color info</td>
1508 </tr>
1509 <tr>
1510 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1511 <td>an integer containing the color definition</td>
1512 </tr>
1513 </tbody>
1514 </table></div>
1515 <p class="since">Since 0.10.23</p>
1516 </div>
1517 <hr>
1518 <div class="refsect2">
1519 <a name="GST-CAT-LEVEL-LOG:CAPS"></a><h3>GST_CAT_LEVEL_LOG()</h3>
1520 <pre class="programlisting">#define             GST_CAT_LEVEL_LOG(cat,level,object,...)</pre>
1521 <p>
1522 Outputs a debugging message. This is the most general macro for outputting
1523 debugging messages. You will probably want to use one of the ones described
1524 below.
1525 </p>
1526 <div class="variablelist"><table border="0">
1527 <col align="left" valign="top">
1528 <tbody>
1529 <tr>
1530 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1531 <td>category to use</td>
1532 </tr>
1533 <tr>
1534 <td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
1535 <td>the severity of the message</td>
1536 </tr>
1537 <tr>
1538 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
1539 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to or NULL if none</td>
1540 </tr>
1541 <tr>
1542 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1543 <td>A printf-style message to output</td>
1544 </tr>
1545 </tbody>
1546 </table></div>
1547 </div>
1548 <hr>
1549 <div class="refsect2">
1550 <a name="GST-CAT-ERROR-OBJECT:CAPS"></a><h3>GST_CAT_ERROR_OBJECT()</h3>
1551 <pre class="programlisting">#define GST_CAT_ERROR_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
1552 </pre>
1553 <p>
1554 Output an error message belonging to the given object in the given category.
1555 </p>
1556 <div class="variablelist"><table border="0">
1557 <col align="left" valign="top">
1558 <tbody>
1559 <tr>
1560 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1561 <td>category to use</td>
1562 </tr>
1563 <tr>
1564 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1565 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1566 </tr>
1567 <tr>
1568 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1569 <td>printf-style message to output</td>
1570 </tr>
1571 </tbody>
1572 </table></div>
1573 </div>
1574 <hr>
1575 <div class="refsect2">
1576 <a name="GST-CAT-WARNING-OBJECT:CAPS"></a><h3>GST_CAT_WARNING_OBJECT()</h3>
1577 <pre class="programlisting">#define GST_CAT_WARNING_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
1578 </pre>
1579 <p>
1580 Output a warning message belonging to the given object in the given category.
1581 </p>
1582 <div class="variablelist"><table border="0">
1583 <col align="left" valign="top">
1584 <tbody>
1585 <tr>
1586 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1587 <td>category to use</td>
1588 </tr>
1589 <tr>
1590 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1591 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1592 </tr>
1593 <tr>
1594 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1595 <td>printf-style message to output</td>
1596 </tr>
1597 </tbody>
1598 </table></div>
1599 </div>
1600 <hr>
1601 <div class="refsect2">
1602 <a name="GST-CAT-INFO-OBJECT:CAPS"></a><h3>GST_CAT_INFO_OBJECT()</h3>
1603 <pre class="programlisting">#define GST_CAT_INFO_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
1604 </pre>
1605 <p>
1606 Output an informational message belonging to the given object in the given
1607 category.
1608 </p>
1609 <div class="variablelist"><table border="0">
1610 <col align="left" valign="top">
1611 <tbody>
1612 <tr>
1613 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1614 <td>category to use</td>
1615 </tr>
1616 <tr>
1617 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1618 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1619 </tr>
1620 <tr>
1621 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1622 <td>printf-style message to output</td>
1623 </tr>
1624 </tbody>
1625 </table></div>
1626 </div>
1627 <hr>
1628 <div class="refsect2">
1629 <a name="GST-CAT-DEBUG-OBJECT:CAPS"></a><h3>GST_CAT_DEBUG_OBJECT()</h3>
1630 <pre class="programlisting">#define GST_CAT_DEBUG_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
1631 </pre>
1632 <p>
1633 Output an debugging message belonging to the given object in the given category.
1634 </p>
1635 <div class="variablelist"><table border="0">
1636 <col align="left" valign="top">
1637 <tbody>
1638 <tr>
1639 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1640 <td>category to use</td>
1641 </tr>
1642 <tr>
1643 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1644 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1645 </tr>
1646 <tr>
1647 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1648 <td>printf-style message to output</td>
1649 </tr>
1650 </tbody>
1651 </table></div>
1652 </div>
1653 <hr>
1654 <div class="refsect2">
1655 <a name="GST-CAT-LOG-OBJECT:CAPS"></a><h3>GST_CAT_LOG_OBJECT()</h3>
1656 <pre class="programlisting">#define GST_CAT_LOG_OBJECT(cat,obj,...)             GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
1657 </pre>
1658 <p>
1659 Output an logging message belonging to the given object in the given category.
1660 </p>
1661 <div class="variablelist"><table border="0">
1662 <col align="left" valign="top">
1663 <tbody>
1664 <tr>
1665 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1666 <td>category to use</td>
1667 </tr>
1668 <tr>
1669 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1670 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1671 </tr>
1672 <tr>
1673 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1674 <td>printf-style message to output</td>
1675 </tr>
1676 </tbody>
1677 </table></div>
1678 </div>
1679 <hr>
1680 <div class="refsect2">
1681 <a name="GST-CAT-FIXME-OBJECT:CAPS"></a><h3>GST_CAT_FIXME_OBJECT()</h3>
1682 <pre class="programlisting">#define GST_CAT_FIXME_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)
1683 </pre>
1684 <p>
1685 Output a fixme message belonging to the given object in the given category.
1686 </p>
1687 <div class="variablelist"><table border="0">
1688 <col align="left" valign="top">
1689 <tbody>
1690 <tr>
1691 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1692 <td>category to use</td>
1693 </tr>
1694 <tr>
1695 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1696 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1697 </tr>
1698 <tr>
1699 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1700 <td>printf-style message to output</td>
1701 </tr>
1702 </tbody>
1703 </table></div>
1704 <p class="since">Since 0.10.23</p>
1705 </div>
1706 <hr>
1707 <div class="refsect2">
1708 <a name="GST-CAT-TRACE-OBJECT:CAPS"></a><h3>GST_CAT_TRACE_OBJECT()</h3>
1709 <pre class="programlisting">#define GST_CAT_TRACE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)
1710 </pre>
1711 <p>
1712 Output a tracing message belonging to the given object in the given
1713 category.
1714 </p>
1715 <div class="variablelist"><table border="0">
1716 <col align="left" valign="top">
1717 <tbody>
1718 <tr>
1719 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1720 <td>category to use</td>
1721 </tr>
1722 <tr>
1723 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1724 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1725 </tr>
1726 <tr>
1727 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1728 <td>printf-style message to output</td>
1729 </tr>
1730 </tbody>
1731 </table></div>
1732 <p class="since">Since 0.10.30</p>
1733 </div>
1734 <hr>
1735 <div class="refsect2">
1736 <a name="GST-CAT-MEMDUMP-OBJECT:CAPS"></a><h3>GST_CAT_MEMDUMP_OBJECT()</h3>
1737 <pre class="programlisting">#define             GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length)</pre>
1738 <p>
1739 Output a hexdump of <em class="parameter"><code>data</code></em> relating to the given object in the given
1740 category.
1741 </p>
1742 <div class="variablelist"><table border="0">
1743 <col align="left" valign="top">
1744 <tbody>
1745 <tr>
1746 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1747 <td>category to use</td>
1748 </tr>
1749 <tr>
1750 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1751 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1752 </tr>
1753 <tr>
1754 <td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
1755 <td>message string to log with the data</td>
1756 </tr>
1757 <tr>
1758 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1759 <td>pointer to the data to output</td>
1760 </tr>
1761 <tr>
1762 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1763 <td>length of the data to output</td>
1764 </tr>
1765 </tbody>
1766 </table></div>
1767 <p class="since">Since 0.10.23</p>
1768 </div>
1769 <hr>
1770 <div class="refsect2">
1771 <a name="GST-CAT-ERROR:CAPS"></a><h3>GST_CAT_ERROR()</h3>
1772 <pre class="programlisting">#define GST_CAT_ERROR(cat,...)                      GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
1773 </pre>
1774 <p>
1775 Output an error message in the given category.
1776 </p>
1777 <div class="variablelist"><table border="0">
1778 <col align="left" valign="top">
1779 <tbody>
1780 <tr>
1781 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1782 <td>category to use</td>
1783 </tr>
1784 <tr>
1785 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1786 <td>printf-style message to output</td>
1787 </tr>
1788 </tbody>
1789 </table></div>
1790 </div>
1791 <hr>
1792 <div class="refsect2">
1793 <a name="GST-CAT-WARNING:CAPS"></a><h3>GST_CAT_WARNING()</h3>
1794 <pre class="programlisting">#define GST_CAT_WARNING(cat,...)            GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
1795 </pre>
1796 <p>
1797 Output an warning message in the given category.
1798 </p>
1799 <div class="variablelist"><table border="0">
1800 <col align="left" valign="top">
1801 <tbody>
1802 <tr>
1803 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1804 <td>category to use</td>
1805 </tr>
1806 <tr>
1807 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1808 <td>printf-style message to output</td>
1809 </tr>
1810 </tbody>
1811 </table></div>
1812 </div>
1813 <hr>
1814 <div class="refsect2">
1815 <a name="GST-CAT-INFO:CAPS"></a><h3>GST_CAT_INFO()</h3>
1816 <pre class="programlisting">#define GST_CAT_INFO(cat,...)                       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
1817 </pre>
1818 <p>
1819 Output an informational message in the given category.
1820 </p>
1821 <div class="variablelist"><table border="0">
1822 <col align="left" valign="top">
1823 <tbody>
1824 <tr>
1825 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1826 <td>category to use</td>
1827 </tr>
1828 <tr>
1829 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1830 <td>printf-style message to output</td>
1831 </tr>
1832 </tbody>
1833 </table></div>
1834 </div>
1835 <hr>
1836 <div class="refsect2">
1837 <a name="GST-CAT-DEBUG:CAPS"></a><h3>GST_CAT_DEBUG()</h3>
1838 <pre class="programlisting">#define GST_CAT_DEBUG(cat,...)                      GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
1839 </pre>
1840 <p>
1841 Output an debugging message in the given category.
1842 </p>
1843 <div class="variablelist"><table border="0">
1844 <col align="left" valign="top">
1845 <tbody>
1846 <tr>
1847 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1848 <td>category to use</td>
1849 </tr>
1850 <tr>
1851 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1852 <td>printf-style message to output</td>
1853 </tr>
1854 </tbody>
1855 </table></div>
1856 </div>
1857 <hr>
1858 <div class="refsect2">
1859 <a name="GST-CAT-LOG:CAPS"></a><h3>GST_CAT_LOG()</h3>
1860 <pre class="programlisting">#define GST_CAT_LOG(cat,...)                        GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
1861 </pre>
1862 <p>
1863 Output an logging message in the given category.
1864 </p>
1865 <div class="variablelist"><table border="0">
1866 <col align="left" valign="top">
1867 <tbody>
1868 <tr>
1869 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1870 <td>category to use</td>
1871 </tr>
1872 <tr>
1873 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1874 <td>printf-style message to output</td>
1875 </tr>
1876 </tbody>
1877 </table></div>
1878 </div>
1879 <hr>
1880 <div class="refsect2">
1881 <a name="GST-CAT-FIXME:CAPS"></a><h3>GST_CAT_FIXME()</h3>
1882 <pre class="programlisting">#define GST_CAT_FIXME(cat,...)                      GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)
1883 </pre>
1884 <p>
1885 Output an fixme message in the given category.
1886 </p>
1887 <div class="variablelist"><table border="0">
1888 <col align="left" valign="top">
1889 <tbody>
1890 <tr>
1891 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1892 <td>category to use</td>
1893 </tr>
1894 <tr>
1895 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1896 <td>printf-style message to output</td>
1897 </tr>
1898 </tbody>
1899 </table></div>
1900 <p class="since">Since 0.10.23</p>
1901 </div>
1902 <hr>
1903 <div class="refsect2">
1904 <a name="GST-CAT-TRACE:CAPS"></a><h3>GST_CAT_TRACE()</h3>
1905 <pre class="programlisting">#define GST_CAT_TRACE(cat,...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)
1906 </pre>
1907 <p>
1908 Output a tracing message in the given category.
1909 </p>
1910 <div class="variablelist"><table border="0">
1911 <col align="left" valign="top">
1912 <tbody>
1913 <tr>
1914 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1915 <td>category to use</td>
1916 </tr>
1917 <tr>
1918 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1919 <td>printf-style message to output</td>
1920 </tr>
1921 </tbody>
1922 </table></div>
1923 <p class="since">Since 0.10.30</p>
1924 </div>
1925 <hr>
1926 <div class="refsect2">
1927 <a name="GST-CAT-MEMDUMP:CAPS"></a><h3>GST_CAT_MEMDUMP()</h3>
1928 <pre class="programlisting">#define             GST_CAT_MEMDUMP(cat,msg,data,length)</pre>
1929 <p>
1930 Output a hexdump of <em class="parameter"><code>data</code></em> in the given category.
1931 </p>
1932 <div class="variablelist"><table border="0">
1933 <col align="left" valign="top">
1934 <tbody>
1935 <tr>
1936 <td><p><span class="term"><em class="parameter"><code>cat</code></em> :</span></p></td>
1937 <td>category to use</td>
1938 </tr>
1939 <tr>
1940 <td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
1941 <td>message string to log with the data</td>
1942 </tr>
1943 <tr>
1944 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1945 <td>pointer to the data to output</td>
1946 </tr>
1947 <tr>
1948 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1949 <td>length of the data to output</td>
1950 </tr>
1951 </tbody>
1952 </table></div>
1953 <p class="since">Since 0.10.23</p>
1954 </div>
1955 <hr>
1956 <div class="refsect2">
1957 <a name="GST-ERROR-OBJECT:CAPS"></a><h3>GST_ERROR_OBJECT()</h3>
1958 <pre class="programlisting">#define GST_ERROR_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
1959 </pre>
1960 <p>
1961 Output an error message belonging to the given object in the default category.
1962 </p>
1963 <div class="variablelist"><table border="0">
1964 <col align="left" valign="top">
1965 <tbody>
1966 <tr>
1967 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1968 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1969 </tr>
1970 <tr>
1971 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1972 <td>printf-style message to output</td>
1973 </tr>
1974 </tbody>
1975 </table></div>
1976 </div>
1977 <hr>
1978 <div class="refsect2">
1979 <a name="GST-WARNING-OBJECT:CAPS"></a><h3>GST_WARNING_OBJECT()</h3>
1980 <pre class="programlisting">#define GST_WARNING_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
1981 </pre>
1982 <p>
1983 Output a warning message belonging to the given object in the default category.
1984 </p>
1985 <div class="variablelist"><table border="0">
1986 <col align="left" valign="top">
1987 <tbody>
1988 <tr>
1989 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
1990 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
1991 </tr>
1992 <tr>
1993 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1994 <td>printf-style message to output</td>
1995 </tr>
1996 </tbody>
1997 </table></div>
1998 </div>
1999 <hr>
2000 <div class="refsect2">
2001 <a name="GST-INFO-OBJECT:CAPS"></a><h3>GST_INFO_OBJECT()</h3>
2002 <pre class="programlisting">#define GST_INFO_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
2003 </pre>
2004 <p>
2005 Output an informational message belonging to the given object in the default
2006 category.
2007 </p>
2008 <div class="variablelist"><table border="0">
2009 <col align="left" valign="top">
2010 <tbody>
2011 <tr>
2012 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
2013 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
2014 </tr>
2015 <tr>
2016 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2017 <td>printf-style message to output</td>
2018 </tr>
2019 </tbody>
2020 </table></div>
2021 </div>
2022 <hr>
2023 <div class="refsect2">
2024 <a name="GST-DEBUG-OBJECT:CAPS"></a><h3>GST_DEBUG_OBJECT()</h3>
2025 <pre class="programlisting">#define GST_DEBUG_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
2026 </pre>
2027 <p>
2028 Output a debugging message belonging to the given object in the default
2029 category.
2030 </p>
2031 <div class="variablelist"><table border="0">
2032 <col align="left" valign="top">
2033 <tbody>
2034 <tr>
2035 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
2036 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
2037 </tr>
2038 <tr>
2039 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2040 <td>printf-style message to output</td>
2041 </tr>
2042 </tbody>
2043 </table></div>
2044 </div>
2045 <hr>
2046 <div class="refsect2">
2047 <a name="GST-LOG-OBJECT:CAPS"></a><h3>GST_LOG_OBJECT()</h3>
2048 <pre class="programlisting">#define GST_LOG_OBJECT(obj,...)             GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
2049 </pre>
2050 <p>
2051 Output a logging message belonging to the given object in the default category.
2052 </p>
2053 <div class="variablelist"><table border="0">
2054 <col align="left" valign="top">
2055 <tbody>
2056 <tr>
2057 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
2058 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
2059 </tr>
2060 <tr>
2061 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2062 <td>printf-style message to output</td>
2063 </tr>
2064 </tbody>
2065 </table></div>
2066 </div>
2067 <hr>
2068 <div class="refsect2">
2069 <a name="GST-FIXME-OBJECT:CAPS"></a><h3>GST_FIXME_OBJECT()</h3>
2070 <pre class="programlisting">#define GST_FIXME_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)
2071 </pre>
2072 <p>
2073 Output a fixme message belonging to the given object in the default category.
2074 </p>
2075 <div class="variablelist"><table border="0">
2076 <col align="left" valign="top">
2077 <tbody>
2078 <tr>
2079 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
2080 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
2081 </tr>
2082 <tr>
2083 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2084 <td>printf-style message to output</td>
2085 </tr>
2086 </tbody>
2087 </table></div>
2088 <p class="since">Since 0.10.23</p>
2089 </div>
2090 <hr>
2091 <div class="refsect2">
2092 <a name="GST-TRACE-OBJECT:CAPS"></a><h3>GST_TRACE_OBJECT()</h3>
2093 <pre class="programlisting">#define GST_TRACE_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)
2094 </pre>
2095 <p>
2096 Output a tracing message belonging to the given object in the default category.
2097 </p>
2098 <div class="variablelist"><table border="0">
2099 <col align="left" valign="top">
2100 <tbody>
2101 <tr>
2102 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
2103 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
2104 </tr>
2105 <tr>
2106 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2107 <td>printf-style message to output</td>
2108 </tr>
2109 </tbody>
2110 </table></div>
2111 <p class="since">Since 0.10.30</p>
2112 </div>
2113 <hr>
2114 <div class="refsect2">
2115 <a name="GST-MEMDUMP-OBJECT:CAPS"></a><h3>GST_MEMDUMP_OBJECT()</h3>
2116 <pre class="programlisting">#define             GST_MEMDUMP_OBJECT(obj,msg,data,length)</pre>
2117 <p>
2118 Output a logging message belonging to the given object in the default category.
2119 </p>
2120 <div class="variablelist"><table border="0">
2121 <col align="left" valign="top">
2122 <tbody>
2123 <tr>
2124 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
2125 <td>the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> the message belongs to</td>
2126 </tr>
2127 <tr>
2128 <td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
2129 <td>message string to log with the data</td>
2130 </tr>
2131 <tr>
2132 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
2133 <td>pointer to the data to output</td>
2134 </tr>
2135 <tr>
2136 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
2137 <td>length of the data to output</td>
2138 </tr>
2139 </tbody>
2140 </table></div>
2141 <p class="since">Since 0.10.23</p>
2142 </div>
2143 <hr>
2144 <div class="refsect2">
2145 <a name="GST-ERROR:CAPS"></a><h3>GST_ERROR()</h3>
2146 <pre class="programlisting">#define GST_ERROR(...)                      GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
2147 </pre>
2148 <p>
2149 Output an error message in the default category.
2150 </p>
2151 <div class="variablelist"><table border="0">
2152 <col align="left" valign="top">
2153 <tbody><tr>
2154 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2155 <td>printf-style message to output</td>
2156 </tr></tbody>
2157 </table></div>
2158 </div>
2159 <hr>
2160 <div class="refsect2">
2161 <a name="GST-WARNING:CAPS"></a><h3>GST_WARNING()</h3>
2162 <pre class="programlisting">#define GST_WARNING(...)            GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
2163 </pre>
2164 <p>
2165 Output a warning message in the default category.
2166 </p>
2167 <div class="variablelist"><table border="0">
2168 <col align="left" valign="top">
2169 <tbody><tr>
2170 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2171 <td>printf-style message to output</td>
2172 </tr></tbody>
2173 </table></div>
2174 </div>
2175 <hr>
2176 <div class="refsect2">
2177 <a name="GST-INFO:CAPS"></a><h3>GST_INFO()</h3>
2178 <pre class="programlisting">#define GST_INFO(...)                       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
2179 </pre>
2180 <p>
2181 Output an informational message in the default category.
2182 </p>
2183 <div class="variablelist"><table border="0">
2184 <col align="left" valign="top">
2185 <tbody><tr>
2186 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2187 <td>printf-style message to output</td>
2188 </tr></tbody>
2189 </table></div>
2190 </div>
2191 <hr>
2192 <div class="refsect2">
2193 <a name="GST-DEBUG:CAPS"></a><h3>GST_DEBUG()</h3>
2194 <pre class="programlisting">#define GST_DEBUG(...)                      GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
2195 </pre>
2196 <p>
2197 Output a debugging message in the default category.
2198 </p>
2199 <div class="variablelist"><table border="0">
2200 <col align="left" valign="top">
2201 <tbody><tr>
2202 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2203 <td>printf-style message to output</td>
2204 </tr></tbody>
2205 </table></div>
2206 </div>
2207 <hr>
2208 <div class="refsect2">
2209 <a name="GST-LOG:CAPS"></a><h3>GST_LOG()</h3>
2210 <pre class="programlisting">#define GST_LOG(...)                        GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
2211 </pre>
2212 <p>
2213 Output a logging message in the default category.
2214 </p>
2215 <div class="variablelist"><table border="0">
2216 <col align="left" valign="top">
2217 <tbody><tr>
2218 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2219 <td>printf-style message to output</td>
2220 </tr></tbody>
2221 </table></div>
2222 </div>
2223 <hr>
2224 <div class="refsect2">
2225 <a name="GST-FIXME:CAPS"></a><h3>GST_FIXME()</h3>
2226 <pre class="programlisting">#define GST_FIXME(...)                      GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)
2227 </pre>
2228 <p>
2229 Output a fixme message in the default category.
2230 </p>
2231 <div class="variablelist"><table border="0">
2232 <col align="left" valign="top">
2233 <tbody><tr>
2234 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2235 <td>printf-style message to output</td>
2236 </tr></tbody>
2237 </table></div>
2238 <p class="since">Since 0.10.23</p>
2239 </div>
2240 <hr>
2241 <div class="refsect2">
2242 <a name="GST-TRACE:CAPS"></a><h3>GST_TRACE()</h3>
2243 <pre class="programlisting">#define GST_TRACE(...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)
2244 </pre>
2245 <p>
2246 Output a tracing message in the default category.
2247 </p>
2248 <div class="variablelist"><table border="0">
2249 <col align="left" valign="top">
2250 <tbody><tr>
2251 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
2252 <td>printf-style message to output</td>
2253 </tr></tbody>
2254 </table></div>
2255 <p class="since">Since 0.10.30</p>
2256 </div>
2257 <hr>
2258 <div class="refsect2">
2259 <a name="GST-MEMDUMP:CAPS"></a><h3>GST_MEMDUMP()</h3>
2260 <pre class="programlisting">#define             GST_MEMDUMP(msg,data,length)</pre>
2261 <p>
2262 Output a hexdump of <em class="parameter"><code>data</code></em>.
2263 </p>
2264 <div class="variablelist"><table border="0">
2265 <col align="left" valign="top">
2266 <tbody>
2267 <tr>
2268 <td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
2269 <td>message string to log with the data</td>
2270 </tr>
2271 <tr>
2272 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
2273 <td>pointer to the data to output</td>
2274 </tr>
2275 <tr>
2276 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
2277 <td>length of the data to output</td>
2278 </tr>
2279 </tbody>
2280 </table></div>
2281 <p class="since">Since 0.10.23</p>
2282 </div>
2283 <hr>
2284 <div class="refsect2">
2285 <a name="GST-DEBUG-REGISTER-FUNCPTR:CAPS"></a><h3>GST_DEBUG_REGISTER_FUNCPTR()</h3>
2286 <pre class="programlisting">#define             GST_DEBUG_REGISTER_FUNCPTR(ptr)</pre>
2287 <p>
2288 Register a pointer to a function with its name, so it can later be used by
2289 <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-FUNCPTR-NAME:CAPS" title="GST_DEBUG_FUNCPTR_NAME()"><code class="function">GST_DEBUG_FUNCPTR_NAME()</code></a>.
2290 </p>
2291 <p>
2292 Use this variant of <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-FUNCPTR:CAPS" title="GST_DEBUG_FUNCPTR()"><span class="type">GST_DEBUG_FUNCPTR</span></a> if you do not need to use <em class="parameter"><code>ptr</code></em>.
2293 </p>
2294 <div class="variablelist"><table border="0">
2295 <col align="left" valign="top">
2296 <tbody><tr>
2297 <td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
2298 <td>pointer to the function to register</td>
2299 </tr></tbody>
2300 </table></div>
2301 <p class="since">Since 0.10.26</p>
2302 </div>
2303 <hr>
2304 <div class="refsect2">
2305 <a name="GST-DEBUG-FUNCPTR:CAPS"></a><h3>GST_DEBUG_FUNCPTR()</h3>
2306 <pre class="programlisting">#define             GST_DEBUG_FUNCPTR(ptr)</pre>
2307 <p>
2308 Register a pointer to a function with its name, so it can later be used by
2309 <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-FUNCPTR-NAME:CAPS" title="GST_DEBUG_FUNCPTR_NAME()"><code class="function">GST_DEBUG_FUNCPTR_NAME()</code></a>.
2310 </p>
2311 <div class="variablelist"><table border="0">
2312 <col align="left" valign="top">
2313 <tbody>
2314 <tr>
2315 <td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
2316 <td>pointer to the function to register</td>
2317 </tr>
2318 <tr>
2319 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2320 <td>the value passed to <em class="parameter"><code>ptr</code></em>.</td>
2321 </tr>
2322 </tbody>
2323 </table></div>
2324 </div>
2325 <hr>
2326 <div class="refsect2">
2327 <a name="GST-DEBUG-FUNCPTR-NAME:CAPS"></a><h3>GST_DEBUG_FUNCPTR_NAME()</h3>
2328 <pre class="programlisting">#define             GST_DEBUG_FUNCPTR_NAME(ptr)</pre>
2329 <p>
2330 Retrieves the name of the function, if it was previously registered with
2331 <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-FUNCPTR:CAPS" title="GST_DEBUG_FUNCPTR()"><code class="function">GST_DEBUG_FUNCPTR()</code></a>. If not, it returns a description of the pointer.
2332 </p>
2333 <p>
2334 This macro returns a constant string which must not be modified or
2335 freed by the caller.
2336 </p>
2337 <div class="variablelist"><table border="0">
2338 <col align="left" valign="top">
2339 <tbody><tr>
2340 <td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
2341 <td>address of the function of which to look up the name</td>
2342 </tr></tbody>
2343 </table></div>
2344 </div>
2345 <hr>
2346 <div class="refsect2">
2347 <a name="GST-DEBUG-BIN-TO-DOT-FILE:CAPS"></a><h3>GST_DEBUG_BIN_TO_DOT_FILE()</h3>
2348 <pre class="programlisting">#define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) _gst_debug_bin_to_dot_file (bin, details, file_name)
2349 </pre>
2350 <p>
2351 To aid debugging applications one can use this method to write out the whole
2352 network of gstreamer elements that form the pipeline into an dot file.
2353 This file can be processed with graphviz to get an image.
2354 </p>
2355 <div class="informalexample">
2356   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
2357     <tbody>
2358       <tr>
2359         <td class="listing_lines" align="right"><pre>1</pre></td>
2360         <td class="listing_code"><pre class="programlisting">dot <span class="gtkdoc opt">-</span>Tpng <span class="gtkdoc opt">-</span>oimage<span class="gtkdoc opt">.</span>png graph_lowlevel<span class="gtkdoc opt">.</span>dot</pre></td>
2361       </tr>
2362     </tbody>
2363   </table>
2364 </div>
2365
2366 <p>
2367 </p>
2368 <p>
2369 The macro is only active if gstreamer is configured with
2370 "--gst-enable-gst-debug" and the environment variable
2371 GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).
2372 </p>
2373 <div class="variablelist"><table border="0">
2374 <col align="left" valign="top">
2375 <tbody>
2376 <tr>
2377 <td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
2378 <td>the top-level pipeline that should be analyzed</td>
2379 </tr>
2380 <tr>
2381 <td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
2382 <td>details to show in the graph, e.g. <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-GRAPH-SHOW-ALL:CAPS"><span class="type">GST_DEBUG_GRAPH_SHOW_ALL</span></a> or
2383 one or more other <a class="link" href="gstreamer-GstInfo.html#GstDebugGraphDetails" title="enum GstDebugGraphDetails"><span class="type">GstDebugGraphDetails</span></a> flags.</td>
2384 </tr>
2385 <tr>
2386 <td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
2387 <td>output base filename (e.g. "myplayer")</td>
2388 </tr>
2389 </tbody>
2390 </table></div>
2391 <p class="since">Since 0.10.15</p>
2392 </div>
2393 <hr>
2394 <div class="refsect2">
2395 <a name="GST-DEBUG-BIN-TO-DOT-FILE-WITH-TS:CAPS"></a><h3>GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS()</h3>
2396 <pre class="programlisting">#define GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS(bin, details, file_name) _gst_debug_bin_to_dot_file_with_ts (bin, details, file_name)
2397 </pre>
2398 <p>
2399 This works like <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-BIN-TO-DOT-FILE:CAPS" title="GST_DEBUG_BIN_TO_DOT_FILE()"><code class="function">GST_DEBUG_BIN_TO_DOT_FILE()</code></a>, but adds the current timestamp
2400 to the filename, so that it can be used to take multiple snapshots.
2401 </p>
2402 <div class="variablelist"><table border="0">
2403 <col align="left" valign="top">
2404 <tbody>
2405 <tr>
2406 <td><p><span class="term"><em class="parameter"><code>bin</code></em> :</span></p></td>
2407 <td>the top-level pipeline that should be analyzed</td>
2408 </tr>
2409 <tr>
2410 <td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
2411 <td>details to show in the graph, e.g. <a class="link" href="gstreamer-GstInfo.html#GST-DEBUG-GRAPH-SHOW-ALL:CAPS"><span class="type">GST_DEBUG_GRAPH_SHOW_ALL</span></a> or
2412 one or more other <a class="link" href="gstreamer-GstInfo.html#GstDebugGraphDetails" title="enum GstDebugGraphDetails"><span class="type">GstDebugGraphDetails</span></a> flags.</td>
2413 </tr>
2414 <tr>
2415 <td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
2416 <td>output base filename (e.g. "myplayer")</td>
2417 </tr>
2418 </tbody>
2419 </table></div>
2420 <p class="since">Since 0.10.15</p>
2421 </div>
2422 <hr>
2423 <div class="refsect2">
2424 <a name="gst-debug-print-stack-trace"></a><h3>gst_debug_print_stack_trace ()</h3>
2425 <pre class="programlisting"><span class="returnvalue">void</span>                gst_debug_print_stack_trace         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
2426 <p>
2427 If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
2428 gstreamer code, which can be printed with this function.
2429 </p>
2430 </div>
2431 <hr>
2432 <div class="refsect2">
2433 <a name="GST-TIME-FORMAT:CAPS"></a><h3>GST_TIME_FORMAT</h3>
2434 <pre class="programlisting">#define GST_TIME_FORMAT "u:%02u:%02u.%09u"
2435 </pre>
2436 <p>
2437 A string that can be used in printf-like format strings to display a
2438 <a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> value in h:m:s format.  Use <a class="link" href="gstreamer-GstInfo.html#GST-TIME-ARGS:CAPS" title="GST_TIME_ARGS()"><code class="function">GST_TIME_ARGS()</code></a> to construct
2439 the matching arguments.
2440 </p>
2441 <p>
2442 Example:
2443 </p>
2444 <div class="informalexample">
2445   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
2446     <tbody>
2447       <tr>
2448         <td class="listing_lines" align="right"><pre>1</pre></td>
2449         <td class="listing_code"><pre class="programlisting"><span class="function">printf</span><span class="gtkdoc opt">(</span><span class="string">&quot;%&quot;</span> GST_TIME_FORMAT <span class="string">&quot;</span><span class="gtkdoc esc">\n</span><span class="string">&quot;</span><span class="gtkdoc opt">,</span> <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstInfo.html#GST-TIME-ARGS:CAPS">GST_TIME_ARGS</a></span><span class="gtkdoc opt">(</span>ts<span class="gtkdoc opt">));</span></pre></td>
2450       </tr>
2451     </tbody>
2452   </table>
2453 </div>
2454
2455 <p>
2456 </p>
2457 </div>
2458 <hr>
2459 <div class="refsect2">
2460 <a name="GST-TIME-ARGS:CAPS"></a><h3>GST_TIME_ARGS()</h3>
2461 <pre class="programlisting">#define             GST_TIME_ARGS(t)</pre>
2462 <p>
2463 Format <em class="parameter"><code>t</code></em> for the <a class="link" href="gstreamer-GstInfo.html#GST-TIME-FORMAT:CAPS" title="GST_TIME_FORMAT"><span class="type">GST_TIME_FORMAT</span></a> format string. Note: <em class="parameter"><code>t</code></em> will be
2464 evaluated more than once.
2465 </p>
2466 <div class="variablelist"><table border="0">
2467 <col align="left" valign="top">
2468 <tbody><tr>
2469 <td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
2470 <td>a <a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a>
2471 </td>
2472 </tr></tbody>
2473 </table></div>
2474 </div>
2475 </div>
2476 <div class="refsect1">
2477 <a name="gstreamer-GstInfo.see-also"></a><h2>See Also</h2>
2478 <a class="link" href="gstreamer-gstconfig.html" title="gstconfig"><span class="type">gstreamer-gstconfig</span></a>, <a class="link" href="gstreamer-Gst.html" title="Gst"><span class="type">gstreamer-Gst</span></a> for command line parameters
2479 and environment variables that affect the debugging output.
2480 </div>
2481 </div>
2482 <div class="footer">
2483 <hr>
2484           Generated by GTK-Doc V1.18</div>
2485 </body>
2486 </html>