gstreamer/docs/plugins/gst-plugins-base-plugins-docs.sgml
William Manley 7c10499ecd tcp: Add element socketsrc
`socketsrc` can be considered a source counterpart to `multisocketsink`.
It can be considered a generalization of `tcpclientsrc` and
`tcpserversrc`:  it contains all the logic required to communicate over
the socket but none of the logic for creating the sockets/establishing
the connection in the first place, allowing the user to accomplish this
externally in whatever manner they wish making it applicable to other
types of sockets besides TCP.

This commit essentially copies the implementation directly from
tcpserversrc.  Later patches will tidy the implementation up and
re-implement `tcpclientsrc` and `tcpserversrc` in terms of `socketsrc`.

See https://bugzilla.gnome.org/show_bug.cgi?id=739546
2015-03-13 20:05:00 +01:00

100 lines
4.7 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>GStreamer Base Plugins &GST_API_VERSION; Plugins Reference Manual</title>
<releaseinfo>
for GStreamer Base Plugins &GST_API_VERSION; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/</ulink>.
</releaseinfo>
</bookinfo>
<chapter>
<title>gst-plugins-base Elements</title>
<xi:include href="xml/element-adder.xml" />
<xi:include href="xml/element-appsrc.xml" />
<xi:include href="xml/element-appsink.xml" />
<xi:include href="xml/element-alsasink.xml" />
<xi:include href="xml/element-alsasrc.xml" />
<xi:include href="xml/element-audioconvert.xml" />
<xi:include href="xml/element-audiorate.xml" />
<xi:include href="xml/element-audioresample.xml" />
<xi:include href="xml/element-audiotestsrc.xml" />
<xi:include href="xml/element-cdparanoiasrc.xml" />
<xi:include href="xml/element-clockoverlay.xml" />
<xi:include href="xml/element-decodebin.xml" />
<xi:include href="xml/element-encodebin.xml" />
<xi:include href="xml/element-videoconvert.xml" />
<xi:include href="xml/element-giosink.xml" />
<xi:include href="xml/element-giosrc.xml" />
<xi:include href="xml/element-giostreamsink.xml" />
<xi:include href="xml/element-giostreamsrc.xml" />
<xi:include href="xml/element-multifdsink.xml" />
<xi:include href="xml/element-multisocketsink.xml" />
<xi:include href="xml/element-oggdemux.xml" />
<xi:include href="xml/element-oggmux.xml" />
<xi:include href="xml/element-playbin.xml" />
<xi:include href="xml/element-playsink.xml" />
<xi:include href="xml/element-streamsynchronizer.xml" />
<xi:include href="xml/element-subtitleoverlay.xml" />
<xi:include href="xml/element-socketsrc.xml" />
<xi:include href="xml/element-tcpclientsrc.xml" />
<xi:include href="xml/element-tcpclientsink.xml" />
<xi:include href="xml/element-tcpserversrc.xml" />
<xi:include href="xml/element-tcpserversink.xml" />
<xi:include href="xml/element-textoverlay.xml" />
<xi:include href="xml/element-textrender.xml" />
<xi:include href="xml/element-theoradec.xml" />
<xi:include href="xml/element-theoraenc.xml" />
<xi:include href="xml/element-theoraparse.xml" />
<xi:include href="xml/element-timeoverlay.xml" />
<xi:include href="xml/element-uridecodebin.xml" />
<xi:include href="xml/element-videorate.xml" />
<xi:include href="xml/element-videoscale.xml" />
<xi:include href="xml/element-videotestsrc.xml" />
<xi:include href="xml/element-volume.xml" />
<xi:include href="xml/element-vorbisdec.xml" />
<xi:include href="xml/element-vorbisenc.xml" />
<xi:include href="xml/element-vorbisparse.xml" />
<xi:include href="xml/element-vorbistag.xml" />
<xi:include href="xml/element-ximagesink.xml" />
<xi:include href="xml/element-xvimagesink.xml" />
</chapter>
<chapter>
<title>gst-plugins-base Plugins</title>
<xi:include href="xml/plugin-adder.xml" />
<xi:include href="xml/plugin-alsa.xml" />
<xi:include href="xml/plugin-app.xml" />
<xi:include href="xml/plugin-audioconvert.xml" />
<xi:include href="xml/plugin-audiorate.xml" />
<xi:include href="xml/plugin-audioresample.xml" />
<xi:include href="xml/plugin-audiotestsrc.xml" />
<xi:include href="xml/plugin-cdparanoia.xml" />
<xi:include href="xml/plugin-encoding.xml" />
<xi:include href="xml/plugin-videoconvert.xml" />
<xi:include href="xml/plugin-gio.xml" />
<xi:include href="xml/plugin-libvisual.xml" />
<xi:include href="xml/plugin-ogg.xml" />
<xi:include href="xml/plugin-pango.xml" />
<xi:include href="xml/plugin-playback.xml" />
<xi:include href="xml/plugin-subparse.xml" />
<xi:include href="xml/plugin-tcp.xml" />
<xi:include href="xml/plugin-theora.xml" />
<xi:include href="xml/plugin-typefindfunctions.xml" />
<xi:include href="xml/plugin-videorate.xml" />
<xi:include href="xml/plugin-videoscale.xml" />
<xi:include href="xml/plugin-videotestsrc.xml" />
<xi:include href="xml/plugin-volume.xml" />
<xi:include href="xml/plugin-vorbis.xml" />
<xi:include href="xml/plugin-ximagesink.xml" />
<xi:include href="xml/plugin-xvimagesink.xml" />
</chapter>
</book>