summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2018-03-10 11:41:54 +0000
committerTim-Philipp Müller <tim@centricular.com>2018-03-10 11:41:54 +0000
commit6e86b322d7c598b6d0262efda03eab288cf9ecc8 (patch)
tree5f70e734141ba35795e79fec57349d3f064db1f8 /docs
parentc2bcc2711afabb7467d2d420bfc2c98d70eb078a (diff)
docs: add wasapi elements
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/gst-plugins-bad-plugins-docs.sgml3
-rw-r--r--docs/plugins/gst-plugins-bad-plugins-sections.txt30
-rw-r--r--docs/plugins/gst-plugins-bad-plugins.args110
-rw-r--r--docs/plugins/gst-plugins-bad-plugins.hierarchy2
-rw-r--r--docs/plugins/inspect/plugin-wasapi.xml43
5 files changed, 188 insertions, 0 deletions
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index a59f98933..ff00985e7 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -128,6 +128,8 @@
<xi:include href="xml/element-voamrwbenc.xml" />
<xi:include href="xml/element-vulkansink.xml" />
<xi:include href="xml/element-vulkanupload.xml" />
+ <xi:include href="xml/element-wasapisink.xml" />
+ <xi:include href="xml/element-wasapisrc.xml" />
<xi:include href="xml/element-wavescope.xml" />
<xi:include href="xml/element-webrtcbin.xml" />
<xi:include href="xml/element-webrtcdsp.xml" />
@@ -181,6 +183,7 @@
<xi:include href="xml/plugin-speed.xml" />
<xi:include href="xml/plugin-voaacenc.xml" />
<xi:include href="xml/plugin-voamrwbenc.xml" />
+ <xi:include href="xml/plugin-wasapi.xml" />
<xi:include href="xml/plugin-webrtcdsp.xml" />
<xi:include href="xml/plugin-zbar.xml" />
<xi:include href="xml/plugin-ttmlsubs.xml" />
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index fc429cd6d..a640450a1 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -3956,6 +3956,36 @@ gst_vo_amr_wb_enc_get_type
</SECTION>
<SECTION>
+<FILE>element-wasapisink</FILE>
+<TITLE>wasapisink</TITLE>
+GstWasapiSink
+<SUBSECTION Standard>
+GstWasapiSinkClass
+GST_WASAPI_SINK
+GST_IS_WASAPI_SINK
+GST_WASAPI_SINK_CLASS
+GST_IS_WASAPI_SINK_CLASS
+GST_TYPE_WASAPI_SINK
+<SUBSECTION Private>
+gst_wasapi_sink_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-wasapisrc</FILE>
+<TITLE>wasapisrc</TITLE>
+GstWasapiSrc
+<SUBSECTION Standard>
+GstWasapiSrcClass
+GST_WASAPI_SRC
+GST_IS_WASAPI_SRC
+GST_WASAPI_SRC_CLASS
+GST_IS_WASAPI_SRC_CLASS
+GST_TYPE_WASAPI_SRC
+<SUBSECTION Private>
+gst_wasapi_src_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-watchdog</FILE>
<TITLE>watchdog</TITLE>
GstWatchdog
diff --git a/docs/plugins/gst-plugins-bad-plugins.args b/docs/plugins/gst-plugins-bad-plugins.args
index 90c7b99dd..5153eb3e8 100644
--- a/docs/plugins/gst-plugins-bad-plugins.args
+++ b/docs/plugins/gst-plugins-bad-plugins.args
@@ -45439,6 +45439,116 @@
</ARG>
<ARG>
+<NAME>GstWasapiSink::role</NAME>
+<TYPE>GstWasapiDeviceRole</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Role</NICK>
+<BLURB>Role of the device: communications, multimedia, etc</BLURB>
+<DEFAULT>console</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSink::device</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Device</NICK>
+<BLURB>WASAPI playback device as a GUID string</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSink::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>GstWasapiSink::exclusive</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Exclusive mode</NICK>
+<BLURB>Open the device in exclusive mode</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSink::low-latency</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Low latency</NICK>
+<BLURB>Optimize all settings for lowest latency. Always safe to enable.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSink::use-audioclient3</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use the AudioClient3 API</NICK>
+<BLURB>Whether to use the Windows 10 AudioClient3 API when available</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSrc::role</NAME>
+<TYPE>GstWasapiDeviceRole</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Role</NICK>
+<BLURB>Role of the device: communications, multimedia, etc</BLURB>
+<DEFAULT>console</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSrc::device</NAME>
+<TYPE>gchar*</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Device</NICK>
+<BLURB>WASAPI playback device as a GUID string</BLURB>
+<DEFAULT></DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSrc::exclusive</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Exclusive mode</NICK>
+<BLURB>Open the device in exclusive mode</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSrc::low-latency</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Low latency</NICK>
+<BLURB>Optimize all settings for lowest latency. Always safe to enable.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstWasapiSrc::use-audioclient3</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Use the AudioClient3 API</NICK>
+<BLURB>Whether to use the Windows 10 AudioClient3 API when available</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstWaterRipple::amplitude</NAME>
<TYPE>gdouble</TYPE>
<RANGE></RANGE>
diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy
index 5b18e98cd..d50b6b6b8 100644
--- a/docs/plugins/gst-plugins-bad-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy
@@ -72,6 +72,7 @@ GObject
GstAudioBaseSink
GstAudioSink
GstOpenALSink
+ GstWasapiSink
GstAvdtpSink
GstChecksumSink
GstCurlBaseSink
@@ -108,6 +109,7 @@ GObject
GstAudioBaseSrc
GstAudioSrc
GstOpenalSrc
+ GstWasapiSrc
GstCurlHttpSrc
GstDC1394Src
GstDecklinkAudioSrc
diff --git a/docs/plugins/inspect/plugin-wasapi.xml b/docs/plugins/inspect/plugin-wasapi.xml
new file mode 100644
index 000000000..972926cf9
--- /dev/null
+++ b/docs/plugins/inspect/plugin-wasapi.xml
@@ -0,0 +1,43 @@
+<plugin>
+ <name>wasapi</name>
+ <description>Windows audio session API plugin</description>
+ <filename>../../sys/wasapi/.libs/libgstwasapi.dll</filename>
+ <basename>libgstwasapi.dll</basename>
+ <version>1.13.90</version>
+ <license>LGPL</license>
+ <source>gst-plugins-bad</source>
+ <package>GStreamer Bad Plug-ins source release</package>
+ <origin>Unknown package origin</origin>
+ <elements>
+ <element>
+ <name>wasapisrc</name>
+ <longname>WasapiSrc</longname>
+ <class>Source/Audio</class>
+ <description>Stream audio from an audio capture device through WASAPI</description>
+ <author>Nirbheek Chauhan &lt;nirbheek@centricular.com&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
+ <name>wasapisink</name>
+ <longname>WasapiSink</longname>
+ <class>Sink/Audio</class>
+ <description>Stream audio to an audio output device through WASAPI</description>
+ <author>Nirbheek Chauhan &lt;nirbheek@centricular.com&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw, format=(string)F32LE, layout=(string)interleaved, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ </elements>
+</plugin> \ No newline at end of file