Update docs
[platform/upstream/gst-plugins-good.git] / docs / plugins / gst-plugins-good-plugins.args
index 5186400..0e58a4b 100644 (file)
 </ARG>
 
 <ARG>
+<NAME>GstUDPSrc::mtu</NAME>
+<TYPE>guint</TYPE>
+<RANGE><= G_MAXINT</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Expected Maximum Transmission Unit</NICK>
+<BLURB>Maximum expected packet size. This directly defines the allocationsize of the receive buffer pool.</BLURB>
+<DEFAULT>1492</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstSMPTE::border</NAME>
 <TYPE>gint</TYPE>
 <RANGE>>= 0</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>User Agent</NICK>
 <BLURB>The User-Agent string to send to the server.</BLURB>
-<DEFAULT>"GStreamer/1.13.90"</DEFAULT>
+<DEFAULT>"GStreamer/1.16.1"</DEFAULT>
 </ARG>
 
 <ARG>
 </ARG>
 
 <ARG>
+<NAME>GstRTSPSrc::teardown-timeout</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Teardown Timeout</NICK>
+<BLURB>When transitioning PAUSED-READY, allow up to timeout (in nanoseconds) delay in order to send teardown (0 = disabled).</BLURB>
+<DEFAULT>100000000</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstRTPDec::latency</NAME>
 <TYPE>guint</TYPE>
 <RANGE></RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>User-Agent</NICK>
 <BLURB>Value of the User-Agent HTTP request header field.</BLURB>
-<DEFAULT>"GStreamer souphttpsrc 1.13.90 "</DEFAULT>
+<DEFAULT>"GStreamer souphttpsrc 1.16.1 "</DEFAULT>
 </ARG>
 
 <ARG>
 <RANGE>>= G_MAXULONG</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>RTX Delay Reorder</NICK>
-<BLURB>Sending retransmission event when this much reordering (0 disable, -1 automatic).</BLURB>
+<BLURB>Sending retransmission event when this much reordering (0 disable).</BLURB>
 <DEFAULT>3</DEFAULT>
 </ARG>
 
 <ARG>
 <NAME>GstRtpJitterBuffer::max-dropout-time</NAME>
 <TYPE>guint</TYPE>
-<RANGE></RANGE>
+<RANGE><= G_MAXINT</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Max dropout time</NICK>
 <BLURB>The maximum time (milliseconds) of missing packets tolerated.</BLURB>
 </ARG>
 
 <ARG>
+<NAME>GstFlvMux::encoder</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>encoder</NICK>
+<BLURB>The value of encoder in the meta packet.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstCapsSetter::caps</NAME>
 <TYPE>GstCaps*</TYPE>
 <RANGE></RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstQTMux::start-gap-threshold</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Start Gap Threshold</NICK>
+<BLURB>Threshold for creating an edit list for gaps at the start in nanoseconds.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstQTMoovRecover::broken-input</NAME>
 <TYPE>gchar*</TYPE>
 <RANGE></RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstMP4Mux::start-gap-threshold</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Start Gap Threshold</NICK>
+<BLURB>Threshold for creating an edit list for gaps at the start in nanoseconds.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstMJ2Mux::dts-method</NAME>
 <TYPE>GstQTMuxDtsMethods</TYPE>
 <RANGE></RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstMJ2Mux::start-gap-threshold</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Start Gap Threshold</NICK>
+<BLURB>Threshold for creating an edit list for gaps at the start in nanoseconds.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstISMLMux::dts-method</NAME>
 <TYPE>GstQTMuxDtsMethods</TYPE>
 <RANGE></RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstISMLMux::start-gap-threshold</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Start Gap Threshold</NICK>
+<BLURB>Threshold for creating an edit list for gaps at the start in nanoseconds.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>Gst3GPPMux::dts-method</NAME>
 <TYPE>GstQTMuxDtsMethods</TYPE>
 <RANGE></RANGE>
 </ARG>
 
 <ARG>
+<NAME>Gst3GPPMux::start-gap-threshold</NAME>
+<TYPE>guint64</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Start Gap Threshold</NICK>
+<BLURB>Threshold for creating an edit list for gaps at the start in nanoseconds.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstSplitFileSrc::location</NAME>
 <TYPE>gchar*</TYPE>
 <RANGE></RANGE>
 </ARG>
 
 <ARG>
