Commit 601b993f authored by Tim-Philipp Müller's avatar Tim-Philipp Müller

docs: add gtk-doc chunks with Since: markers for new v4l2src properties

parent bbb79439
......@@ -758,6 +758,16 @@
<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>
......@@ -2498,6 +2508,16 @@
<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>
......@@ -3058,6 +3078,56 @@
<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>
......@@ -19718,6 +19788,16 @@
<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>
......@@ -19748,6 +19828,16 @@
<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>
......@@ -20448,6 +20538,26 @@
<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>
......@@ -20514,7 +20624,7 @@
<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>
......@@ -20564,7 +20674,7 @@
<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>
......@@ -20598,6 +20708,16 @@
<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>
......@@ -20688,6 +20808,46 @@
<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>
......
......@@ -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,
......
......@@ -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,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment