mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-23 10:11:08 +00:00
docs: Port all docstring to gtk-doc markdown
This commit is contained in:
parent
974cbfb3c4
commit
3a9a603276
2 changed files with 7 additions and 14 deletions
|
@ -27,7 +27,7 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-audiointerleave
|
||||
*
|
||||
* @title: audiointerleave
|
||||
*
|
||||
*/
|
||||
|
||||
|
@ -593,7 +593,7 @@ gst_audio_interleave_class_init (GstAudioInterleaveClass * klass)
|
|||
|
||||
/**
|
||||
* GstInterleave:channel-positions
|
||||
*
|
||||
*
|
||||
* Channel positions: This property controls the channel positions
|
||||
* that are used on the src caps. The number of elements should be
|
||||
* the same as the number of sink pads and the array should contain
|
||||
|
@ -617,7 +617,7 @@ gst_audio_interleave_class_init (GstAudioInterleaveClass * klass)
|
|||
|
||||
/**
|
||||
* GstInterleave:channel-positions-from-input
|
||||
*
|
||||
*
|
||||
* Channel positions from input: If this property is set to %TRUE the channel
|
||||
* positions will be taken from the input caps if valid channel positions for
|
||||
* the output can be constructed from them. If this is set to %TRUE setting the
|
||||
|
|
|
@ -23,6 +23,7 @@
|
|||
*/
|
||||
/**
|
||||
* SECTION:element-audiomixer
|
||||
* @title: audiomixer
|
||||
*
|
||||
* The audiomixer allows to mix several streams into one by adding the data.
|
||||
* Mixed data is clamped to the min/max values of the data format.
|
||||
|
@ -32,21 +33,13 @@
|
|||
* The input pads are from a GstPad subclass and have additional
|
||||
* properties to mute each pad individually and set the volume:
|
||||
*
|
||||
* <itemizedlist>
|
||||
* <listitem>
|
||||
* "mute": Whether to mute the pad or not (#gboolean)
|
||||
* </listitem>
|
||||
* <listitem>
|
||||
* "volume": The volume of the pad, between 0.0 and 10.0 (#gdouble)
|
||||
* </listitem>
|
||||
* </itemizedlist>
|
||||
* * "mute": Whether to mute the pad or not (#gboolean)
|
||||
* * "volume": The volume of the pad, between 0.0 and 10.0 (#gdouble)
|
||||
*
|
||||
* <refsect2>
|
||||
* <title>Example launch line</title>
|
||||
* ## Example launch line
|
||||
* |[
|
||||
* gst-launch-1.0 audiotestsrc freq=100 ! audiomixer name=mix ! audioconvert ! alsasink audiotestsrc freq=500 ! mix.
|
||||
* ]| This pipeline produces two sine waves mixed together.
|
||||
* </refsect2>
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
Loading…
Reference in a new issue