gstreamer_core/gst/gstdebugutils.h
changeset 16 8e837d1bf446
parent 0 0e761a78d257
child 30 7e817e7e631c
equal deleted inserted replaced
15:4b0c6ed43234 16:8e837d1bf446
    37  * @GST_DEBUG_GRAPH_SHOW_STATES: show element states
    37  * @GST_DEBUG_GRAPH_SHOW_STATES: show element states
    38  * @GST_DEBUG_GRAPH_SHOW_ALL: show all details
    38  * @GST_DEBUG_GRAPH_SHOW_ALL: show all details
    39  *
    39  *
    40  * Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()
    40  * Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()
    41  * and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().
    41  * and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().
       
    42  *
       
    43  * Since: 0.10.15
    42  */
    44  */
    43 typedef enum {
    45 typedef enum {
    44   GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE         = (1<<0),
    46   GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE         = (1<<0),
    45   GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS       = (1<<1),
    47   GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS       = (1<<1),
    46   GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS = (1<<2),
    48   GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS = (1<<2),
    65 void _gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);
    67 void _gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);
    66 
    68 
    67 /**
    69 /**
    68  * GST_DEBUG_BIN_TO_DOT_FILE:
    70  * GST_DEBUG_BIN_TO_DOT_FILE:
    69  * @bin: the top-level pipeline that should be analyzed
    71  * @bin: the top-level pipeline that should be analyzed
    70  * @details: graph-details to show
    72  * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
       
    73  *    one or more other #GstDebugGraphDetails flags.
    71  * @file_name: output base filename (e.g. "myplayer")
    74  * @file_name: output base filename (e.g. "myplayer")
    72  *
    75  *
    73  * To aid debugging applications one can use this method to write out the whole
    76  * To aid debugging applications one can use this method to write out the whole
    74  * network of gstreamer elements that form the pipeline into an dot file.
    77  * network of gstreamer elements that form the pipeline into an dot file.
    75  * This file can be processed with graphviz to get an image.
    78  * This file can be processed with graphviz to get an image.
    78  * </programlisting></informalexample>
    81  * </programlisting></informalexample>
    79  *
    82  *
    80  * The macro is only active if gstreamer is configured with
    83  * The macro is only active if gstreamer is configured with
    81  * &quot;--gst-enable-gst-debug&quot; and the environment variable
    84  * &quot;--gst-enable-gst-debug&quot; and the environment variable
    82  * GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).
    85  * GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).
       
    86  *
       
    87  * Since: 0.10.15
    83  */
    88  */
    84 #define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) _gst_debug_bin_to_dot_file (bin, details, file_name)
    89 #define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) _gst_debug_bin_to_dot_file (bin, details, file_name)
    85 
    90 
    86 /**
    91 /**
    87  * GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS:
    92  * GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS:
    88  * @bin: the top-level pipeline that should be analyzed
    93  * @bin: the top-level pipeline that should be analyzed
    89  * @details: graph-details to show
    94  * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
       
    95  *    one or more other #GstDebugGraphDetails flags.
    90  * @file_name: output base filename (e.g. "myplayer")
    96  * @file_name: output base filename (e.g. "myplayer")
    91  *
    97  *
    92  * This works like _gst_debug_bin_to_dot_file(), but adds the current timestamp
    98  * This works like _gst_debug_bin_to_dot_file(), but adds the current timestamp
    93  * to the filename, so that it can be used to take multiple snapshots.
    99  * to the filename, so that it can be used to take multiple snapshots.
       
   100  *
       
   101  * Since: 0.10.15
    94  */
   102  */
    95 #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)
   103 #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)
    96 
   104 
    97 
   105 
    98 #else /* GST_DISABLE_GST_DEBUG */
   106 #else /* GST_DISABLE_GST_DEBUG */