Release 1.12.2
[platform/upstream/gst-plugins-good.git] / docs / plugins / gst-plugins-good-plugins.args
index 28c1859..2542efc 100644 (file)
 <RANGE></RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Multicast Interface</NICK>
-<BLURB>The network interface on which to join the multicast group.</BLURB>
+<BLURB>The network interface on which to join the multicast group.This allows multiple interfaces seperated by comma. ("eth0,eth1").</BLURB>
 <DEFAULT>NULL</DEFAULT>
 </ARG>
 
 <FLAGS>rw</FLAGS>
 <NICK>User Agent</NICK>
 <BLURB>The User-Agent string to send to the server.</BLURB>
-<DEFAULT>"GStreamer/1.9.2"</DEFAULT>
+<DEFAULT>"GStreamer/1.12.2"</DEFAULT>
 </ARG>
 
 <ARG>
 <FLAGS>rw</FLAGS>
 <NICK>User-Agent</NICK>
 <BLURB>Value of the User-Agent HTTP request header field.</BLURB>
-<DEFAULT>"GStreamer souphttpsrc "</DEFAULT>
+<DEFAULT>"GStreamer souphttpsrc 1.12.2 "</DEFAULT>
 </ARG>
 
 <ARG>
 <FLAGS>rw</FLAGS>
 <NICK>Client Name</NICK>
 <BLURB>The PulseAudio client name to use.</BLURB>
-<DEFAULT>"lt-gst-plugins-good-plugins-scan"</DEFAULT>
+<DEFAULT>"gst-plugins-good-plugins-scan"</DEFAULT>
 </ARG>
 
 <ARG>
 <FLAGS>rw</FLAGS>
 <NICK>Client Name</NICK>
 <BLURB>The PulseAudio client_name_to_use.</BLURB>
-<DEFAULT>"lt-gst-plugins-good-plugins-scan"</DEFAULT>
+<DEFAULT>"gst-plugins-good-plugins-scan"</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>GstAudioEcho::surround-delay</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Enable Surround Delay</NICK>
+<BLURB>Delay Surround Channels when TRUE instead of applying an echo effect.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioEcho::surround-mask</NAME>
+<TYPE>guint64</TYPE>
+<RANGE>>= 1</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Surround Mask</NICK>
+<BLURB>A bitmask of channels that are considered surround and delayed when surround-delay = TRUE.</BLURB>
+<DEFAULT>18446744073709551612</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstAspectRatioCrop::aspect-ratio</NAME>
 <TYPE>GstFraction</TYPE>
 <RANGE></RANGE>
 <RANGE>>= G_MAXULONG</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>RTX Delay Reorder</NICK>
-<BLURB>Sending retransmission event when this much reordering (-1 automatic).</BLURB>
+<BLURB>Sending retransmission event when this much reordering (0 disable, -1 automatic).</BLURB>
 <DEFAULT>3</DEFAULT>
 </ARG>
 
 </ARG>
 
 <ARG>
+<NAME>GstRtpJitterBuffer::rtx-deadline</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= G_MAXULONG</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>RTX Deadline (ms)</NICK>
+<BLURB>The deadline for a valid RTX request in milliseconds. (-1 automatic).</BLURB>
+<DEFAULT>-1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpJitterBuffer::rtx-stats-timeout</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>RTX Statistics Timeout</NICK>
+<BLURB>The time to wait for a retransmitted packet after it has been considered lost in order to collect statistics (ms).</BLURB>
+<DEFAULT>1000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstRtpSession::bandwidth</NAME>
 <TYPE>gdouble</TYPE>
 <RANGE>>= 0</RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstFlvMux::metadatacreator</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>metadatacreator</NICK>
+<BLURB>The value of metadatacreator in the meta packet.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstCapsSetter::caps</NAME>
 <TYPE>GstCaps*</TYPE>
 <RANGE></RANGE>
 <ARG>
 <NAME>GstQTMux::movie-timescale</NAME>
 <TYPE>guint</TYPE>
-<RANGE>>= 1</RANGE>
+<RANGE></RANGE>
 <FLAGS>rwx</FLAGS>
 <NICK>Movie timescale</NICK>
-<BLURB>Timescale to use in the movie (units per second).</BLURB>
-<DEFAULT>1800</DEFAULT>
+<BLURB>Timescale to use in the movie (units per second, 0 == default).</BLURB>
+<DEFAULT>0</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>GstQTMux::interleave-bytes</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (bytes)</NICK>
+<BLURB>Interleave between streams in bytes.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstQTMux::interleave-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (time)</NICK>
+<BLURB>Interleave between streams in nanoseconds.</BLURB>
+<DEFAULT>250000000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstQTMoovRecover::broken-input</NAME>
 <TYPE>gchar*</TYPE>
 <RANGE></RANGE>
 <ARG>
 <NAME>GstMP4Mux::movie-timescale</NAME>
 <TYPE>guint</TYPE>
-<RANGE>>= 1</RANGE>
+<RANGE></RANGE>
 <FLAGS>rwx</FLAGS>
 <NICK>Movie timescale</NICK>
-<BLURB>Timescale to use in the movie (units per second).</BLURB>
-<DEFAULT>1800</DEFAULT>
+<BLURB>Timescale to use in the movie (units per second, 0 == default).</BLURB>
+<DEFAULT>0</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>GstMP4Mux::interleave-bytes</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (bytes)</NICK>
+<BLURB>Interleave between streams in bytes.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstMP4Mux::interleave-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (time)</NICK>
+<BLURB>Interleave between streams in nanoseconds.</BLURB>
+<DEFAULT>250000000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstMJ2Mux::dts-method</NAME>
 <TYPE>GstQTMuxDtsMethods</TYPE>
 <RANGE></RANGE>
 <ARG>
 <NAME>GstMJ2Mux::movie-timescale</NAME>
 <TYPE>guint</TYPE>
