diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/plugins/Makefile.am | 1 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-docs.sgml | 5 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-bad-plugins-sections.txt | 40 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-bad-plugins.args | 300 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-bad-plugins.hierarchy | 2 | ||||
-rw-r--r-- | docs/plugins/gst-plugins-bad-plugins.interfaces | 2 | ||||
-rw-r--r-- | docs/plugins/inspect/plugin-rist.xml | 85 |
7 files changed, 435 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index ab659a559..f866146e5 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -152,6 +152,7 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/pcapparse/gstpcapparse.h \ $(top_srcdir)/gst/rawparse/gstaudioparse.h \ $(top_srcdir)/gst/rawparse/gstvideoparse.h \ + $(top_srcdir)/gst/rist/gstrist.h \ $(top_srcdir)/gst/sdp/gstsdpdemux.h \ $(top_srcdir)/gst/speed/gstspeed.h \ $(top_srcdir)/gst/videosignal/gstvideoanalyse.h \ diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index a83aa0e87..b94f4c1a8 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -196,6 +196,10 @@ <xi:include href="xml/element-rfbsrc.xml" /> <xi:include href="xml/element-rgb2bayer.xml" /> <xi:include href="xml/element-rotate.xml" /> + <xi:include href="xml/element-ristrtxreceive.xml" /> + <xi:include href="xml/element-ristrtxsend.xml" /> + <xi:include href="xml/element-ristsink.xml" /> + <xi:include href="xml/element-ristsrc.xml" /> <xi:include href="xml/element-rsndvdbin.xml" /> <xi:include href="xml/element-rsvgdec.xml" /> <xi:include href="xml/element-rsvgoverlay.xml" /> @@ -371,6 +375,7 @@ <xi:include href="xml/plugin-proxy.xml" /> <xi:include href="xml/plugin-removesilence.xml" /> <xi:include href="xml/plugin-resindvd.xml" /> + <xi:include href="xml/plugin-rist.xml" /> <xi:include href="xml/plugin-rfbsrc.xml" /> <xi:include href="xml/plugin-rsvg.xml" /> <xi:include href="xml/plugin-rtmp.xml" /> diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 5b45ec401..2e0128253 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -2894,6 +2894,46 @@ gst_rfb_src_get_type </SECTION> <SECTION> +<FILE>element-ristsink</FILE> +<TITLE>ristsink</TITLE> +GstRistSink +<SUBSECTION Standard> +GstRistSinkClass +<SUBSECTION Private> +gst_rist_sink_get_type +</SECTION> + +<SECTION> +<FILE>element-ristsrc</FILE> +<TITLE>ristsrc</TITLE> +GstRistSrc +<SUBSECTION Standard> +GstRistSrcClass +<SUBSECTION Private> +gst_rist_src_get_type +</SECTION> + +<SECTION> +<FILE>element-ristrtxreceive</FILE> +<TITLE>ristrtxreceive</TITLE> +GstRistRtxReceive +<SUBSECTION Standard> +GstRistRtxReceiveClass +<SUBSECTION Private> +gst_rist_rtx_receive_get_type +</SECTION> + +<SECTION> +<FILE>element-ristrtxsend</FILE> +<TITLE>ristrtxsend</TITLE> +GstRistRtxSend +<SUBSECTION Standard> +GstRistRtxSendClass +<SUBSECTION Private> +gst_rist_rtx_send_get_type +</SECTION> + +<SECTION> <FILE>element-rotate</FILE> <TITLE>rotate</TITLE> GstRotate diff --git a/docs/plugins/gst-plugins-bad-plugins.args b/docs/plugins/gst-plugins-bad-plugins.args index bebec988d..f3c52ff21 100644 --- a/docs/plugins/gst-plugins-bad-plugins.args +++ b/docs/plugins/gst-plugins-bad-plugins.args @@ -73842,3 +73842,303 @@ this will override closed caption stream specified font style/pen size.</BLURB> <DEFAULT>1</DEFAULT> </ARG> +<ARG> +<NAME>GstRistSrc::address</NAME> +<TYPE>gchar*</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>Address</NICK> +<BLURB>Address to receive packets from (can be IPv4 or IPv6).</BLURB> +<DEFAULT>"0.0.0.0"</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::cname</NAME> +<TYPE>gchar*</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>CName</NICK> +<BLURB>Set the CNAME in the SDES block of the receiver report.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::max-rtcp-bandwidth</NAME> +<TYPE>gdouble</TYPE> +<RANGE>[0,0.05]</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Maximum RTCP Bandwidth</NICK> +<BLURB>The maximum bandwidth used for RTCP in fraction of RTP bandwdith.</BLURB> +<DEFAULT>0.05</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::max-rtx-retries</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Maximum Retransmission Retries</NICK> +<BLURB>The maximum number of retransmission requests for a lost packet.</BLURB> +<DEFAULT>7</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::min-rtcp-interval</NAME> +<TYPE>guint</TYPE> +<RANGE><= 100</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Minimum RTCP Intercal</NICK> +<BLURB>The minimum interval in ms between two successive RTCP packets.</BLURB> +<DEFAULT>100</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::multicast-iface</NAME> +<TYPE>gchar*</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>multicast-iface</NICK> +<BLURB>The multicast interface to use to send packets.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::multicast-loopback</NAME> +<TYPE>gboolean</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Multicast Loopback</NICK> +<BLURB>When enabled, the packet will be received locally.</BLURB> +<DEFAULT>FALSE</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::multicast-ttl</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,255]</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Multicast TTL</NICK> +<BLURB>The multicast time-to-live parameter.</BLURB> +<DEFAULT>1</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::port</NAME> +<TYPE>guint</TYPE> +<RANGE>[2,65534]</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Port</NICK> +<BLURB>The port to listen for RTP packets, RTCP port is derived from it, this port must be an even number.</BLURB> +<DEFAULT>5004</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::receiver-buffer</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Receiver Buffer</NICK> +<BLURB>Buffering duration in ms.</BLURB> +<DEFAULT>1000</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::reorder-section</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Recorder Section</NICK> +<BLURB>Time to wait before sending retransmission request in ms.</BLURB> +<DEFAULT>70</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::stats</NAME> +<TYPE>GstStructure*</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Statistics</NICK> +<BLURB>Statistic in a GstStructure named 'rist/x-receiver-stats'.</BLURB> +<DEFAULT></DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSrc::stats-update-interval</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Statistics Update Interval</NICK> +<BLURB>The interval between 'stats' update notification (0 disabled).</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::address</NAME> +<TYPE>gchar*</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>Address</NICK> +<BLURB>Address to send packets to (can be IPv4 or IPv6).</BLURB> +<DEFAULT>"0.0.0.0"</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::cname</NAME> +<TYPE>gchar*</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>CName</NICK> +<BLURB>Set the CNAME in the SDES block of the sender report.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::max-rtcp-bandwidth</NAME> +<TYPE>gdouble</TYPE> +<RANGE>[0,0.05]</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Maximum RTCP Bandwidth</NICK> +<BLURB>The maximum bandwidth used for RTCP in fraction of RTP bandwdith.</BLURB> +<DEFAULT>0.05</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::min-rtcp-interval</NAME> +<TYPE>guint</TYPE> +<RANGE><= 100</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Minimum RTCP Intercal</NICK> +<BLURB>The minimum interval in ms between two regular successive RTCP packets.</BLURB> +<DEFAULT>100</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::multicast-iface</NAME> +<TYPE>gchar*</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>multicast-iface</NICK> +<BLURB>The multicast interface to use to send packets.</BLURB> +<DEFAULT>NULL</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::multicast-loopback</NAME> +<TYPE>gboolean</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Multicast Loopback</NICK> +<BLURB>When enabled, the packet will be received locally.</BLURB> +<DEFAULT>FALSE</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::multicast-ttl</NAME> +<TYPE>gint</TYPE> +<RANGE>[0,255]</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Multicast TTL</NICK> +<BLURB>The multicast time-to-live parameter.</BLURB> +<DEFAULT>1</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::port</NAME> +<TYPE>guint</TYPE> +<RANGE>[2,65534]</RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Port</NICK> +<BLURB>The port RTP packets will be sent, RTCP port is derived from it, this port must be an even number.</BLURB> +<DEFAULT>5004</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::sender-buffer</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Sender Buffer</NICK> +<BLURB>Size of the retransmission queue in ms.</BLURB> +<DEFAULT>1200</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::stats</NAME> +<TYPE>GstStructure*</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Statistics</NICK> +<BLURB>Statistic in a GstStructure named 'rist/x-sender-stats'.</BLURB> +<DEFAULT></DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistSink::stats-update-interval</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rwx</FLAGS> +<NICK>Statistics Update Interval</NICK> +<BLURB>The interval between 'stats' update notification (0 disabled).</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistRtxSend::max-size-packets</NAME> +<TYPE>guint</TYPE> +<RANGE><= 32767</RANGE> +<FLAGS>rw</FLAGS> +<NICK>Max Size Packets</NICK> +<BLURB>Amount of packets to queue (0 = unlimited).</BLURB> +<DEFAULT>100</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistRtxSend::max-size-time</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>rw</FLAGS> +<NICK>Max Size Time</NICK> +<BLURB>Amount of ms to queue (0 = unlimited).</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistRtxSend::num-rtx-packets</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Num RTX Packets</NICK> +<BLURB> Number of retransmission packets sent.</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistRtxSend::num-rtx-requests</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Num RTX Requests</NICK> +<BLURB>Number of retransmission events received.</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistRtxReceive::num-rtx-packets</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Num RTX Packets</NICK> +<BLURB> Number of retransmission packets received.</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + +<ARG> +<NAME>GstRistRtxReceive::num-rtx-requests</NAME> +<TYPE>guint</TYPE> +<RANGE></RANGE> +<FLAGS>r</FLAGS> +<NICK>Num RTX Requests</NICK> +<BLURB>Number of retransmission events received.</BLURB> +<DEFAULT>0</DEFAULT> +</ARG> + diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy index 56caed709..352d0cdab 100644 --- a/docs/plugins/gst-plugins-bad-plugins.hierarchy +++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy @@ -235,6 +235,8 @@ GObject GstCameraBin GstIpcSlavePipeline GstProxySrc + GstRistSink + GstRistSrc GstSDPDemux GstSdpSrc GstTestSrcBin diff --git a/docs/plugins/gst-plugins-bad-plugins.interfaces b/docs/plugins/gst-plugins-bad-plugins.interfaces index 87db20879..1d54590c0 100644 --- a/docs/plugins/gst-plugins-bad-plugins.interfaces +++ b/docs/plugins/gst-plugins-bad-plugins.interfaces @@ -81,6 +81,8 @@ GstPnmenc GstPreset GstProxySrc GstChildProxy GstRTMPSink GstURIHandler GstRTMPSrc GstURIHandler +GstRistSink GstChildProxy +GstRistSrc GstChildProxy GstURIHandler GstSDLVideoSink GstImplementsInterface GstXOverlay GstNavigation GstSDPDemux GstChildProxy GstSRTSink GstURIHandler diff --git a/docs/plugins/inspect/plugin-rist.xml b/docs/plugins/inspect/plugin-rist.xml new file mode 100644 index 000000000..3a3168d26 --- /dev/null +++ b/docs/plugins/inspect/plugin-rist.xml @@ -0,0 +1,85 @@ +<plugin> + <name>rist</name> + <description>Source and Sink for RIST TR-06-1 streaming specification</description> + <filename>../../gst/rist/.libs/libgstrist.so</filename> + <basename>libgstrist.so</basename> + <version>1.15.2.1</version> + <license>LGPL</license> + <source>gst-plugins-bad</source> + <package>GStreamer Bad Plug-ins git</package> + <origin>Unknown package origin</origin> + <elements> + <element> + <name>ristrtxreceive</name> + <longname>RIST Retransmission receiver</longname> + <class>Codec</class> + <description>Receive retransmitted RIST packets according to VSF TR-06-1</description> + <author>Nicolas Dufresne <nicolas.dufresne@collabora.com></author> + <pads> + <caps> + <name>sink</name> + <direction>sink</direction> + <presence>always</presence> + <details>application/x-rtp</details> + </caps> + <caps> + <name>src</name> + <direction>source</direction> + <presence>always</presence> + <details>application/x-rtp</details> + </caps> + </pads> + </element> + <element> + <name>ristrtxsend</name> + <longname>RIST Retransmission Sender</longname> + <class>Codec</class> + <description>Retransmit RTP packets when needed, according to VSF TR-06-1</description> + <author>Nicolas Dufresne <nicolas.dufresne@collabora.com></author> + <pads> + <caps> + <name>sink</name> + <direction>sink</direction> + <presence>always</presence> + <details>application/x-rtp, clock-rate=(int)[ 1, 2147483647 ]</details> + </caps> + <caps> + <name>src</name> + <direction>source</direction> + <presence>always</presence> + <details>application/x-rtp</details> + </caps> + </pads> + </element> + <element> + <name>ristsink</name> + <longname>RIST Sink</longname> + <class>Source/Network</class> + <description>Sink that implements RIST TR-06-1 streaming specification</description> + <author>Nicolas Dufresne <nicolas.dufresne@collabora.com</author> + <pads> + <caps> + <name>sink</name> + <direction>sink</direction> + <presence>always</presence> + <details>application/x-rtp</details> + </caps> + </pads> + </element> + <element> + <name>ristsrc</name> + <longname>RIST Source</longname> + <class>Source/Network</class> + <description>Source that implements RIST TR-06-1 streaming specification</description> + <author>Nicolas Dufresne <nicolas.dufresne@collabora.com</author> + <pads> + <caps> + <name>src</name> + <direction>source</direction> + <presence>always</presence> + <details>application/x-rtp</details> + </caps> + </pads> + </element> + </elements> +</plugin>
\ No newline at end of file |