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

Removed the audiosink/src from the docs.

Browse source 
Original commit message from CVS:
Removed the audiosink/src from the docs.
Removed the audioraw metadata file from the docs.
This commit is contained in:
Wim Taymans 2001-03-27 16:25:00 +00:00
parent 0837e1e495
commit 10e29412ff
9 changed files with 228 additions and 252 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/gst/gstreamer-docs.sgml
View file

@ -34,15 +34,12 @@
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity GstAudioSrc SYSTEM "sgml/gstaudiosrc.sgml">
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
<!entity GstAudioSink SYSTEM "sgml/gstaudiosink.sgml">
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
<!entity audioraw SYSTEM "sgml/audioraw.sgml">
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
<!entity videoraw SYSTEM "sgml/videoraw.sgml">
@ -128,9 +125,6 @@ with some more specialized elements.</para>
&GstDiskSrc;
&GstHttpSrc;
&GstAudioSrc;
&GstAudioSink;
&GstSineSrc;
&GstFdSrc;
@ -148,7 +142,6 @@ with some more specialized elements.</para>
<para>MetaData is used to specify the content of buffers. See <classname>GstMeta</classname>. </para>
&spectrum;
&audioraw;
&videoraw;
</chapter>

37
docs/gst/gstreamer-sections.txt
View file

@ -768,37 +768,6 @@ GST_STATIC_AUTOPLUG_RENDER_CLASS
GST_IS_STATIC_AUTOPLUG_RENDER_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiosink</FILE>
<TITLE>GstAudioSink</TITLE>
<SUBSECTION Standard>
GstAudioSink
GstAudioSinkClass
GstAudioSinkFlags
gst_audiosink_get_type
GST_TYPE_AUDIOSINK
GST_AUDIOSINK
GST_AUDIOSINK_CLASS
GST_IS_AUDIOSINK
GST_IS_AUDIOSINK_CLASS
gst_audiosink_factory_init
</SECTION>
<SECTION>
<FILE>gstaudiosrc</FILE>
<TITLE>GstAudioSrc</TITLE>
<SUBSECTION Standard>
GstAudioSrc
GstAudioSrcClass
GstAudioSrcFlags
gst_audiosrc_get_type
GST_TYPE_AUDIOSRC
GST_AUDIOSRC
GST_AUDIOSRC_CLASS
GST_IS_AUDIOSRC
GST_IS_AUDIOSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstdisksrc</FILE>
<TITLE>GstDiskSrc</TITLE>
@ -957,12 +926,6 @@ GST_IS_TYPEFIND
GST_IS_TYPEFIND_CLASS
</SECTION>
<SECTION>
<INCLUDE>gst/meta/audioraw.h</INCLUDE>
<FILE>audioraw</FILE>
MetaAudioRaw
</SECTION>
<SECTION>
<INCLUDE>gst/meta/spectrum.h</INCLUDE>
<FILE>spectrum</FILE>

2
docs/gst/gstreamer.hierarchy
View file

@ -11,9 +11,7 @@ GtkObject
GstDiskSrc
GstHttpSrc
GstFdSrc
GstAudioSrc
GstSineSrc
GstAudioSink
GstFdSink
GstPipefilter
GstIdentity

27
docs/gst/tmpl/audioraw.sgml
View file

@ -1,27 +0,0 @@
<!-- ##### SECTION Title ##### -->
audioraw
<!-- ##### SECTION Short_Description ##### -->
Information about audio buffers.
<!-- ##### SECTION Long_Description ##### -->
<para>
Information about audio buffers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT MetaAudioRaw ##### -->
<para>
</para>
@meta:
@format:
@channels:
@frequency:
@bps:

45
docs/gst/tmpl/gstaudiosink.sgml
View file

@ -1,45 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstAudioSink
<!-- ##### SECTION Short_Description ##### -->
Output to a sound card via OSS. (audiosink)
<!-- ##### SECTION Long_Description ##### -->
<para>
Output to a sound card via OSS.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SIGNAL GstAudioSink::handoff ##### -->
<para>
The buffer is sent to the sound card.
</para>
@gstaudiosink: the object which received the signal.
<!-- # Unused Parameters # -->
@arg1: the audiosink.
<!-- ##### ARG GstAudioSink:mute ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:format ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:channels ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:frequency ##### -->
<para>
</para>

41
docs/gst/tmpl/gstaudiosrc.sgml
View file

@ -1,41 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstAudioSrc
<!-- ##### SECTION Short_Description ##### -->
Read from the sound card. (audiosrc)
<!-- ##### SECTION Long_Description ##### -->
<para>
Create buffers from an OSS sound card.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSrc:bytes_per_read ##### -->
<para>
The number of bytes per read.
</para>
<!-- ##### ARG GstAudioSrc:curoffset ##### -->
<para>
Get the current number of bytes read.
</para>
<!-- ##### ARG GstAudioSrc:format ##### -->
<para>
The audio format as defined in soundcard.h
</para>
<!-- ##### ARG GstAudioSrc:channels ##### -->
<para>
The number of channels (mono, stereo, ...)
</para>
<!-- ##### ARG GstAudioSrc:frequency ##### -->
<para>
The frequency.
</para>