+<NAME>GstMatroskaDemux::max-backtrack-distance</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Maximum backtrack distance</NICK>
+<BLURB>Maximum backtrack distance in seconds when seeking without and index in pull mode and search for a keyframe (0 = disable backtracking).</BLURB>
+<DEFAULT>30</DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstSoupHttpClientSink::automatic-redirect</NAME>
 <TYPE>gboolean</TYPE>
 <RANGE></RANGE>
 <RANGE></RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Muxer</NICK>
-<BLURB>The muxer element to use (NULL = default mp4mux).</BLURB>
+<BLURB>The muxer element to use (NULL = default mp4mux). Valid only for async-finalize = FALSE.</BLURB>
 <DEFAULT></DEFAULT>
 </ARG>
 
 <RANGE></RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Sink</NICK>
-<BLURB>The sink element (or element chain) to use (NULL = default filesink).</BLURB>
+<BLURB>The sink element (or element chain) to use (NULL = default filesink). Valid only for async-finalize = FALSE.</BLURB>
 <DEFAULT></DEFAULT>
 </ARG>
 
 <RANGE></RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Support robust-muxing mode of some muxers</NICK>
-<BLURB>Check if muxers support robust muxing via the reserved-max-duration and reserved-duration-remaining properties and use them if so. (Only present on qtmux and mp4mux for now). splitmuxsink may then also  create new fragments if the reserved header space is about to overflow. Note this does not set reserved-moov-update-period - apps should do that manually.</BLURB>
+<BLURB>Check if muxers support robust muxing via the reserved-max-duration and reserved-duration-remaining properties and use them if so. (Only present on qtmux and mp4mux for now). splitmuxsink may then also  create new fragments if the reserved header space is about to overflow. Note that for mp4mux and qtmux, reserved-moov-update-period must be set manually by the app to a non-zero value for robust muxing to have an effect.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSplitMuxSink::async-finalize</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Finalize fragments asynchronously</NICK>
+<BLURB>Finalize each fragment asynchronously and start a new one.</BLURB>
 <DEFAULT>FALSE</DEFAULT>
 </ARG>
 
 <ARG>
+<NAME>GstSplitMuxSink::muxer-factory</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Muxer factory</NICK>
+<BLURB>The muxer element factory to use (default = mp4mux). Valid only for async-finalize = TRUE.</BLURB>
+<DEFAULT>"mp4mux"</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSplitMuxSink::muxer-properties</NAME>
+<TYPE>GstStructure*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Muxer properties</NICK>
+<BLURB>The muxer element properties to use. Example: {properties,boolean-prop=true,string-prop="hi"}. Valid only for async-finalize = TRUE.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSplitMuxSink::reset-muxer</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Reset Muxer</NICK>
+<BLURB>Reset the muxer after each segment. Disabling this will not work for most muxers.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSplitMuxSink::sink-factory</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Sink factory</NICK>
+<BLURB>The sink element factory to use (default = filesink). Valid only for async-finalize = TRUE.</BLURB>
+<DEFAULT>"filesink"</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSplitMuxSink::sink-properties</NAME>
+<TYPE>GstStructure*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Sink properties</NICK>
+<BLURB>The sink element properties to use. Example: {properties,boolean-prop=true,string-prop="hi"}. Valid only for async-finalize = TRUE.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
 <NAME>GstRtpVP9Pay::picture-id-mode</NAME>
 <TYPE>GstVP9RTPPayMode</TYPE>
 <RANGE></RANGE>
 <DEFAULT>0</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstStereo::active</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>active</NICK>
+<BLURB>active.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstStereo::stereo</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>stereo</NICK>
+<BLURB>stereo.</BLURB>
+<DEFAULT>0.1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpFunnel::common-ts-offset</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= G_MAXULONG</RANGE>
+<FLAGS>rwx</FLAGS>
+<NICK>Common Timestamp Offset</NICK>
+<BLURB>Use the same RTP timestamp offset for all sinkpads (-1 = disable).</BLURB>
+<DEFAULT>-1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstCairoOverlay::draw-on-transparent-surface</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Draw on transparent surface</NICK>
+<BLURB>Let the draw signal work on a transparent surface and blend the results with the video at a later time.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstImageFreeze::num-buffers</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= G_MAXULONG</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>num-buffers</NICK>
+<BLURB>Number of buffers to output before sending EOS (-1 = unlimited).</BLURB>
+<DEFAULT>-1</DEFAULT>
+</ARG>
+