mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-25 01:30:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add wasapi elements

Browse source
This commit is contained in:
Tim-Philipp Müller 2018-03-10 11:41:54 +00:00
parent c2bcc2711a
commit 6e86b322d7
5 changed files with 188 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/plugins/gst-plugins-bad-plugins-docs.sgml
View file

@ -128,6 +128,8 @@
<xi:include href="xml/element-voamrwbenc.xml" /> <xi:include href="xml/element-voamrwbenc.xml" />
<xi:include href="xml/element-vulkansink.xml" /> <xi:include href="xml/element-vulkansink.xml" />
<xi:include href="xml/element-vulkanupload.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-wavescope.xml" />
<xi:include href="xml/element-webrtcbin.xml" /> <xi:include href="xml/element-webrtcbin.xml" />
<xi:include href="xml/element-webrtcdsp.xml" /> <xi:include href="xml/element-webrtcdsp.xml" />
@ -181,6 +183,7 @@
<xi:include href="xml/plugin-speed.xml" /> <xi:include href="xml/plugin-speed.xml" />
<xi:include href="xml/plugin-voaacenc.xml" /> <xi:include href="xml/plugin-voaacenc.xml" />
<xi:include href="xml/plugin-voamrwbenc.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-webrtcdsp.xml" />
<xi:include href="xml/plugin-zbar.xml" /> <xi:include href="xml/plugin-zbar.xml" />
<xi:include href="xml/plugin-ttmlsubs.xml" /> <xi:include href="xml/plugin-ttmlsubs.xml" />

30
docs/plugins/gst-plugins-bad-plugins-sections.txt
View file

@ -3955,6 +3955,36 @@ GST_TYPE_VO_AMR_WB_ENC
gst_vo_amr_wb_enc_get_type gst_vo_amr_wb_enc_get_type
</SECTION> </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> <SECTION>
<FILE>element-watchdog</FILE> <FILE>element-watchdog</FILE>
<TITLE>watchdog</TITLE> <TITLE>watchdog</TITLE>

110
docs/plugins/gst-plugins-bad-plugins.args
View file

@ -45438,6 +45438,116 @@
<DEFAULT>0</DEFAULT> <DEFAULT>0</DEFAULT>
</ARG> </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> <ARG>
<NAME>GstWaterRipple::amplitude</NAME> <NAME>GstWaterRipple::amplitude</NAME>
<TYPE>gdouble</TYPE> <TYPE>gdouble</TYPE>

2
docs/plugins/gst-plugins-bad-plugins.hierarchy
View file

@ -72,6 +72,7 @@ GObject
GstAudioBaseSink GstAudioBaseSink
GstAudioSink GstAudioSink
GstOpenALSink GstOpenALSink
GstWasapiSink
GstAvdtpSink GstAvdtpSink
GstChecksumSink GstChecksumSink
GstCurlBaseSink GstCurlBaseSink
@ -108,6 +109,7 @@ GObject
GstAudioBaseSrc GstAudioBaseSrc
GstAudioSrc GstAudioSrc
GstOpenalSrc GstOpenalSrc
GstWasapiSrc
GstCurlHttpSrc GstCurlHttpSrc
GstDC1394Src GstDC1394Src
GstDecklinkAudioSrc GstDecklinkAudioSrc

43
docs/plugins/inspect/plugin-wasapi.xml Normal file
View file

@ -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>