summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim.muller@collabora.co.uk>2010-05-11 19:01:51 +0100
committerTim-Philipp Müller <tim.muller@collabora.co.uk>2010-05-11 19:02:55 +0100
commitfa7d38c4383e122dd7d2f9531e7847cb6eac8149 (patch)
tree82df9b5ff8ba7666a1b25c19190b8b8dd8d30262 /docs
parent874c8e37473c392eca40b9d2e57b6dfdade6435c (diff)
docs: add oss4 elements to docs
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am3
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml4
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt62
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args80
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy5
-rw-r--r--docs/plugins/gst-plugins-good-plugins.interfaces3
-rw-r--r--docs/plugins/inspect/plugin-oss4.xml53
7 files changed, 209 insertions, 1 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index f33f14db9..0889ca6b7 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -212,6 +212,9 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/wavparse/gstwavparse.h \
$(top_srcdir)/gst/y4m/gsty4mencode.h \
$(top_srcdir)/sys/directsound/gstdirectsoundsink.h \
+ $(top_srcdir)/sys/oss4/oss4-mixer.h \
+ $(top_srcdir)/sys/oss4/oss4-sink.h \
+ $(top_srcdir)/sys/oss4/oss4-source.h \
$(top_srcdir)/sys/oss/gstossmixerelement.h \
$(top_srcdir)/sys/oss/gstosssink.h \
$(top_srcdir)/sys/oss/gstosssrc.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 5709f1c5c..cd1806568 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -108,6 +108,9 @@
<xi:include href="xml/element-multipartmux.xml" />
<xi:include href="xml/element-multiudpsink.xml" />
<xi:include href="xml/element-optv.xml" />
+ <xi:include href="xml/element-oss4mixer.xml" />
+ <xi:include href="xml/element-oss4sink.xml" />
+ <xi:include href="xml/element-oss4src.xml" />
<xi:include href="xml/element-ossmixer.xml" />
<xi:include href="xml/element-osssink.xml" />
<xi:include href="xml/element-osssrc.xml" />
@@ -209,6 +212,7 @@
<xi:include href="xml/plugin-multifile.xml" />
<xi:include href="xml/plugin-multipart.xml" />
<xi:include href="xml/plugin-navigationtest.xml" />
+ <xi:include href="xml/plugin-oss4.xml" />
<xi:include href="xml/plugin-ossaudio.xml" />
<xi:include href="xml/plugin-osxaudio.xml" />
<xi:include href="xml/plugin-osxvideo.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 4e39a8c82..a72dc55fc 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -1092,6 +1092,7 @@ GST_IMAGE_FREEZE
GST_IMAGE_FREEZE_CLASS
GST_IS_IMAGE_FREEZE
GST_IS_IMAGE_FREEZE_CLASS
+GST_IMAGE_FREEZE_GET_CLASS
GST_TYPE_IMAGE_FREEZE
gst_image_freeze_get_type
</SECTION>
@@ -1311,6 +1312,67 @@ gst_multiudpsink_get_type
</SECTION>
<SECTION>
+<FILE>element-oss4mixer</FILE>
+<TITLE>oss4mixer</TITLE>
+GstOss4Mixer
+<SUBSECTION Standard>
+GstOss4MixerClass
+GST_OSS4_MIXER
+GST_OSS4_MIXER_CLASS
+GST_IS_OSS4_MIXER
+GST_IS_OSS4_MIXER_CLASS
+GST_TYPE_OSS4_MIXER
+gst_oss4_mixer_get_type
+GST_OSS4_MIXER_CAST
+GST_OSS4_MIXER_IS_OPEN
+MIXEXT_ENUM_IS_AVAILABLE
+MIXEXT_HAS_DESCRIPTION
+MIXEXT_IS_ROOT
+MIXEXT_IS_SLIDER
+gst_oss4_mixer_get_control_val
+gst_oss4_mixer_set_control_val
+gst_oss4_source_input_get_type
+GstOss4MixerControl
+</SECTION>
+
+<SECTION>
+<FILE>element-oss4sink</FILE>
+<TITLE>oss4sink</TITLE>
+GstOss4Sink
+<SUBSECTION Standard>
+GstOss4SinkClass
+GST_TYPE_OSS4_SINK
+GST_OSS4_SINK
+GST_OSS4_SINK_CLASS
+GST_IS_OSS4_SINK
+GST_IS_OSS4_SINK_CLASS
+gst_oss4_sink_get_type
+GST_OSS4_SINK_CAST
+</SECTION>
+
+<SECTION>
+<FILE>element-oss4src</FILE>
+<TITLE>oss4src</TITLE>
+GstOss4Source
+<SUBSECTION Standard>
+GstOss4SourceClass
+GST_TYPE_OSS4_SOURCE
+GST_OSS4_SOURCE
+GST_OSS4_SOURCE_CLASS
+GST_IS_OSS4_SOURCE
+GST_IS_OSS4_SOURCE_CLASS
+gst_oss4_source_get_type
+GST_IS_OSS4_SOURCE_INPUT
+GST_IS_OSS4_SOURCE_INPUT_CLASS
+GST_OSS4_SOURCE_CAST
+GST_OSS4_SOURCE_INPUT
+GST_OSS4_SOURCE_INPUT_CLASS
+GST_TYPE_OSS4_SOURCE_INPUT
+GstOss4SourceInput
+GstOss4SourceInputClass
+</SECTION>
+
+<SECTION>
<FILE>element-ossmixer</FILE>
<TITLE>ossmixer</TITLE>
GstOssMixerElement
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 2d6dfef76..7c84d413f 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -20667,3 +20667,83 @@
<BLURB>Drop fields of incoming caps.</BLURB>
<DEFAULT>FALSE</DEFAULT>
</ARG>
+
+<ARG>
+<NAME>GstOss4Mixer::device</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Device</NICK>
+<BLURB>OSS mixer device (e.g. /dev/oss/hdaudio0/mix0 or /dev/mixerN) (NULL = use first mixer device found).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Mixer::device-name</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Device name</NICK>
+<BLURB>Human-readable name of the sound device.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Source::device</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Device</NICK>
+<BLURB>OSS4 device (e.g. /dev/oss/hdaudio0/pcm0 or /dev/dspN) (NULL = use first available device).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Source::device-name</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Device name</NICK>
+<BLURB>Human-readable name of the sound device.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Sink::device</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Device</NICK>
+<BLURB>OSS4 device (e.g. /dev/oss/hdaudio0/pcm0 or /dev/dspN) (NULL = use first available playback device).</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Sink::device-name</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>r</FLAGS>
+<NICK>Device name</NICK>
+<BLURB>Human-readable name of the sound device.</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Sink::mute</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Mute</NICK>
+<BLURB>Mute state of this stream.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstOss4Sink::volume</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[0,10]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Volume</NICK>
+<BLURB>Linear volume of this stream, 1.0=100%.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 99be91cd9..eb11523c3 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -36,6 +36,7 @@ GObject
GstAudioSink
GstEsdSink
GstOssSink
+ GstOss4Sink
GstCACASink
GstVideoSink
GstGdkPixbufSink
@@ -55,6 +56,7 @@ GObject
GstAudioSrc
GstPulseSrc
GstOssSrc
+ GstOss4Source
GstV4l2Src
GstXImageSrc
GstMultiFileSrc
@@ -136,6 +138,7 @@ GObject
GstPngEnc
GstGdkPixbuf
GstOssMixerElement
+ GstOss4Mixer
GstShapeWipe
GstAviDemux
GstAviMux
@@ -254,8 +257,8 @@ GObject
GstPlugin
GstRegistry
GstRingBuffer
- GstAudioSinkRingBuffer
GstAudioSrcRingBuffer
+ GstAudioSinkRingBuffer
GstSignalObject
GstCmmlTagStream
GstCmmlTagHead
diff --git a/docs/plugins/gst-plugins-good-plugins.interfaces b/docs/plugins/gst-plugins-good-plugins.interfaces
index 631a29062..15e18b202 100644
--- a/docs/plugins/gst-plugins-good-plugins.interfaces
+++ b/docs/plugins/gst-plugins-good-plugins.interfaces
@@ -17,6 +17,7 @@ GstRTSPSrc GstChildProxy GstURIHandler
GstRgVolume GstChildProxy
GstAspectRatioCrop GstChildProxy
GstPulseSink GstStreamVolume GstImplementsInterface GstPropertyProbe
+GstOss4Sink GstStreamVolume GstPropertyProbe
GstV4l2Sink GstImplementsInterface GstColorBalance GstVideoOrientation GstPropertyProbe
GstShout2send GstTagSetter
GstUDPSink GstURIHandler
@@ -25,6 +26,7 @@ GstHDV1394Src GstURIHandler GstPropertyProbe
GstSoupHTTPSrc GstURIHandler
GstPulseSrc GstImplementsInterface GstMixer GstPropertyProbe
GstOssSrc GstImplementsInterface GstMixer
+GstOss4Source GstImplementsInterface GstMixer GstPropertyProbe
GstV4l2Src GstURIHandler GstImplementsInterface GstTuner GstColorBalance GstVideoOrientation GstPropertyProbe
GstUDPSrc GstURIHandler
GstWavpackEnc GstPreset
@@ -41,6 +43,7 @@ GstIirEqualizer10Bands GstChildProxy GstPreset
GstPulseMixer GstImplementsInterface GstMixer GstPropertyProbe
GstSpeexEnc GstTagSetter GstPreset
GstOssMixerElement GstImplementsInterface GstMixer
+GstOss4Mixer GstImplementsInterface GstMixer GstPropertyProbe
GstAviMux GstTagSetter
GstMatroskaMux GstTagSetter
GstDeinterlace GstChildProxy
diff --git a/docs/plugins/inspect/plugin-oss4.xml b/docs/plugins/inspect/plugin-oss4.xml
new file mode 100644
index 000000000..2ffef5255
--- /dev/null
+++ b/docs/plugins/inspect/plugin-oss4.xml
@@ -0,0 +1,53 @@
+<plugin>
+ <name>oss4</name>
+ <description>Open Sound System (OSS) version 4 support for GStreamer</description>
+ <filename>../../sys/oss4/.libs/libgstoss4audio.so</filename>
+ <basename>libgstoss4audio.so</basename>
+ <version>0.10.22.1</version>
+ <license>LGPL</license>
+ <source>gst-plugins-good</source>
+ <package>GStreamer Good Plug-ins git</package>
+ <origin>Unknown package origin</origin>
+ <elements>
+ <element>
+ <name>oss4mixer</name>
+ <longname>OSS v4 Audio Mixer</longname>
+ <class>Generic/Audio</class>
+ <description>Control sound input and output levels with OSS4</description>
+ <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
+ <pads>
+
+ </pads>
+ </element>
+ <element>
+ <name>oss4sink</name>
+ <longname>OSS v4 Audio Sink</longname>
+ <class>Sink/Audio</class>
+ <description>Output to a sound card via OSS version 4</description>
+ <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-alaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-mulaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)32, depth=(int)32, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)32, depth=(int){ 32, 24 }, signed=(boolean)true, endianness=(int)4321, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int){ 32, 24 }, depth=(int)24, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean){ false, true }, endianness=(int){ 1234, 4321 }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)8, depth=(int)8, signed=(boolean){ true, false }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
+ <name>oss4src</name>
+ <longname>OSS v4 Audio Source</longname>
+ <class>Source/Audio</class>
+ <description>Capture from a sound card via OSS version 4</description>
+ <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-alaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-mulaw, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)32, depth=(int)32, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)32, depth=(int){ 32, 24 }, signed=(boolean)true, endianness=(int)4321, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int){ 32, 24 }, depth=(int)24, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean){ false, true }, endianness=(int){ 1234, 4321 }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]; audio/x-raw-int, width=(int)8, depth=(int)8, signed=(boolean){ true, false }, rate=(int)[ 1, 192000 ], channels=(int)[ 1, 4096 ]</details>
+ </caps>
+ </pads>
+ </element>
+ </elements>
+</plugin> \ No newline at end of file