1
docs/gst/tmpl/gstcaps.sgml
View file

@ -23,6 +23,7 @@ a mime-type and a set of properties.
@name: the name of the capability, for the application
@id: the typeid of the capability
@refcount:
@lock:
@properties: the properties of the capability
@next:

1
docs/gst/tmpl/gstprops.sgml
View file

@ -21,6 +21,7 @@ GstCaps
</para>
@refcount:
@lock:
@properties: the properties
<!-- ##### TYPEDEF GstPropsFactoryEntry ##### -->

319
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -12,6 +12,12 @@ Query the element for the current mime type
</para>
<!-- ##### ARG GstAudioSink:mute ##### -->
<para>
</para>
<!-- ##### STRUCT GstFakeSrc ##### -->
<para>
@ -61,14 +67,6 @@ Query the element for the current mime type
</para>
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para>
</para>
@pad:
@parent:
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
@ -77,6 +75,14 @@ Query the element for the current mime type
@pad:
@buf:
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para>
</para>
@pad:
@parent:
<!-- ##### FUNCTION gst_identity_chain ##### -->
<para>
@ -171,6 +177,12 @@ GstEsdSink
@obj:
<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_AUDIOSINK ##### -->
<para>
@ -208,6 +220,12 @@ the stream.
</para>
<!-- ##### SECTION ./tmpl/audioraw.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_ESDSINK_CLASS ##### -->
<para>
@ -331,16 +349,16 @@ subclass use this to start their flag enumeration
@audiosink:
@channels:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstSinkClass ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstFilterClass ##### -->
<para>
@ -363,6 +381,12 @@ Generic connection between elements.
@format:
@args...:
<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_FILTER ##### -->
<para>
@ -578,6 +602,12 @@ Specify the current offset in the file.
</para>
<!-- ##### ARG GstAudioSink:format ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para>
@ -612,24 +642,17 @@ Specify the current offset in the file.
@name:
@Returns:
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueClass ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
@src:
<!-- ##### FUNCTION gst_type_add_sink ##### -->
<para>
@ -639,6 +662,13 @@ Specify the current offset in the file.
@id:
@sink:
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
<para>
@ -650,6 +680,10 @@ Specify the current offset in the file.
GstGetbits
<!-- ##### SECTION ./tmpl/audioraw.sgml:Title ##### -->
audioraw
<!-- ##### MACRO GST_FDSINK_CLASS ##### -->
<para>
@ -756,6 +790,12 @@ GstGetbits
@obj:
<!-- ##### ARG GstAudioSrc:format ##### -->
<para>
The audio format as defined in soundcard.h
</para>
<!-- ##### MACRO GST_IS_HTTPSRC_CLASS ##### -->
<para>
@ -829,6 +869,14 @@ The fequency.
@obj:
<!-- ##### SIGNAL GstAudioSink::handoff ##### -->
<para>
The buffer is sent to the sound card.
</para>
@gstaudiosink: the object which received the signal.
@arg1: the audiosink.
<!-- ##### MACRO GST_IS_FDSRC_CLASS ##### -->
<para>
@ -1018,13 +1066,6 @@ GstFilter
@obj:
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
@ -1032,6 +1073,13 @@ GstFilter
@Returns:
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para>
@ -1055,6 +1103,10 @@ Flags for the GstSrc element
@GST_SRC_ASYNC: Indicates that this src is asynchronous
@GST_SRC_FLAG_LAST: subclasses can use this to number their flags
<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### -->
GstColorSpace
@ -1112,13 +1164,6 @@ GstColorSpace
@obj:
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
@ -1126,6 +1171,13 @@ GstColorSpace
@klass:
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_SRC_CLASS ##### -->
<para>
@ -1155,12 +1207,6 @@ GstColorSpace
@pad:
@Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_esdsink_new ##### -->
<para>
@ -1169,6 +1215,12 @@ GstColorSpace
@name:
@Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_request_pad ##### -->
<para>
@ -1190,6 +1242,23 @@ GstColorSpace
The end point of a filter graph
<!-- ##### STRUCT MetaAudioRaw ##### -->
<para>
</para>
@meta:
@format:
@channels:
@frequency:
@bps:
<!-- ##### ARG GstAudioSrc:channels ##### -->
<para>
The number of channels (mono, stereo, ...)
</para>
<!-- ##### STRUCT GstFakeSink ##### -->
<para>
@ -1241,6 +1310,10 @@ This macro checks to see if the given state is set.
@obj:
<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Title ##### -->
GstAudioSink
<!-- ##### MACRO GST_IS_ASYNCDISKSRC ##### -->
<para>
@ -1284,16 +1357,16 @@ This macro sets the given flags.
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para>
A flag indicating that MMX instructions are supported.
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### FUNCTION gst_object_get_type ##### -->
<para>
@ -1325,6 +1398,12 @@ This macro usets the given flags.
@flag: Flag to set, must be a single bit in guint32.
@obj: GstSrc to unset flag in.
<!-- ##### ARG GstAudioSrc:frequency ##### -->
<para>
The frequency.
</para>
<!-- ##### MACRO GST_IS_SINK_CLASS ##### -->
<para>
@ -1557,6 +1636,12 @@ GstElement
@obj:
<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### -->
<para>
The sink is the end of the filter graph. A typical sink would be an audio
@ -1565,13 +1650,6 @@ or a video card.
</para>
<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<para>
@ -1579,6 +1657,13 @@ or a video card.
@Returns:
<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
<para>
@ -1599,12 +1684,6 @@ Query whether this object has multiple input pads.
@obj: Element to query for multiple input pads.
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<para>
@ -1613,6 +1692,18 @@ Query whether this object has multiple input pads.
@format:
@args...:
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:frequency ##### -->
<para>
</para>
<!-- ##### STRUCT GstFdSrc ##### -->
<para>
@ -1762,13 +1853,6 @@ on its own.
@obj:
<!-- ##### MACRO GST_FAKESINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_DISKSRC ##### -->
<para>
@ -1776,6 +1860,13 @@ on its own.
@obj:
<!-- ##### MACRO GST_FAKESINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_TYPE_FDSINK ##### -->
<para>
@ -1866,6 +1957,10 @@ Get the size of the current file.
</para>
<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### -->
The start point of a filter graph
@ -1957,13 +2052,6 @@ The start point of a filter graph
@audiosink:
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_STATE_UNSET ##### -->
<para>
This macro unsets the given state on the element.
@ -1972,6 +2060,13 @@ This macro unsets the given state on the element.
@obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32.
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para>
@ -2016,6 +2111,12 @@ This macro unsets the given state on the element.
@elementfactory:
<!-- ##### ARG GstAudioSrc:bytes_per_read ##### -->
<para>
The number of bytes per read.
</para>
<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
<para>
</para>
@ -2031,6 +2132,13 @@ This macro unsets the given state on the element.
@obj:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO ERROR_OBJECT ##### -->
<para>
@ -2041,13 +2149,6 @@ This macro unsets the given state on the element.
@format:
@args...:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_IDENTITY ##### -->
<para>
@ -2075,6 +2176,12 @@ This macro unsets the given state on the element.
@obj:
<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_audiosink_get_type ##### -->
<para>
@ -2146,13 +2253,6 @@ This macro sets the given state on the element.
@obj:
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_src_push_region ##### -->
<para>
@ -2162,6 +2262,13 @@ This macro sets the given state on the element.
@offset:
@size:
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### STRUCT GstPipelineClass ##### -->
<para>
@ -2206,6 +2313,10 @@ Is trigered whenever the state of an element changes
@Returns:
<!-- ##### SECTION ./tmpl/audioraw.sgml:Short_Description ##### -->
Information about audio buffers.
<!-- ##### SECTION ./tmpl/gstfilter.sgml:Short_Description ##### -->
Take data in and spit data out
@ -2242,13 +2353,13 @@ A flag indicating that SSE instructions are supported.
@obj:
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<!-- ##### STRUCT GstDiskSrcClass ##### -->
<para>
</para>
<!-- ##### STRUCT GstDiskSrcClass ##### -->
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para>
</para>
@ -2274,6 +2385,12 @@ A flag indicating that SSE instructions are supported.
@obj:
<!-- ##### SECTION ./tmpl/audioraw.sgml:Long_Description ##### -->
<para>
Information about audio buffers.
</para>
<!-- ##### ENUM GstPropsId ##### -->
<para>
@ -2365,6 +2482,10 @@ Specify the location of the file to read.
@audiosink:
@format:
<!-- ##### SECTION ./tmpl/gstaudiosrc.sgml:Title ##### -->
GstAudioSrc
<!-- ##### MACRO INFO ##### -->
<para>
@ -2381,6 +2502,13 @@ the offset.
</para>
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_sinesrc_new ##### -->
<para>
@ -2389,12 +2517,11 @@ the offset.
@name:
@Returns:
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
<!-- ##### ARG GstAudioSrc:curoffset ##### -->
<para>
Get the current number of bytes read.
</para>
@obj:
<!-- ##### FUNCTION gst_plugin_init ##### -->
<para>
@ -2425,14 +2552,13 @@ plugin
</para>
<!-- ##### MACRO GST_BIN_CLASS ##### -->
<!-- ##### ARG GstAudioSink:channels ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<!-- ##### MACRO GST_BIN_CLASS ##### -->
<para>
</para>
@ -2446,6 +2572,13 @@ plugin
@obj:
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active