Classes
class	AppSync
class	ConnectAppsinkDumpDot

Functions
	framecpp_filesink_ldas_path_handler (pipetools.Element elem, pspec, Tuple[str, int] path_digits)
	framecpp_filesink_cache_entry_from_mfs_message (message)
pipetools.Element	multi_file (pipetools.Pipeline pipeline, pipetools.Element src, int next_file=0, bool sync=False, bool async_=False, **properties)
	Adds a multifilesink element to a pipeline with useful default properties.
pipetools.Element	gwf (pipetools.Pipeline pipeline, pipetools.Element src, bool message_forward=True, **properties)
pipetools.Element	fake (pipetools.Pipeline pipeline, pipetools.Element src)
	Adds a fakesink element to a pipeline with useful default properties.
pipetools.Element	file (pipetools.Pipeline pipeline, pipetools.Element src, str filename, bool sync=False, bool async_=False)
	Adds a filesink element to a pipeline with useful default properties.
pipetools.Element	tsv (pipetools.Pipeline pipeline, pipetools.Element src, str filename, pipetools.Segment segment=None)
	Adds a lal_nxydump element to a pipeline with useful default properties.
	ogm_video (pipetools.Pipeline pipeline, pipetools.Element videosrc, str filename, pipetools.Element audiosrc=None, bool verbose=False)
pipetools.Element	auto_video (pipetools.Pipeline pipeline, pipetools.Element src)
pipetools.Element	auto_audio (pipetools.Pipeline pipeline, pipetools.Element src)
	Adds a autoaudiosink element to a pipeline with useful default properties.
pipetools.Element	playback (pipetools.Pipeline pipeline, pipetools.Element src, float amplification=0.1)
pipetools.Element	tsv_tee (pipetools.Pipeline pipeline, pipetools.Element src, args, *properties)
	trigger_xml_writer (pipetools.Pipeline pipeline, pipetools.Element src, str filename)
	app (pipetools.Pipeline pipeline, pipetools.Element src, int max_buffers=1, bool drop=False, bool sync=False, bool async_=False, **properties)
	Adds a appsink element to a pipeline with useful default properties.
pipetools.Element	tcp_server (pipetools.Pipeline pipeline, pipetools.Element src, **properties)

Variables
str	BYTE_ORDER = "little" else 'BE'

Detailed Description

"Module for producing sink elements

Function Documentation

◆ app()

app	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		int	max_buffers = 1,
		bool	drop = False,
		bool	sync = False,
		bool	async_ = False,
		**	properties )

Adds a appsink element to a pipeline with useful default properties.

Create an app sink, Appsink is a sink plugin that supports many different methods for making the
    application get a handle on the GStreamer data in a pipeline. Unlike most GStreamer elements,
    Appsink provides external API functions.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        max_buffers:
            int, default 1
        drop:
            bool, default False
        sync:
            bool, default False
        async_:
            bool, default False
        **properties:

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

    Returns:
        Element

Definition at line 343 of file sink.py.

◆ auto_audio()

pipetools.Element auto_audio	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src )

Adds a autoaudiosink element to a pipeline with useful default properties.

Create an audio sink that automatically detects an appropriate audio sink to use. It does so by
    scanning the registry for all elements that have "Sink" and "Audio" in the class field of their element
    information, and also have a non-zero autoplugging rank.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element

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

    Returns:
        Element

Definition at line 252 of file sink.py.

◆ auto_video()

pipetools.Element auto_video	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src )

Create a video sink that automatically detects an appropriate video sink to use. It does so by scanning the
    registry for all elements that have "Sink" and "Video" in the class field of their element information, and
    also have a non-zero autoplugging rank.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element

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

    Returns:
        Element

Definition at line 231 of file sink.py.

◆ fake()

pipetools.Element fake	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src )

Adds a fakesink element to a pipeline with useful default properties.

Create a fake sink element

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element

    Returns:
        Element

Definition at line 135 of file sink.py.

◆ file()

pipetools.Element file	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		str	filename,
		bool	sync = False,
		bool	async_ = False )

Adds a filesink element to a pipeline with useful default properties.

