docs: add gtk-doc chunks with Since: markers for new v4l2src properties
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Wed, 15 Sep 2010 16:02:57 +0000 (17:02 +0100)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Wed, 15 Sep 2010 16:05:30 +0000 (17:05 +0100)
docs/plugins/gst-plugins-good-plugins.args
sys/v4l2/gstv4l2object.c
sys/v4l2/gstv4l2src.c

index df3b2daf431f57ccf46b2526d365944f680428de..b465637ed89a70fb8570e29fa2aac3771e4bbfa4 100644 (file)
 <DEFAULT>NULL</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstRTSPSrc::udp-buffer-size</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= 0</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>UDP Buffer Size</NICK>
+<BLURB>Size of the kernel UDP receive buffer in bytes, 0=default.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstRTPDec::skip</NAME>
 <TYPE>gint</TYPE>
 <DEFAULT>1</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstMultiUDPSink::send-duplicates</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Send Duplicates</NICK>
+<BLURB>When a distination/port pair is added multiple times, send packets multiple times as well.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstCmmlDec::wait-clip-end-time</NAME>
 <TYPE>gboolean</TYPE>
 <DEFAULT>-1</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstV4l2Src::brightness</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Brightness</NICK>
+<BLURB>Picture brightness, or more precisely, the black level.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Src::contrast</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Contrast</NICK>
+<BLURB>Picture contrast or luma gain.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Src::decimate</NAME>
+<TYPE>gint</TYPE>
+<RANGE>>= 1</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Decimate</NICK>
+<BLURB>Only use every nth frame.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Src::hue</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Hue</NICK>
+<BLURB>Hue or color balance.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Src::saturation</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Saturation</NICK>
+<BLURB>Picture color saturation or chroma gain.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstAudioChebBand::lower-frequency</NAME>
 <TYPE>gfloat</TYPE>
 <DEFAULT>"<unknown>"</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstPulseSink::stream-properties</NAME>
+<TYPE>GstStructure*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>stream properties</NICK>
+<BLURB>list of pulseaudio stream properties.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstPulseSrc::device</NAME>
 <TYPE>gchar*</TYPE>
 <DEFAULT>NULL</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstPulseSrc::stream-properties</NAME>
+<TYPE>GstStructure*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>stream properties</NICK>
+<BLURB>list of pulseaudio stream properties.</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstPulseMixer::device</NAME>
 <TYPE>gchar*</TYPE>
 <DEFAULT>Slave receiver to sender clock</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstRtpBin::ntp-sync</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Sync on NTP clock</NICK>
+<BLURB>Synchronize received streams to the NTP clock.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstRtpBin::use-pipeline-clock</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use pipeline clock</NICK>
+<BLURB>Use the pipeline clock to set the NTP time in the RTCP SR messages.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstRtpJitterBuffer::do-lost</NAME>
 <TYPE>gboolean</TYPE>
 <RANGE>>= 0</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>Bandwidth</NICK>
-<BLURB>The bandwidth of the session in bytes per second.</BLURB>
+<BLURB>The bandwidth of the session in bytes per second (0 for auto-discover).</BLURB>
 <DEFAULT>64000</DEFAULT>
 </ARG>
 
 <RANGE>>= 0</RANGE>
 <FLAGS>rw</FLAGS>
 <NICK>RTCP Fraction</NICK>
-<BLURB>The RTCP bandwidth of the session in bytes per second.</BLURB>
+<BLURB>The RTCP bandwidth of the session in bytes per second (or as a real fraction of the RTP bandwidth if < 1.0).</BLURB>
 <DEFAULT>3200</DEFAULT>
 </ARG>
 
 <DEFAULT>-1</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstRtpSession::use-pipeline-clock</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use pipeline clock</NICK>
+<BLURB>Use the pipeline clock to set the NTP time in the RTCP SR messages.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstV4l2Sink::device</NAME>
 <TYPE>gchar*</TYPE>
 <DEFAULT>8</DEFAULT>
 </ARG>
 
+<ARG>
+<NAME>GstV4l2Sink::brightness</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Brightness</NICK>
+<BLURB>Picture brightness, or more precisely, the black level.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Sink::contrast</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Contrast</NICK>
+<BLURB>Picture contrast or luma gain.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Sink::hue</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Hue</NICK>
+<BLURB>Hue or color balance.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstV4l2Sink::saturation</NAME>
+<TYPE>gint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Saturation</NICK>
+<BLURB>Picture color saturation or chroma gain.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
 <ARG>
 <NAME>GstShapeWipe::border</NAME>
 <TYPE>gfloat</TYPE>
index 162c9b8ad0697a670aa63ee9744733ffb1cbd0ee..96b6e591397557cf8b940545c14b422f9841a184 100644 (file)
@@ -329,21 +329,49 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
           GST_TYPE_V4L2_DEVICE_FLAGS, DEFAULT_PROP_FLAGS,
           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 
+  /**
+   * GstV4l2Src:brightness
+   *
+   * Picture brightness, or more precisely, the black level
+   *
+   * Since: 0.10.26
+   */
   g_object_class_install_property (gobject_class, PROP_BRIGHTNESS,
       g_param_spec_int ("brightness", "Brightness",
           "Picture brightness, or more precisely, the black level", G_MININT,
           G_MAXINT, 0,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
+  /**
+   * GstV4l2Src:contrast
+   *
+   * Picture contrast or luma gain
+   *
+   * Since: 0.10.26
+   */
   g_object_class_install_property (gobject_class, PROP_CONTRAST,
       g_param_spec_int ("contrast", "Contrast",
           "Picture contrast or luma gain", G_MININT,
           G_MAXINT, 0,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
+  /**
+   * GstV4l2Src:saturation
+   *
+   * Picture color saturation or chroma gain
+   *
+   * Since: 0.10.26
+   */
   g_object_class_install_property (gobject_class, PROP_SATURATION,
       g_param_spec_int ("saturation", "Saturation",
           "Picture color saturation or chroma gain", G_MININT,
           G_MAXINT, 0,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
+  /**
+   * GstV4l2Src:hue
+   *
+   * Hue or color balance
+   *
+   * Since: 0.10.26
+   */
   g_object_class_install_property (gobject_class, PROP_HUE,
       g_param_spec_int ("hue", "Hue",
           "Hue or color balance", G_MININT,
index c2253694fa707b6cea88db60aba0dc97232bb49a..4724fe967554fdedd1b336d6eed97f468ae34517 100644 (file)
@@ -266,6 +266,13 @@ gst_v4l2src_class_init (GstV4l2SrcClass * klass)
       g_param_spec_boolean ("always-copy", "Always Copy",
           "If the buffer will or not be used directly from mmap",
           PROP_DEF_ALWAYS_COPY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+  /**
+   * GstV4l2Src:decimate
+   *
+   * Only use every nth frame
+   *
+   * Since: 0.10.26
+   */
   g_object_class_install_property (gobject_class, PROP_DECIMATE,
       g_param_spec_int ("decimate", "Decimate",
           "Only use every nth frame", 1, G_MAXINT,