-<RANGE>>= 1</RANGE>
+<RANGE></RANGE>
 <FLAGS>rwx</FLAGS>
 <NICK>Movie timescale</NICK>
-<BLURB>Timescale to use in the movie (units per second).</BLURB>
-<DEFAULT>1800</DEFAULT>
+<BLURB>Timescale to use in the movie (units per second, 0 == default).</BLURB>
+<DEFAULT>0</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>GstMJ2Mux::interleave-bytes</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (bytes)</NICK>
+<BLURB>Interleave between streams in bytes.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstMJ2Mux::interleave-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (time)</NICK>
+<BLURB>Interleave between streams in nanoseconds.</BLURB>
+<DEFAULT>250000000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstISMLMux::dts-method</NAME>
 <TYPE>GstQTMuxDtsMethods</TYPE>
 <RANGE></RANGE>
 <ARG>
 <NAME>GstISMLMux::movie-timescale</NAME>
 <TYPE>guint</TYPE>
-<RANGE>>= 1</RANGE>
+<RANGE></RANGE>
 <FLAGS>rwx</FLAGS>
 <NICK>Movie timescale</NICK>
-<BLURB>Timescale to use in the movie (units per second).</BLURB>
-<DEFAULT>1800</DEFAULT>
+<BLURB>Timescale to use in the movie (units per second, 0 == default).</BLURB>
+<DEFAULT>0</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>GstISMLMux::interleave-bytes</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (bytes)</NICK>
+<BLURB>Interleave between streams in bytes.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstISMLMux::interleave-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (time)</NICK>
+<BLURB>Interleave between streams in nanoseconds.</BLURB>
+<DEFAULT>250000000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>Gst3GPPMux::dts-method</NAME>
 <TYPE>GstQTMuxDtsMethods</TYPE>
 <RANGE></RANGE>
 <ARG>
 <NAME>Gst3GPPMux::movie-timescale</NAME>
 <TYPE>guint</TYPE>
-<RANGE>>= 1</RANGE>
+<RANGE></RANGE>
 <FLAGS>rwx</FLAGS>
 <NICK>Movie timescale</NICK>
-<BLURB>Timescale to use in the movie (units per second).</BLURB>
-<DEFAULT>1800</DEFAULT>
+<BLURB>Timescale to use in the movie (units per second, 0 == default).</BLURB>
+<DEFAULT>0</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>Gst3GPPMux::interleave-bytes</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (bytes)</NICK>
+<BLURB>Interleave between streams in bytes.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>Gst3GPPMux::interleave-time</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interleave (time)</NICK>
+<BLURB>Interleave between streams in nanoseconds.</BLURB>
+<DEFAULT>250000000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstSplitFileSrc::location</NAME>
 <TYPE>gchar*</TYPE>
 <RANGE></RANGE>
 <ARG>
 <NAME>GstGdkPixbufOverlay::relative-x</NAME>
 <TYPE>gdouble</TYPE>
-<RANGE>[0,1]</RANGE>
+<RANGE>[-1,1]</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Relative X Offset</NICK>
-<BLURB>Horizontal offset of overlay image in fractions of video image width, from top-left corner of video image.</BLURB>
+<BLURB>Horizontal offset of overlay image in fractions of video image width, from top-left corner of video image (in relative positioning).</BLURB>
 <DEFAULT>0</DEFAULT>
 </ARG>
 
 <ARG>
 <NAME>GstGdkPixbufOverlay::relative-y</NAME>
 <TYPE>gdouble</TYPE>
-<RANGE>[0,1]</RANGE>
+<RANGE>[-1,1]</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Relative Y Offset</NICK>
-<BLURB>Vertical offset of overlay image in fractions of video image height, from top-left corner of video image.</BLURB>
+<BLURB>Vertical offset of overlay image in fractions of video image height, from top-left corner of video image (in relative positioning).</BLURB>
 <DEFAULT>0</DEFAULT>
 </ARG>
 
 </ARG>
 
 <ARG>
+<NAME>GstGdkPixbufOverlay::coef-x</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-1,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Relative X Offset</NICK>
+<BLURB>Horizontal offset of overlay image in fractions of video image width, from top-left corner of video image (absolute positioning).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstGdkPixbufOverlay::coef-y</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-1,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Relative Y Offset</NICK>
+<BLURB>Vertical offset of overlay image in fractions of video image height, from top-left corner of video image (absolute positioning).</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstVP8Enc::arnr-maxframes</NAME>
 <TYPE>gint</TYPE>
 <RANGE>[0,15]</RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstRTPRtxQueue::fulfilled-requests</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Fulfilled Requests</NICK>
+<BLURB>Number of fulfilled retransmission requests.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRTPRtxQueue::requests</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Requests</NICK>
+<BLURB>Total number of retransmission requests.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstRtpGSTPay::config-interval</NAME>
 <TYPE>guint</TYPE>
 <RANGE><= 3600</RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstSplitMuxSink::max-size-timecode</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Maximum timecode difference</NICK>
+<BLURB>Maximum difference in timecode between first and last frame. Separator is assumed to be ":" everywhere (e.g. 01:00:00:00). Will only be effective if a timecode track is present.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstRtpVP9Pay::picture-id-mode</NAME>
 <TYPE>GstVP9RTPPayMode</TYPE>
 <RANGE></RANGE>