Add file sink to pipeline

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        filename:
            str, the name of the output file
        sync:
            bool, default False
        async_:
            bool, default False

    Returns:
        Element

Definition at line 151 of file sink.py.

◆ framecpp_filesink_cache_entry_from_mfs_message()

framecpp_filesink_cache_entry_from_mfs_message ( message )

Translate an element message posted by the multifilesink element
    inside a framecpp_filesink bin into a lal.utils.CacheEntry object
    describing the file being written by the multifilesink element.

Definition at line 65 of file sink.py.

◆ framecpp_filesink_ldas_path_handler()

framecpp_filesink_ldas_path_handler	(	pipetools.Element	elem,
			pspec,
		Tuple[str, int]	path_digits )

Add path for file sink to element

    Args:
        elem:
            Element, the element to which to add a filesink path property
        pspec:
            Unknown
        path_digits:
            Tuple[str, int], a string outpath and a directory digits int

    Examples:
        >>> filesinkelem.connect("notify::timestamp", framecpp_filesink_ldas_path_handler, (".", 5))

    Returns:
        Element, with the formatted outpath attached as the "path" property

Definition at line 29 of file sink.py.

◆ gwf()

pipetools.Element gwf	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		bool	message_forward = True,
		**	properties )

Add a framecpp file sink element to pipeline, that will write out a GWF file

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        message_forward:
            bool, default True
        **properties:

    References:
        Implementation: gstlal-ugly/gst/framecpp/framecpp_filesink.c

    Returns:
        Element

Definition at line 107 of file sink.py.

◆ multi_file()

pipetools.Element multi_file	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		int	next_file = 0,
		bool	sync = False,
		bool	async_ = False,
		**	properties )

Adds a multifilesink element to a pipeline with useful default properties.

Adds a sink element to a pipeline with useful default properties

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        next_file:
            int, default 0
        sync:
            bool, default False
        async_:
            bool, default False
        **properties:

    Returns:
        Element

Definition at line 84 of file sink.py.

◆ ogm_video()

ogm_video	(	pipetools.Pipeline	pipeline,
		pipetools.Element	videosrc,
		str	filename,
		pipetools.Element	audiosrc = None,
		bool	verbose = False )

Make a ogm video sink element

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        videosrc:
            Gst.Element, the video source element
        filename:
            str, the name of the output video file
        audiosrc:
            Gst.Element, default None, the audio source element
        verbose:
            bool, default False

    Returns:
        Element, the sink element

Definition at line 198 of file sink.py.

◆ playback()

pipetools.Element playback	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		float	amplification = 0.1 )

Create a playback pipeline and add it to existing pipeline

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        amplification:
            float, default 0.1

    Returns:
        Element

Definition at line 272 of file sink.py.

◆ tcp_server()

pipetools.Element tcp_server	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		**	properties )

Create a sink via TCP server

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        **properties:

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

    Returns:
        Element

Definition at line 493 of file sink.py.

◆ trigger_xml_writer()

trigger_xml_writer	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		str	filename )

Write xml file

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        filename:
            str, output path for xml file

    References:
        Implementation

    Returns:
        Element

Definition at line 320 of file sink.py.

◆ tsv()

pipetools.Element tsv	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		str	filename,
		pipetools.Segment	segment = None )

Adds a lal_nxydump element to a pipeline with useful default properties.

Converts audio time-series to tab-separated ascii text, a format compatible with most plotting utilities.
    The output is multi-column tab-separated ASCII text.  The first column is the time, the remaining columns are
    the values of the channels in order.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        filename:
            str, the filename of the output text file
        segment:
            Segment, default None, a ligo.segments.segment

    Returns:
        Element

Definition at line 173 of file sink.py.

◆ tsv_tee()

pipetools.Element tsv_tee	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		*	args,
		**	properties )

Split data from source to an nxy dump

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        *args:
        **properties:

    Returns:
        Element

Definition at line 301 of file sink.py.

Variable Documentation

◆ BYTE_ORDER

str python.pipeparts.sink.BYTE_ORDER = "little" else 'BE'

Definition at line 26 of file sink.py.

Classes

Functions

Variables