Functions
	clean_property_name (str name)
	make_element_with_src (Gst.Pipeline pipeline, Union[Gst.Element, Gst.Pad] src, str elem_type_name, **properties)

Variables
tuple	PROPERTY_BUILTIN_NAMES = ('async')
	Pipeline = Gst.Pipeline
	Element = Gst.Element
	Caps = Gst.Caps
	GValueArray = Gst.ValueArray
	ValueArray = GObject.ValueArray
	Segment = ligo.segments.segment
	TimeGPS = LIGOTimeGPS

Detailed Description

Utilities for constructing pipeline elements

Function Documentation

◆ clean_property_name()

clean_property_name ( str name )

Utility function for cleaning a property name, handles two cases:

        1. Underscores to hyphens: property_name -> property-name
        2. Removes trailing underscores originally used to avoid collisions with builtin: math_ -> math.
            The specific list of builtin collisions detected is defined in PROPERTY_BUILTIN_NAMES

    Args:
        name:
            str, the python property name

    Returns:
        str, the formatted gstreamer compatible element property name

Definition at line 33 of file pipetools.py.

◆ make_element_with_src()

make_element_with_src	(	Gst.Pipeline	pipeline,
		Union[Gst.Element, Gst.Pad]	src,
		str	elem_type_name,
		**	properties )

Create a new element of the type defined by the given element factory. If name is None, then the
    element will receive a guaranteed unique name, consisting of the element factory name and a number.
    If name is given, it will be given the name supplied.

    Args:
        pipeline:
            Pipeline, the existing pipeline to which the new element will be added
        src:
            Element or Pad, the element or pad to use as a source for the new element
        elem_type_name:
            str or None, name of new element, or None to automatically create a unique name
        **properties:
            dict, keyword arguments to be set as properties on the new element

    References:
        [1] https://lazka.github.io/pgi-docs/Gst-1.0/classes/ElementFactory.html#Gst.ElementFactory.make

    Raises:
        RuntimeError:
            If any problem occurs creating the element.

    Returns:
        Element, the new element

Definition at line 52 of file pipetools.py.

Variable Documentation

◆ Caps

python.pipeparts.pipetools.Caps = Gst.Caps

Definition at line 26 of file pipetools.py.

◆ Element

python.pipeparts.pipetools.Element = Gst.Element

Definition at line 25 of file pipetools.py.

◆ GValueArray

python.pipeparts.pipetools.GValueArray = Gst.ValueArray

Definition at line 27 of file pipetools.py.

◆ Pipeline

python.pipeparts.pipetools.Pipeline = Gst.Pipeline

Definition at line 24 of file pipetools.py.

◆ PROPERTY_BUILTIN_NAMES

tuple python.pipeparts.pipetools.PROPERTY_BUILTIN_NAMES = ('async')

Definition at line 21 of file pipetools.py.

◆ Segment

python.pipeparts.pipetools.Segment = ligo.segments.segment

Definition at line 29 of file pipetools.py.

◆ TimeGPS

python.pipeparts.pipetools.TimeGPS = LIGOTimeGPS

Definition at line 30 of file pipetools.py.

◆ ValueArray

python.pipeparts.pipetools.ValueArray = GObject.ValueArray

Definition at line 28 of file pipetools.py.

Functions

Variables