Debugging utilities

gst_debug_bin_to_dot_data

gchar *
gst_debug_bin_to_dot_data (GstBin * bin,
                           GstDebugGraphDetails details)

To aid debugging applications one can use this method to obtain the whole network of gstreamer elements that form the pipeline into a dot file.

See gst_debug_bin_to_dot_file for more details.

gst_debug_bin_to_dot_file

gst_debug_bin_to_dot_file (GstBin * bin,
                           GstDebugGraphDetails details,
                           const gchar * file_name)

To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file. This file can be processed with graphviz to get an image, like this:

dot -Tpng -oimage.png graph_lowlevel.dot

There is also the interactive gst-dots-viewer tool, and xdot which allows you to view the dot file directly without converting it first.

If file_name is NULL, the output filename will be based on the application name as returned by g_get_application_name, or "unnamed" if the application name cannot be determined.

The file will be written to the directory specified by the GST_DEBUG_DUMP_DOT_DIR environment variable, and the .dot extension will be added. If GST_DEBUG_DUMP_DOT_DIR was not defined at the time gst_init was called, the file will not be generated. Note that the directory must already exist, it will not be created by this function.

gst_debug_bin_to_dot_data can be used if it is desired to generate the file even when GST_DEBUG_DUMP_DOT_DIR is not set.

gst_debug_bin_to_dot_file_with_ts

gst_debug_bin_to_dot_file_with_ts (GstBin * bin,
                                   GstDebugGraphDetails details,
                                   const gchar * file_name)

This works like gst_debug_bin_to_dot_file, but adds the current timestamp to the filename, so that it can be used to take multiple snapshots.

GST_DEBUG_BIN_TO_DOT_FILE

#define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) gst_debug_bin_to_dot_file (bin, details, file_name)

To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file.

The macro is only active if the GStreamer debugging subsystem is enabled (i.e., no use of meson setup -Dgst_debug=false)

See gst_debug_bin_to_dot_file for more details.

GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS

#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)

This works like GST_DEBUG_BIN_TO_DOT_FILE, but adds the current timestamp to the filename, so that it can be used to take multiple snapshots.

GstDebugGraphDetails

Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS.