python.pipeparts.mux Namespace Reference

Classes
class	FrameCPPChannelDemuxSetUnitsHandler
class	FrameCPPChannelDemuxCheckSegmentsHandler

Functions
	framecpp_channel_demux (pipeline, src, **properties)
	framecpp_channel_mux (pipeline, channel_src_map, units=None, seglists=None, **properties)
	framecpp_channel_mux_from_list (pipeline, *srcs, channels=None, **properties)
	ogg_mux (pipeline, src)
	avi_mux (pipeline, src)

Detailed Description

Module for multiplexing (mux) and demultiplexing (demux) elements

Function Documentation

avi_mux()

avi_mux	(		pipeline,
			src )

Muxes raw or compressed audio and/or video streams into an AVI file.

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

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

    Returns:
        Element, the source merged as avi

Definition at line 241 of file mux.py.

framecpp_channel_demux()

framecpp_channel_demux	(		pipeline,
			src,
		**	properties )

Demux src using framecpp

    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] framecppdemux implementation: gstlal/gstlal-ugly/gst/framecpp/framecpp_channeldemux.cc

    Returns:
        Element, src demuxed using framecpp

Definition at line 140 of file mux.py.

framecpp_channel_mux()

framecpp_channel_mux	(		pipeline,
			channel_src_map,
			units = None,
			seglists = None,
		**	properties )

Mux a source using framecpp

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        channel_src_map:
            dict, mapping a channel -> src element
        units:
            str, default None, if given set these units on source
        seglists:
            default None, if given create a segments handler for these segments
        **properties:

    Returns:
        Element, the muxed sources

Definition at line 160 of file mux.py.

framecpp_channel_mux_from_list()

framecpp_channel_mux_from_list	(		pipeline,
		*	srcs,
			channels = None,
		**	properties )

Mux a source using framecpp

    NOTE: This acts similarly to framecpp_channel_mux with a different function
    signature to map channels to sources.

    Args:
        pipeline:
            Gst.Pipeline, the pipeline to which the new element will be added
        *srcs:
            Gst.Element, the source elements
        channels:
            Union[str, Iterable], default None, the channels mapping to sources
        seglists:
            default None, if given create a segments handler for these segments
        **properties:

    Returns:
        Element, the muxed sources

Definition at line 197 of file mux.py.

ogg_mux()

ogg_mux	(		pipeline,
			src )

This element merges streams (audio and video) into ogg files.

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

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

    Returns:
        Element, the source merged as ogg format

Definition at line 223 of file mux.py.