Functions
	to_file (pipetools.Pipeline pipeline, str filestem, bool verbose=False, bool use_str_method=False)
str	to_str (pipetools.Pipeline pipeline)

Variables
str	ENV_VAR_DUMP_DIR = 'GST_DEBUG_DUMP_DOT_DIR'

Detailed Description

Utilities for converting Gst pipelines into DOT graphs

Function Documentation

◆ to_file()

to_file	(	pipetools.Pipeline	pipeline,
		str	filestem,
		bool	verbose = False,
		bool	use_str_method = False )

Write a pipeline out to a dot file. This function needs the environment variable GST_DEBUG_DUMP_DOT_DIR
    to be set.

    Args:
        pipeline:
        filestem:
            str, name of file (not including extension)
        verbose:
            bool, default False, if True a message will be written to stderr.
        use_str_method:
            bool, default False, if True use the "to_str" method as an intermediate step. This is enabled due to
            some bugs in Gst where no files are written out using the direct "debug_bin_to_dot_file".

    Notes:
        File Output:
            The filename will be os.path.join($GST_DEBUG_DUMP_DOT_DIR, filestem + ".dot")

    Raises:
        ValueError:
            If "GST_DEBUG_DUMP_DOT_DIR" env var not defined

    References:
        [1] https://lazka.github.io/pgi-docs/Gst-1.0/functions.html#Gst.debug_bin_to_dot_file

    Returns:
        None

Definition at line 21 of file pipedot.py.

◆ to_str()

str to_str ( pipetools.Pipeline pipeline )

Convert a pipeline to a DOT-formatted string directly (no out file intermediary)

    Args:
        pipeline:
            Pipeline, the pipeline to convert to DOT string

    References:
        [1] https://gstreamer.freedesktop.org/documentation/gstreamer/debugutils.html?gi-language=python

    Returns:
        str, the pipeline converted to DOT formatted string

Definition at line 64 of file pipedot.py.

Variable Documentation

◆ ENV_VAR_DUMP_DIR

str python.pipeparts.pipedot.ENV_VAR_DUMP_DIR = 'GST_DEBUG_DUMP_DOT_DIR'

Definition at line 18 of file pipedot.py.