Functions
pipetools.Element	wav (pipetools.Pipeline pipeline, pipetools.Element src)
	Adds a wavenc element to a pipeline with useful default properties.
pipetools.Element	vorbis (pipetools.Pipeline pipeline, pipetools.Element src)
	Adds a vorbisenc element to a pipeline with useful default properties.
pipetools.Element	theora (pipetools.Pipeline pipeline, pipetools.Element src, **dict properties)
	flac (pipetools.Pipeline pipeline, pipetools.Element src, quality=0, **properties)
	Adds a flacenc element to a pipeline with useful default properties.
pipetools.Element	igwd_parse (pipetools.Pipeline pipeline, pipetools.Element src, **properties)
pipetools.Element	tsv (pipetools.Pipeline pipeline, pipetools.Element src, pipetools.Segment segment=None)
	Adds a lal_nxydump element to a pipeline with useful default properties.
pipetools.Element	uri_decode_bin (pipetools.Pipeline pipeline, str uri, pipetools.Caps caps="application/x-igwd-frame,framed=true", **properties)
	Adds a uridecodebin element to a pipeline with useful default properties.

Detailed Description

Module for encoding elements

Function Documentation

◆ flac()

flac	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
			quality = 0,
		**	properties )

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

Encoded sources as FLAC streams. FLAC is a Free Lossless Audio Codec.
    FLAC audio can directly be written into a file, or embedded into containers such as oggmux or matroskamux.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        src:
            Gst.Element, the source element
        quality:
            int
        **properties:
            dict, keyword arguments to be set as element properties

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

    Returns:
        Element, the source encoded as a FLAC stream

Definition at line 68 of file encode.py.

◆ igwd_parse()

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

Parse byte streams into whole IGWD frame files (https://dcc.ligo.org/cgi-bin/DocDB/ShowDocument?docid=329)

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

    References:
        Implementation gstlal/gstlal-ugly/gst/framecpp/framecpp_igwdparse.cc

    Returns:
        Element

Definition at line 91 of file encode.py.

◆ theora()

pipetools.Element theora	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		**dict	properties )

This element encodes raw video into a Theora stream

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

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

    Returns:
        Element, the source encoded as a Theora stream

Definition at line 47 of file encode.py.

◆ tsv()

pipetools.Element tsv	(	pipetools.Pipeline	pipeline,
		pipetools.Element	src,
		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
        segment:
            Segment, default None, a ligo.segments.segment

    Returns:
        Element

Definition at line 111 of file encode.py.

◆ uri_decode_bin()

pipetools.Element uri_decode_bin	(	pipetools.Pipeline	pipeline,
		str	uri,
		pipetools.Caps	caps = "application/x-igwd-frame,framed=true",
		**	properties )

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

Decodes data from a URI into raw media. It selects a source element that can handle the
    given scheme and connects it to a decodebin.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        uri:
            str, URI to decode
        caps:
            Gst.Caps, The caps on which to stop decoding. (NULL = default)
        **properties:

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

    Returns:
        Element

Definition at line 134 of file encode.py.

◆ vorbis()

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

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

This element encodes raw float audio into a Vorbis stream

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

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

    Returns:
        Element, the source encoded as a Vorbis stream

Definition at line 29 of file encode.py.

◆ wav()

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

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

Format source into the wav format

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


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

    Returns:
        Element, the src encoded as wav format

Definition at line 9 of file encode.py.

Functions