mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 00:36:51 +00:00
Code Issues 1 Projects Releases Wiki Activity

Cleaned up the docs a bit.

Browse source 
Original commit message from CVS:
Cleaned up the docs a bit.
This commit is contained in:
Erik Walthinsen 2001-01-06 22:05:15 +00:00
parent 372b6f5887
commit 7c51d6e0ca
44 changed files with 2184 additions and 2160 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/gst/tmpl/cothreads.sgml
View file

@ -23,7 +23,7 @@ of data out of their src element.
<!-- ##### MACRO COTHREAD_STACKSIZE ##### --> <!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
<para> <para>
The default stack size of a cothread The default stack size of a cothread.
</para> </para>
@ -89,7 +89,7 @@ it.
<!-- ##### MACRO COTHREAD_STARTED ##### --> <!-- ##### MACRO COTHREAD_STARTED ##### -->
<para> <para>
Indicates the cothread is started Indicates the cothread is started.
</para> </para>

20
docs/gst/tmpl/gstasyncdisksrc.sgml
View file

@ -32,23 +32,3 @@ the offset.
@GST_ASYNCDISKSRC_OPEN: @GST_ASYNCDISKSRC_OPEN:
@GST_ASYNCDISKSRC_FLAG_LAST: @GST_ASYNCDISKSRC_FLAG_LAST:
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para>
Specify the location of the file to read.
</para>
<!-- ##### ARG GstAsyncDiskSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>
<!-- ##### ARG GstAsyncDiskSrc:offset ##### -->
<para>
Specify the current offset in the file.
</para>
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para>
</para>

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

@ -14,32 +14,3 @@ Output to a sound card via OSS.
</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>

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

@ -14,28 +14,3 @@ Create buffers from an OSS sound card.
</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>

8
docs/gst/tmpl/gstautoplug.sgml
View file

@ -2,7 +2,7 @@
GstAutoplug GstAutoplug
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
Provide automatic element selection Provide automatic element selection.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
@ -17,14 +17,14 @@ to convert a certain GstCaps to another one.
<!-- ##### MACRO GST_AUTOPLUG_MAX_COST ##### --> <!-- ##### MACRO GST_AUTOPLUG_MAX_COST ##### -->
<para> <para>
The max cost of a certain connection The maximum cost of a certain connection.
</para> </para>
<!-- ##### USER_FUNCTION GstAutoplugCostFunction ##### --> <!-- ##### USER_FUNCTION GstAutoplugCostFunction ##### -->
<para> <para>
Calculate the cost between two elements Calculate the cost between two elements.
</para> </para>
@src: the source element @src: the source element
@ -35,7 +35,7 @@ Calculate the cost between two elements
<!-- ##### USER_FUNCTION GstAutoplugListFunction ##### --> <!-- ##### USER_FUNCTION GstAutoplugListFunction ##### -->
<para> <para>
Get a list of all elements. These elements will be used in autoplugging Get a list of all elements. These elements will be used in autoplugging.
</para> </para>
@data: user data @data: user data

11
docs/gst/tmpl/gstbin.sgml
View file

@ -19,7 +19,7 @@ allowing for deep nesting of predefined sub-pipelines.
<!-- ##### ENUM GstBinFlags ##### --> <!-- ##### ENUM GstBinFlags ##### -->
<para> <para>
Flags for a bin Flags for a bin.
</para> </para>
@GST_BIN_FLAG_MANAGER: @GST_BIN_FLAG_MANAGER:
@ -121,12 +121,3 @@ Flags for a bin
@bin: @bin:
<!-- ##### SIGNAL GstBin::object-added ##### -->
<para>
is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
</para>
@gstbin: the object which received the signal.
@arg1: the element that was added

20
docs/gst/tmpl/gstbuffer.sgml
View file

@ -21,7 +21,7 @@ pointers to arbitrary metadata.
<!-- ##### MACRO GST_BUFFER_FLAGS ##### --> <!-- ##### MACRO GST_BUFFER_FLAGS ##### -->
<para> <para>
get the flags from this buffer Get the flags from this buffer.
</para> </para>
@buf: GstBuffer to retrieve the flags from @buf: GstBuffer to retrieve the flags from
@ -29,7 +29,7 @@ get the flags from this buffer
<!-- ##### MACRO GST_BUFFER_FLAG_IS_SET ##### --> <!-- ##### MACRO GST_BUFFER_FLAG_IS_SET ##### -->
<para> <para>
gives the status of a given flag Gives the status of a given flag.
</para> </para>
@buf: GstBuffer to query @buf: GstBuffer to query
@ -38,7 +38,7 @@ gives the status of a given flag
<!-- ##### MACRO GST_BUFFER_FLAG_SET ##### --> <!-- ##### MACRO GST_BUFFER_FLAG_SET ##### -->
<para> <para>
set a flag in a buffer Set a flag in a buffer.
</para> </para>
@buf: GstBuffer to query @buf: GstBuffer to query
@ -47,7 +47,7 @@ set a flag in a buffer
<!-- ##### MACRO GST_BUFFER_FLAG_UNSET ##### --> <!-- ##### MACRO GST_BUFFER_FLAG_UNSET ##### -->
<para> <para>
clear a flag in a buffer Clear a flag in a buffer.
</para> </para>
@buf: GstBuffer to modify @buf: GstBuffer to modify
@ -64,7 +64,7 @@ Retrieves the type id of the data in the buffer.
<!-- ##### MACRO GST_BUFFER_DATA ##### --> <!-- ##### MACRO GST_BUFFER_DATA ##### -->
<para> <para>
retrieves a pointer to the data element of this buffer Retrieves a pointer to the data element of this buffer
</para> </para>
@buf: GstBuffer @buf: GstBuffer
@ -72,7 +72,7 @@ retrieves a pointer to the data element of this buffer
<!-- ##### MACRO GST_BUFFER_SIZE ##### --> <!-- ##### MACRO GST_BUFFER_SIZE ##### -->
<para> <para>
get the size of the data in this buffer Get the size of the data in this buffer.
</para> </para>
@buf: GstBuffer @buf: GstBuffer
@ -80,7 +80,7 @@ get the size of the data in this buffer
<!-- ##### MACRO GST_BUFFER_OFFSET ##### --> <!-- ##### MACRO GST_BUFFER_OFFSET ##### -->
<para> <para>
Get the offset in the source file of this buffer.
</para> </para>
@buf: GstBuffer @buf: GstBuffer
@ -96,7 +96,7 @@ get the size of the data in this buffer
<!-- ##### MACRO GST_BUFFER_TIMESTAMP ##### --> <!-- ##### MACRO GST_BUFFER_TIMESTAMP ##### -->
<para> <para>
get the timestamp for this buffer Get the timestamp for this buffer.
</para> </para>
@buf: GstBuffer @buf: GstBuffer
@ -124,7 +124,7 @@ FALSE if it can't get it immediately.
<!-- ##### MACRO GST_BUFFER_UNLOCK ##### --> <!-- ##### MACRO GST_BUFFER_UNLOCK ##### -->
<para> <para>
this macro releases a lock on the object. This macro releases a lock on the object.
</para> </para>
@ -134,6 +134,8 @@ this macro releases a lock on the object.
<!-- ##### ENUM GstBufferFlags ##### --> <!-- ##### ENUM GstBufferFlags ##### -->
<para> <para>
FIXME this is strange.
<informaltable pgwide=1 frame="none" role="enum"> <informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> <tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody> <tbody>

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

@ -20,7 +20,7 @@ a mime-type and a set of properties.
</para> </para>
@name: @name: the name of the capability, for the application
@id: the typeid of the capability @id: the typeid of the capability
@properties: the properties of the capability @properties: the properties of the capability

20
docs/gst/tmpl/gstdisksrc.sgml
View file

@ -33,23 +33,3 @@ with seeking capabilities use a <classname>GstAsynDiskSrc</classname> instead.
@GST_DISKSRC_OPEN: @GST_DISKSRC_OPEN:
@GST_DISKSRC_FLAG_LAST: @GST_DISKSRC_FLAG_LAST:
<!-- ##### ARG GstDiskSrc:location ##### -->
<para>
Specify the location of the file to read.
</para>
<!-- ##### ARG GstDiskSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>
<!-- ##### ARG GstDiskSrc:offset ##### -->
<para>
Get the current offset in the file.
</para>
<!-- ##### ARG GstDiskSrc:size ##### -->
<para>
</para>

66
docs/gst/tmpl/gstelement.sgml
View file

@ -55,7 +55,7 @@ can return after a state change.
<!-- ##### MACRO GST_STATE ##### --> <!-- ##### MACRO GST_STATE ##### -->
<para> <para>
This macro returns the entire state of the element. This macro returns the current state of the element.
</para> </para>
@obj: Element to return state for. @obj: Element to return state for.
@ -71,58 +71,57 @@ This macro returns the currently pending state of the element.
<!-- ##### MACRO GST_STATE_TRANSITION ##### --> <!-- ##### MACRO GST_STATE_TRANSITION ##### -->
<para> <para>
Returns the state transition this object is going through Returns the state transition this object is going through.
</para> </para>
@obj: the Element to return the tate transition for @obj: the Element to return the state transition for
<!-- ##### MACRO GST_STATE_NULL_TO_READY ##### --> <!-- ##### MACRO GST_STATE_NULL_TO_READY ##### -->
<para> <para>
The Element is going from the NULL state to the READY state The Element is going from the NULL state to the READY state.
</para> </para>
<!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### --> <!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
<para> <para>
The Element is going from the READY state to the PLAYING state The Element is going from the READY state to the PLAYING state.
</para> </para>
<!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### --> <!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### -->
<para> <para>
The Element is going from the PLAYING state to the PAUSED state The Element is going from the PLAYING state to the PAUSED state.
</para> </para>
<!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### --> <!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### -->
<para> <para>
The Element is going from the PAUSED state to the PLAYING state The Element is going from the PAUSED state to the PLAYING state.
</para> </para>
<!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### --> <!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
<para> <para>
The Element is going from the PLAYING state to the READY state The Element is going from the PLAYING state to the READY state.
</para> </para>
<!-- ##### MACRO GST_STATE_READY_TO_NULL ##### --> <!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
<para> <para>
The Element is going from the READY state to the NULL state The Element is going from the READY state to the NULL state.
</para> </para>
<!-- ##### ENUM GstElementFlags ##### --> <!-- ##### ENUM GstElementFlags ##### -->
<para> <para>
This enum defines the standard flags that an element This enum defines the standard flags that an element may have.
may have.
</para> </para>
@GST_ELEMENT_COMPLEX: @GST_ELEMENT_COMPLEX:
@ -136,7 +135,7 @@ may have.
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### --> <!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
<para> <para>
Queries whether the Element should be placed in a thread Queries whether the Element should be placed in a thread.
</para> </para>
@obj: The element to query @obj: The element to query
@ -144,7 +143,7 @@ Queries whether the Element should be placed in a thread
<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### --> <!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
<para> <para>
Queries whether the cothread holding this element needs to be stopped Queries whether the cothread holding this element needs to be stopped.
</para> </para>
@obj: The element to query @obj: The element to query
@ -512,44 +511,3 @@ circumstances.
@Returns: @Returns:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
Is trigered whenever the state of an element changes
</para>
@gstelement: the object which received the signal.
@arg1: the new state of the object
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
Is trigered whenever a new pad is added to an element
</para>
@gstelement: the object which received the signal.
@arg1: the new pad that was added
<!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
<para>
Is trigered whenever a new ghost pad is added to an element
</para>
@gstelement: the object which received the signal.
@arg1: the new ghost pad that was added
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
Is trigered whenever an error occured
</para>
@gstelement: the object which received the signal.
@arg1: the error message
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
</para>
@gstelement: the object which received the signal.

16
docs/gst/tmpl/gstesdsink.sgml
View file

@ -1,16 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstEsdSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

12
docs/gst/tmpl/gstfakesink.sgml
View file

@ -16,15 +16,3 @@ with the buffer. (fakesink)
</para> </para>
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
</para>
@gstfakesink: the object which received the signal.
<!-- ##### ARG GstFakeSink:num_sources ##### -->
<para>
</para>

32
docs/gst/tmpl/gstfakesrc.sgml
View file

@ -14,35 +14,3 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para> </para>
<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
<para>
</para>
@gstfakesrc: the object which received the signal.
<!-- ##### ARG GstFakeSrc:num_sources ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:loop_based ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:output ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:patern ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:num_buffers ##### -->
<para>
</para>

5
docs/gst/tmpl/gstfdsink.sgml
View file

@ -14,8 +14,3 @@ Write data to a file descriptor.
</para> </para>
<!-- ##### ARG GstFdSink:fd ##### -->
<para>
The filedescriptor to write to.
</para>

15
docs/gst/tmpl/gstfdsrc.sgml
View file

@ -14,18 +14,3 @@ Read buffers from a file descriptor.
</para> </para>
<!-- ##### ARG GstFdSrc:location ##### -->
<para>
The filedescriptor to read from. Pass the argument as a char* (???)
</para>
<!-- ##### ARG GstFdSrc:bytesperread ##### -->
<para>
The number of bytes per read.
</para>
<!-- ##### ARG GstFdSrc:offset ##### -->
<para>
Get the current offset in the file.
</para>

11
docs/gst/tmpl/gsthttpsrc.sgml
View file

@ -14,14 +14,3 @@ Reads data from a URL.
</para> </para>
<!-- ##### ARG GstHttpSrc:location ##### -->
<para>
Specify the location of the file. The location must be a fully qualified URL.
</para>
<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>

5
docs/gst/tmpl/gstidentity.sgml
View file

@ -14,8 +14,3 @@ Pass data without modification.
</para> </para>
<!-- ##### ARG GstIdentity:loop_based ##### -->
<para>
</para>

12
docs/gst/tmpl/gstmeta.sgml
View file

@ -109,7 +109,7 @@ it, is there?
<!-- ##### MACRO GST_META_FLAGS ##### --> <!-- ##### MACRO GST_META_FLAGS ##### -->
<para> <para>
Retrieve the flags of the given meta information Retrieve the flags of the given meta information.
</para> </para>
@meta: the meta information @meta: the meta information
@ -117,7 +117,7 @@ Retrieve the flags of the given meta information
<!-- ##### MACRO GST_META_FLAG_IS_SET ##### --> <!-- ##### MACRO GST_META_FLAG_IS_SET ##### -->
<para> <para>
Check if a given flag is set Check if a given flag is set.
</para> </para>
@meta: the meta data to test @meta: the meta data to test
@ -126,7 +126,7 @@ Check if a given flag is set
<!-- ##### MACRO GST_META_FLAG_SET ##### --> <!-- ##### MACRO GST_META_FLAG_SET ##### -->
<para> <para>
Set a flag in the meta data Set a flag in the meta data.
</para> </para>
@meta: the meta data @meta: the meta data
@ -135,7 +135,7 @@ Set a flag in the meta data
<!-- ##### MACRO GST_META_FLAG_UNSET ##### --> <!-- ##### MACRO GST_META_FLAG_UNSET ##### -->
<para> <para>
Clear a flag in the meta data Clear a flag in the meta data.
</para> </para>
@meta: the meta data @meta: the meta data
@ -144,7 +144,7 @@ Clear a flag in the meta data
<!-- ##### ENUM GstMetaFlags ##### --> <!-- ##### ENUM GstMetaFlags ##### -->
<para> <para>
Flags indicating properties about the meta data Flags indicating properties about the meta data.
</para> </para>
@GST_META_FREEABLE: the meta data can be freed @GST_META_FREEABLE: the meta data can be freed
@ -170,7 +170,7 @@ Flags indicating properties about the meta data
<!-- ##### MACRO gst_meta_new ##### --> <!-- ##### MACRO gst_meta_new ##### -->
<para> <para>
Create new meta data Create new meta data.
</para> </para>
@type: the type of the meta data to create @type: the type of the meta data to create

8
docs/gst/tmpl/gstobject.sgml
View file

@ -174,11 +174,3 @@ This macro releases a lock on the object.
@Returns: @Returns:
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
</para>
@gstobject: the object which received the signal.
@arg1: the new parent

39
docs/gst/tmpl/gstpad.sgml
View file

@ -18,7 +18,7 @@ connections.
<!-- ##### MACRO GST_PAD_CONNECTED ##### --> <!-- ##### MACRO GST_PAD_CONNECTED ##### -->
<para> <para>
is this pad connected Is this pad connected.
</para> </para>
@pad: the pad to check @pad: the pad to check
@ -26,7 +26,7 @@ is this pad connected
<!-- ##### MACRO GST_PAD_CAN_PULL ##### --> <!-- ##### MACRO GST_PAD_CAN_PULL ##### -->
<para> <para>
can this pad be used to pull a buffer Can this pad be used to pull a buffer.
</para> </para>
@pad: the pad to check @pad: the pad to check
@ -53,7 +53,7 @@ The function that will be called when pulling a buffer.
</para> </para>
@pad: the pad to get a buffer from @pad: the pad to get a buffer from
@Returns: a GstBuffer @Returns: a #GstBuffer
<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### --> <!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
@ -64,12 +64,12 @@ The function that will be called when pulling a region buffer.
@pad: the pad to get a buffer from @pad: the pad to get a buffer from
@offset: the offset of the region to get @offset: the offset of the region to get
@size: the size of the region to get @size: the size of the region to get
@Returns: a GstBuffer @Returns: a #GstBuffer
<!-- ##### USER_FUNCTION GstPadQoSFunction ##### --> <!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
<para> <para>
the function that will be called when a QoS message is sent. The function that will be called when a QoS message is sent.
</para> </para>
@pad: the pad that sent the QoS message @pad: the pad that sent the QoS message
@ -78,11 +78,11 @@ the function that will be called when a QoS message is sent.
<!-- ##### USER_FUNCTION GstPadEOSFunction ##### --> <!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
<para> <para>
The function that will be called in an EOS case.
</para> </para>
@pad: @pad: the pad that needs to be set to EOS state
@Returns: @Returns: TRUE if EOS was successful, FALSE otherwise
<!-- ##### USER_FUNCTION GstPadPushFunction ##### --> <!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
@ -117,7 +117,7 @@ The function that will be called when pulling a region buffer.
<!-- ##### ENUM GstPadDirection ##### --> <!-- ##### ENUM GstPadDirection ##### -->
<para> <para>
The direction this pad is The direction this pad is.
</para> </para>
@GST_PAD_UNKNOWN: direction is unknown @GST_PAD_UNKNOWN: direction is unknown
@ -126,7 +126,7 @@ The direction this pad is
<!-- ##### ENUM GstPadFlags ##### --> <!-- ##### ENUM GstPadFlags ##### -->
<para> <para>
Flags for the pad Flags for the pad.
</para> </para>
@GST_PAD_DISABLED: the pad is disabled @GST_PAD_DISABLED: the pad is disabled
@ -145,7 +145,7 @@ Flags for the pad
<!-- ##### MACRO gst_pad_destroy ##### --> <!-- ##### MACRO gst_pad_destroy ##### -->
<para> <para>
Destroy the pad Destroy the pad.
</para> </para>
@pad: the pad to destroy @pad: the pad to destroy
@ -449,20 +449,20 @@ Destroy the pad
<!-- ##### TYPEDEF GstPadFactoryEntry ##### --> <!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
<para> <para>
Defines an entry for a padfactory Defines an entry for a padfactory.
</para> </para>
<!-- ##### TYPEDEF GstPadFactory[] ##### --> <!-- ##### TYPEDEF GstPadFactory[] ##### -->
<para> <para>
The padfactory The padfactory.
</para> </para>
<!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### --> <!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
<para> <para>
Indicate that this pad will become available depending Indicate that this pad will become available depending
on the media type. Use this in the factory definition on the media type. Use this in the factory definition.
</para> </para>
@ -470,7 +470,7 @@ on the media type. Use this in the factory definition
<!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### --> <!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
<para> <para>
Indicate that this pad will always be available. Indicate that this pad will always be available.
Use this in the factory definition Use this in the factory definition.
</para> </para>
@ -491,7 +491,7 @@ Indicates a srcpad for the padfactory.
<!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### --> <!-- ##### MACRO GST_PAD_FACTORY_CAPS ##### -->
<para> <para>
Starts the declaration of a the capabilities for this padtemplate Starts the declaration of a the capabilities for this padtemplate.
</para> </para>
@a...: a capability factory @a...: a capability factory
@ -499,7 +499,7 @@ Starts the declaration of a the capabilities for this padtemplate
<!-- ##### ENUM GstPadPresence ##### --> <!-- ##### ENUM GstPadPresence ##### -->
<para> <para>
Indicates when this pad will become available Indicates when this pad will become available.
</para> </para>
@GST_PAD_ALWAYS: the pad is always available @GST_PAD_ALWAYS: the pad is always available
@ -556,8 +556,3 @@ Indicates when this pad will become available
@Returns: @Returns:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>

5
docs/gst/tmpl/gstpipefilter.sgml
View file

@ -15,8 +15,3 @@ buffers from its output.
</para> </para>
<!-- ##### ARG GstPipefilter:command ##### -->
<para>
Sets the command to be executed.
</para>

10
docs/gst/tmpl/gstpipeline.sgml
View file

@ -12,9 +12,11 @@ including threading, as well as provide simple interfaces to common
functions, like 'Play'. functions, like 'Play'.
</para> </para>
<para>the pipeline also has the capability to autoplug. This feature <para>
The pipeline also has the capability to autoplug. This feature
allows you to only define the input/output plugins and let the allows you to only define the input/output plugins and let the
pipeline figure out what plugins to use.</para> pipeline figure out what plugins to use.
</para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
@ -65,10 +67,10 @@ pipeline figure out what plugins to use.</para>
<!-- ##### MACRO gst_pipeline_destroy ##### --> <!-- ##### MACRO gst_pipeline_destroy ##### -->
<para> <para>
destroys the pipeline Destroys the pipeline.
</para> </para>
@pipeline: GstPipeline to destroy @pipeline: #GstPipeline to destroy
<!-- ##### FUNCTION gst_pipeline_iterate ##### --> <!-- ##### FUNCTION gst_pipeline_iterate ##### -->

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

@ -36,7 +36,7 @@ GstCaps
<!-- ##### MACRO GST_PROPS_LIST ##### --> <!-- ##### MACRO GST_PROPS_LIST ##### -->
<para> <para>
Create a list of properties Create a list of properties.
</para> </para>
@a...: the list of GstProps @a...: the list of GstProps
@ -44,7 +44,7 @@ Create a list of properties
<!-- ##### MACRO GST_PROPS_INT ##### --> <!-- ##### MACRO GST_PROPS_INT ##### -->
<para> <para>
Create an integer property Create an integer property.
</para> </para>
@a: the integer property @a: the integer property
@ -52,7 +52,7 @@ Create an integer property
<!-- ##### MACRO GST_PROPS_INT_RANGE ##### --> <!-- ##### MACRO GST_PROPS_INT_RANGE ##### -->
<para> <para>
Create an integer range property Create an integer range property.
</para> </para>
@a: the min value for the range @a: the min value for the range
@ -61,7 +61,7 @@ Create an integer range property
<!-- ##### MACRO GST_PROPS_FOURCC ##### --> <!-- ##### MACRO GST_PROPS_FOURCC ##### -->
<para> <para>
Construct a fourcc property out of four bytes Construct a fourcc property out of four bytes.
</para> </para>
@a: first byte @a: first byte
@ -72,7 +72,7 @@ Construct a fourcc property out of four bytes
<!-- ##### MACRO GST_PROPS_FOURCC_INT ##### --> <!-- ##### MACRO GST_PROPS_FOURCC_INT ##### -->
<para> <para>
Create a fourcc property out of an integer value Create a fourcc property out of an integer value.
</para> </para>
@a: the integer value @a: the integer value
@ -80,7 +80,7 @@ Create a fourcc property out of an integer value
<!-- ##### MACRO GST_PROPS_BOOLEAN ##### --> <!-- ##### MACRO GST_PROPS_BOOLEAN ##### -->
<para> <para>
Create a boolean property Create a boolean property.
</para> </para>
@a: the boolean property @a: the boolean property

16
docs/gst/tmpl/gstqueue.sgml
View file

@ -21,19 +21,3 @@ The default queue length is set to 10.
</para> </para>
<!-- ##### ARG GstQueue:level ##### -->
<para>
Get the number of buffers in the queue.
</para>
<!-- ##### ARG GstQueue:max_level ##### -->
<para>
Specify the maximum number of buffers in the queue before the queue
blocks.
</para>
<!-- ##### ARG GstQueue:block ##### -->
<para>
</para>

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

File diff suppressed because it is too large Load diff

20
docs/gst/tmpl/gstsinesrc.sgml
View file

@ -14,23 +14,3 @@ Create a sine wave of a given frequency and volume.
</para> </para>
<!-- ##### ARG GstSineSrc:volume ##### -->
<para>
The volume as a double 0.0 is silent, 1.0 is loudest.
</para>
<!-- ##### ARG GstSineSrc:format ##### -->
<para>
The format ad defined in soundcard.h
</para>
<!-- ##### ARG GstSineSrc:channels ##### -->
<para>
The number of channels.
</para>
<!-- ##### ARG GstSineSrc:frequency ##### -->
<para>
The fequency.
</para>

8
docs/gst/tmpl/gstthread.sgml
View file

@ -20,7 +20,7 @@ to be dealt with in the separate thread.
<!-- ##### ENUM GstThreadState ##### --> <!-- ##### ENUM GstThreadState ##### -->
<para> <para>
thread flags Thread flags:
</para> </para>
@GST_THREAD_CREATE: The thread is being created. @GST_THREAD_CREATE: The thread is being created.
@ -43,9 +43,3 @@ thread flags
@Returns: @Returns:
<!-- ##### ARG GstThread:create_thread ##### -->
<para>
TRUE if the thread should be created.
</para>

4
docs/gst/tmpl/gsttype.sgml
View file

@ -65,7 +65,7 @@ performed by a plugin.
<!-- ##### STRUCT GstType ##### --> <!-- ##### STRUCT GstType ##### -->
<para> <para>
A type A type.
</para> </para>
@id: @id:
@ -75,7 +75,7 @@ A type
<!-- ##### STRUCT GstTypeFactory ##### --> <!-- ##### STRUCT GstTypeFactory ##### -->
<para> <para>
The struct with the typefactory information The struct with the typefactory information.
</para> </para>
@mime: @mime:

13
docs/gst/tmpl/gsttypefind.sgml
View file

@ -15,16 +15,3 @@ the detected mime type of the stream. It is used in autoplugging.
</para> </para>
<!-- ##### SIGNAL GstTypeFind::have-type ##### -->
<para>
The signal to indicate the mime type was detected.
</para>
@gsttypefind: the object which received the signal.
@arg1: The mime type that was detected
<!-- ##### ARG GstTypeFind:caps ##### -->
<para>
</para>

2
gst/gstautoplug.c
View file

@ -200,7 +200,7 @@ gst_autoplug_caps_list (GList *srccaps, GList *sinkcaps)
* @srcpad: the source pad * @srcpad: the source pad
* @sinkpad: the sink pad * @sinkpad: the sink pad
* *
* Perform autoplugging between the two given pads * Perform autoplugging between the two given pads.
* *
* Returns: a list of elementfactories that can connect * Returns: a list of elementfactories that can connect
* the two pads * the two pads

10
gst/gstbin.c
View file

@ -385,7 +385,7 @@ gst_bin_real_destroy (GtkObject *object)
* @bin: #Gstbin to search * @bin: #Gstbin to search
* @name: the element name to search for * @name: the element name to search for
* *
* get the element with the given name from this bin * Get the element with the given name from this bin.
* *
* Returns: the element with the given name * Returns: the element with the given name
*/ */
@ -422,7 +422,7 @@ gst_bin_get_by_name (GstBin *bin,
* gst_bin_get_list: * gst_bin_get_list:
* @bin: #Gstbin to get the list from * @bin: #Gstbin to get the list from
* *
* get the list of elements in this bin * Get the list of elements in this bin.
* *
* Returns: a GList of elements * Returns: a GList of elements
*/ */
@ -503,7 +503,7 @@ gst_bin_use_cothreads (GstBin *bin,
* gst_bin_iterate: * gst_bin_iterate:
* @bin: #Gstbin to iterate * @bin: #Gstbin to iterate
* *
* iterates over the elements in this bin * Iterates over the elements in this bin.
*/ */
void void
gst_bin_iterate (GstBin *bin) gst_bin_iterate (GstBin *bin)
@ -524,7 +524,7 @@ gst_bin_iterate (GstBin *bin)
* gst_bin_create_plan: * gst_bin_create_plan:
* @bin: #GstBin to create the plan for * @bin: #GstBin to create the plan for
* *
* let the bin figure out how to handle the plugins in it. * Let the bin figure out how to handle its children.
*/ */
void void
gst_bin_create_plan (GstBin *bin) gst_bin_create_plan (GstBin *bin)
@ -541,7 +541,7 @@ gst_bin_create_plan (GstBin *bin)
* gst_bin_schedule: * gst_bin_schedule:
* @bin: #GstBin to schedule * @bin: #GstBin to schedule
* *
* let the bin figure out how to handle the plugins in it. * Let the bin figure out how to handle its children.
*/ */
void void
gst_bin_schedule (GstBin *bin) gst_bin_schedule (GstBin *bin)

14
gst/gstbuffer.c
View file

@ -244,7 +244,7 @@ void gst_buffer_destroy (GstBuffer *buffer)
* gst_buffer_ref: * gst_buffer_ref:
* @buffer: the GstBuffer to reference * @buffer: the GstBuffer to reference
* *
* increment the refcount of this buffer * Increment the refcount of this buffer.
*/ */
void void
gst_buffer_ref (GstBuffer *buffer) gst_buffer_ref (GstBuffer *buffer)
@ -269,7 +269,7 @@ gst_buffer_ref (GstBuffer *buffer)
* @buffer: the GstBuffer to reference * @buffer: the GstBuffer to reference
* @count: a number * @count: a number
* *
* increment the refcount of this buffer with count * Increment the refcount of this buffer by the given number.
*/ */
void void
gst_buffer_ref_by_count (GstBuffer *buffer, int count) gst_buffer_ref_by_count (GstBuffer *buffer, int count)
@ -292,7 +292,7 @@ gst_buffer_ref_by_count (GstBuffer *buffer, int count)
* gst_buffer_unref: * gst_buffer_unref:
* @buffer: the GstBuffer to unref * @buffer: the GstBuffer to unref
* *
* decrement the refcount of this buffer. If the refcount is * Decrement the refcount of this buffer. If the refcount is
* zero, the buffer will be destroyed. * zero, the buffer will be destroyed.
*/ */
void void
@ -333,7 +333,7 @@ gst_buffer_unref (GstBuffer *buffer)
* @buffer: the GstBuffer to add the metadata to * @buffer: the GstBuffer to add the metadata to
* @meta: the metadata to add to this buffer * @meta: the metadata to add to this buffer
* *
* add the meta data to the buffer * Add the meta data to the buffer.
*/ */
void void
gst_buffer_add_meta (GstBuffer *buffer, GstMeta *meta) gst_buffer_add_meta (GstBuffer *buffer, GstMeta *meta)
@ -349,7 +349,7 @@ gst_buffer_add_meta (GstBuffer *buffer, GstMeta *meta)
* gst_buffer_get_metas: * gst_buffer_get_metas:
* @buffer: the GstBuffer to get the metadata from * @buffer: the GstBuffer to get the metadata from
* *
* get the metadatas from the buffer * Get the metadatas from the buffer.
* *
* Returns: a GSList of metadata * Returns: a GSList of metadata
*/ */
@ -365,7 +365,7 @@ gst_buffer_get_metas (GstBuffer *buffer)
* gst_buffer_get_first_meta: * gst_buffer_get_first_meta:
* @buffer: the GstBuffer to get the metadata from * @buffer: the GstBuffer to get the metadata from
* *
* get the first metadata from the buffer * Get the first metadata from the buffer.
* *
* Returns: the first metadata from the buffer * Returns: the first metadata from the buffer
*/ */
@ -384,7 +384,7 @@ gst_buffer_get_first_meta (GstBuffer *buffer)
* @buffer: the GstBuffer to remove the metadata from * @buffer: the GstBuffer to remove the metadata from
* @meta: the metadata to remove * @meta: the metadata to remove
* *
* remove the given metadata from the buffer * Remove the given metadata from the buffer.
*/ */
void void
gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta) gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta)

4
gst/gstbufferpool.c
View file

@ -91,7 +91,7 @@ gst_buffer_pool_set_destroy_function (GstBufferPool *pool,
* gst_buffer_pool_destroy: * gst_buffer_pool_destroy:
* @pool: the pool to destroy * @pool: the pool to destroy
* *
* frees the memory for this bufferpool * Frees the memory for this bufferpool.
*/ */
void void
gst_buffer_pool_destroy (GstBufferPool *pool) gst_buffer_pool_destroy (GstBufferPool *pool)
@ -105,7 +105,7 @@ gst_buffer_pool_destroy (GstBufferPool *pool)
* gst_buffer_pool_new_buffer: * gst_buffer_pool_new_buffer:
* @pool: the pool to create the buffer from * @pool: the pool to create the buffer from
* *
* uses the given pool to create a new buffer. * Uses the given pool to create a new buffer.
* *
* Returns: The new buffer * Returns: The new buffer
*/ */

47
gst/gstcaps.c
View file

@ -57,7 +57,7 @@ get_type_for_mime (const gchar *mime)
* @name: the name of this capability * @name: the name of this capability
* @mime: the mime type to attach to the capability * @mime: the mime type to attach to the capability
* *
* create a new capability with the given mime type * Create a new capability with the given mime type.
* *
* Returns: a new capability * Returns: a new capability
*/ */
@ -82,8 +82,7 @@ gst_caps_new (const gchar *name, const gchar *mime)
* @mime: the mime type to attach to the capability * @mime: the mime type to attach to the capability
* @props: the properties for this capability * @props: the properties for this capability
* *
* create a new capability with the given mime type * Create a new capability with the given mime type and the given properties.
* and the given properties
* *
* Returns: a new capability * Returns: a new capability
*/ */
@ -104,7 +103,7 @@ gst_caps_new_with_props (const gchar *name, const gchar *mime, GstProps *props)
* *
* Register the factory. * Register the factory.
* *
* Returns: The registered capability * Returns: the registered capability
*/ */
GstCaps* GstCaps*
gst_caps_register (GstCapsFactory *factory) gst_caps_register (GstCapsFactory *factory)
@ -121,7 +120,7 @@ gst_caps_register (GstCapsFactory *factory)
* *
* Register the factory. * Register the factory.
* *
* Returns: The registered capability * Returns: the registered capability
*/ */
GstCaps* GstCaps*
gst_caps_register_count (GstCapsFactory *factory, guint *counter) gst_caps_register_count (GstCapsFactory *factory, guint *counter)
@ -160,9 +159,9 @@ gst_caps_register_count (GstCapsFactory *factory, guint *counter)
* gst_caps_get_name: * gst_caps_get_name:
* @caps: the caps to get the name from * @caps: the caps to get the name from
* *
* get the name of a GstCaps structure * Get the name of a GstCaps structure.
* *
* Returns: The name of the caps * Returns: the name of the caps
*/ */
const gchar* const gchar*
gst_caps_get_name (GstCaps *caps) gst_caps_get_name (GstCaps *caps)
@ -177,7 +176,7 @@ gst_caps_get_name (GstCaps *caps)
* @caps: the caps to set the name to * @caps: the caps to set the name to
* @name: the name to set * @name: the name to set
* *
* set the name of a caps * Set the name of a caps.
*/ */
void void
gst_caps_set_name (GstCaps *caps, const gchar *name) gst_caps_set_name (GstCaps *caps, const gchar *name)
@ -194,9 +193,9 @@ gst_caps_set_name (GstCaps *caps, const gchar *name)
* gst_caps_get_mime: * gst_caps_get_mime:
* @caps: the caps to get the mime type from * @caps: the caps to get the mime type from
* *
* get the mime type of the caps as a string * Get the mime type of the caps as a string.
* *
* Returns: The mime type of the caps * Returns: the mime type of the caps
*/ */
const gchar* const gchar*
gst_caps_get_mime (GstCaps *caps) gst_caps_get_mime (GstCaps *caps)
@ -218,7 +217,7 @@ gst_caps_get_mime (GstCaps *caps)
* @caps: the caps to set the mime type to * @caps: the caps to set the mime type to
* @mime: the mime type to attach to the caps * @mime: the mime type to attach to the caps
* *
* set the mime type of the caps as a string * Set the mime type of the caps as a string.
*/ */
void void
gst_caps_set_mime (GstCaps *caps, const gchar *mime) gst_caps_set_mime (GstCaps *caps, const gchar *mime)
@ -233,9 +232,9 @@ gst_caps_set_mime (GstCaps *caps, const gchar *mime)
* gst_caps_get_type_id: * gst_caps_get_type_id:
* @caps: the caps to get the type id from * @caps: the caps to get the type id from
* *
* get the type id of the caps * Get the type id of the caps.
* *
* Returns: The type id of the caps * Returns: the type id of the caps
*/ */
guint16 guint16
gst_caps_get_type_id (GstCaps *caps) gst_caps_get_type_id (GstCaps *caps)
@ -250,7 +249,7 @@ gst_caps_get_type_id (GstCaps *caps)
* @caps: the caps to set the type id to * @caps: the caps to set the type id to
* @typeid: the type id to set * @typeid: the type id to set
* *
* set the type id of the caps * Set the type id of the caps.
*/ */
void void
gst_caps_set_type_id (GstCaps *caps, guint16 typeid) gst_caps_set_type_id (GstCaps *caps, guint16 typeid)
@ -265,9 +264,9 @@ gst_caps_set_type_id (GstCaps *caps, guint16 typeid)
* @caps: the caps to attach the properties to * @caps: the caps to attach the properties to
* @props: the properties to attach * @props: the properties to attach
* *
* set the properties to the given caps * Set the properties to the given caps.
* *
* Returns: The new caps structure * Returns: the new caps structure
*/ */
GstCaps* GstCaps*
gst_caps_set_props (GstCaps *caps, GstProps *props) gst_caps_set_props (GstCaps *caps, GstProps *props)
@ -285,9 +284,9 @@ gst_caps_set_props (GstCaps *caps, GstProps *props)
* gst_caps_get_props: * gst_caps_get_props:
* @caps: the caps to get the properties from * @caps: the caps to get the properties from
* *
* get the properties of the given caps * Get the properties of the given caps.
* *
* Returns: The properties of the caps * Returns: the properties of the caps
*/ */
GstProps* GstProps*
gst_caps_get_props (GstCaps *caps) gst_caps_get_props (GstCaps *caps)
@ -302,9 +301,9 @@ gst_caps_get_props (GstCaps *caps)
* @fromcaps: a capabilty * @fromcaps: a capabilty
* @tocaps: a capabilty * @tocaps: a capabilty
* *
* Checks whether two capabilities are compatible * Checks whether two capabilities are compatible.
* *
* Returns: true if compatible, false otherwise * Returns: TRUE if compatible, FALSE otherwise
*/ */
gboolean gboolean
gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps) gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps)
@ -338,9 +337,9 @@ gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps)
* @fromcaps: a capabilty * @fromcaps: a capabilty
* @tocaps: a capabilty * @tocaps: a capabilty
* *
* Checks whether two capability lists are compatible * Checks whether two capability lists are compatible.
* *
* Returns: true if compatible, false otherwise * Returns: TRUE if compatible, FALSE otherwise
*/ */
gboolean gboolean
gst_caps_list_check_compatibility (GList *fromcaps, GList *tocaps) gst_caps_list_check_compatibility (GList *fromcaps, GList *tocaps)
@ -367,7 +366,7 @@ gst_caps_list_check_compatibility (GList *fromcaps, GList *tocaps)
* @caps: a capabilty to save * @caps: a capabilty to save
* @parent: the parent XML node pointer * @parent: the parent XML node pointer
* *
* save the capability into an XML representation * Save the capability into an XML representation.
* *
* Returns: a new XML node pointer * Returns: a new XML node pointer
*/ */
@ -393,7 +392,7 @@ gst_caps_save_thyself (GstCaps *caps, xmlNodePtr parent)
* gst_caps_load_thyself: * gst_caps_load_thyself:
* @parent: the parent XML node pointer * @parent: the parent XML node pointer
* *
* load a new caps from the XML representation * Load a new caps from the XML representation.
* *
* Returns: a new capability * Returns: a new capability
*/ */

7
gst/gstelement.c
View file

@ -595,7 +595,7 @@ static gchar *_gst_element_type_names[] = {
* @element: GstElement to save * @element: GstElement to save
* @parent: the xml parent node * @parent: the xml parent node
* *
* saves the element * Saves the element as part of the given XML structure
* *
* Returns: the new xml node * Returns: the new xml node
*/ */
@ -707,7 +707,7 @@ gst_element_save_thyself (GstElement *element,
* @elements: a hashtable to store the elements in. This is used * @elements: a hashtable to store the elements in. This is used
* to resolve inter element dependecies during the loading. * to resolve inter element dependecies during the loading.
* *
* load the element based on the XML description * Load the element from the XML description
* *
* Returns: the new element * Returns: the new element
*/ */
@ -907,8 +907,7 @@ gst_element_set_loop_function(GstElement *element,
* gst_element_signal_eos: * gst_element_signal_eos:
* @element: element to trigger the eos signal of * @element: element to trigger the eos signal of
* *
* singals the eos signal to indicate that the end of the stream * Throws the eos signal to indicate that the end of the stream is reached.
* is reached.
*/ */
void void
gst_element_signal_eos (GstElement *element) gst_element_signal_eos (GstElement *element)

12
gst/gstelementfactory.c
View file

@ -224,7 +224,7 @@ gst_elementfactory_add_padtemplate (GstElementFactory *factory,
* @factory: factory to query * @factory: factory to query
* @caps: the caps list to check * @caps: the caps list to check
* *
* Checks if the factory can source the given capability list * Checks if the factory can source the given capability list.
* *
* Returns: true if it can src the capabilities * Returns: true if it can src the capabilities
*/ */
@ -257,7 +257,7 @@ gst_elementfactory_can_src_caps_list (GstElementFactory *factory,
* @factory: factory to query * @factory: factory to query
* @caps: the caps list to check * @caps: the caps list to check
* *
* Checks if the factory can sink the given capability list * Checks if the factory can sink the given capability list.
* *
* Returns: true if it can sink the capabilities * Returns: true if it can sink the capabilities
*/ */
@ -290,7 +290,7 @@ gst_elementfactory_can_sink_caps_list (GstElementFactory *factory,
* @factory: factory to query * @factory: factory to query
* @caps: the caps to check * @caps: the caps to check
* *
* Checks if the factory can src the given capability * Checks if the factory can src the given capability.
* *
* Returns: true if it can sink the capability * Returns: true if it can sink the capability
*/ */
@ -315,7 +315,7 @@ gst_elementfactory_can_src_caps (GstElementFactory *factory,
* @factory: factory to query * @factory: factory to query
* @caps: the caps to check * @caps: the caps to check
* *
* Checks if the factory can sink the given capability * Checks if the factory can sink the given capability.
* *
* Returns: true if it can sink the capability * Returns: true if it can sink the capability
*/ */
@ -340,7 +340,7 @@ gst_elementfactory_can_sink_caps (GstElementFactory *factory,
* @factory: factory to save * @factory: factory to save
* @parent: the parent xmlNodePtr * @parent: the parent xmlNodePtr
* *
* Saves the factory into an XML tree * Saves the factory into an XML tree.
* *
* Returns: the new xmlNodePtr * Returns: the new xmlNodePtr
*/ */
@ -379,7 +379,7 @@ gst_elementfactory_save_thyself (GstElementFactory *factory,
* gst_elementfactory_load_thyself: * gst_elementfactory_load_thyself:
* @parent: the parent xmlNodePtr * @parent: the parent xmlNodePtr
* *
* Creates a new factory from an xmlNodePtr * Creates a new factory from an xmlNodePtr.
* *
* Returns: the new factory * Returns: the new factory
*/ */

8
gst/gstmeta.c
View file

@ -30,7 +30,7 @@
* gst_meta_new_size: * gst_meta_new_size:
* @size: the size of the new meta data * @size: the size of the new meta data
* *
* Create a new metadata object with a given size * Create a new metadata object with a given size.
* *
* Returns: new meta object * Returns: new meta object
*/ */
@ -49,7 +49,7 @@ gst_meta_new_size (gint size)
* gst_meta_ref: * gst_meta_ref:
* @meta: the meta object to ref * @meta: the meta object to ref
* *
* increases the refcount of a meta object * Increases the refcount of a meta object.
*/ */
void void
gst_meta_ref (GstMeta *meta) gst_meta_ref (GstMeta *meta)
@ -69,7 +69,7 @@ gst_meta_ref (GstMeta *meta)
* gst_meta_unref: * gst_meta_unref:
* @meta: the meta object to unref * @meta: the meta object to unref
* *
* decreases the refcount of a meta object. if the refcount is zero, the * Decreases the refcount of a meta object. If the refcount is zero, the
* meta object is freed. * meta object is freed.
*/ */
void void
@ -97,7 +97,7 @@ gst_meta_unref (GstMeta *meta)
* gst_meta_cow: * gst_meta_cow:
* @meta: the meta object prepare for write * @meta: the meta object prepare for write
* *
* prepares a meta object for writing. A copy of the meta * Prepares a meta object for writing. A copy of the meta
* object is returned if needed. * object is returned if needed.
* *
* Returns: the meta object or a copy. * Returns: the meta object or a copy.

60
gst/gstpad.c
View file

@ -220,7 +220,7 @@ gst_pad_new_from_template (GstPadTemplate *temp,
* gst_pad_get_direction: * gst_pad_get_direction:
* @pad: the Pad to get the direction from * @pad: the Pad to get the direction from
* *
* get the direction of the pad * Get the direction of the pad.
* *
* Returns: the direction of the pad * Returns: the direction of the pad
*/ */
@ -238,7 +238,7 @@ gst_pad_get_direction (GstPad *pad)
* @pad: the pad to set the name of * @pad: the pad to set the name of
* @name: the name of the pad * @name: the name of the pad
* *
* set the name of a pad * Set the name of a pad.
*/ */
void void
gst_pad_set_name (GstPad *pad, gst_pad_set_name (GstPad *pad,
@ -257,7 +257,7 @@ gst_pad_set_name (GstPad *pad,
* gst_pad_get_name: * gst_pad_get_name:
* @pad: the pad to get the name of * @pad: the pad to get the name of
* *
* get the name of a pad * Get the name of a pad.
* *
* Returns: the name of the pad, don't free. * Returns: the name of the pad, don't free.
*/ */
@ -275,7 +275,7 @@ gst_pad_get_name (GstPad *pad)
* @pad: the pad to set the chain function for * @pad: the pad to set the chain function for
* @chain: the chain function * @chain: the chain function
* *
* Set the given chain function for the pad * Set the given chain function for the pad.
*/ */
void gst_pad_set_chain_function (GstPad *pad, void gst_pad_set_chain_function (GstPad *pad,
GstPadChainFunction chain) GstPadChainFunction chain)
@ -291,7 +291,7 @@ void gst_pad_set_chain_function (GstPad *pad,
* @pad: the pad to set the get function for * @pad: the pad to set the get function for
* @get: the get function * @get: the get function
* *
* Set the given get function for the pad * Set the given get function for the pad.
*/ */
void void
gst_pad_set_get_function (GstPad *pad, gst_pad_set_get_function (GstPad *pad,
@ -312,7 +312,7 @@ gst_pad_set_get_function (GstPad *pad,
* @pad: the pad to set the getregion function for * @pad: the pad to set the getregion function for
* @getregion: the getregion function * @getregion: the getregion function
* *
* Set the given getregion function for the pad * Set the given getregion function for the pad.
*/ */
void void
gst_pad_set_getregion_function (GstPad *pad, gst_pad_set_getregion_function (GstPad *pad,
@ -331,7 +331,7 @@ gst_pad_set_getregion_function (GstPad *pad,
* @pad: the pad to set the qos function for * @pad: the pad to set the qos function for
* @qos: the qos function * @qos: the qos function
* *
* Set the given qos function for the pad * Set the given qos function for the pad.
*/ */
void void
gst_pad_set_qos_function (GstPad *pad, gst_pad_set_qos_function (GstPad *pad,
@ -348,7 +348,7 @@ gst_pad_set_qos_function (GstPad *pad,
* @pad: the pad to set the eos function for * @pad: the pad to set the eos function for
* @eos: the eos function * @eos: the eos function
* *
* Set the given EOS function for the pad * Set the given EOS function for the pad.
*/ */
void void
gst_pad_set_eos_function (GstPad *pad, gst_pad_set_eos_function (GstPad *pad,
@ -377,7 +377,7 @@ gst_pad_push_func(GstPad *pad, GstBuffer *buf)
* gst_pad_chain: * gst_pad_chain:
* @pad: the pad to chain * @pad: the pad to chain
* *
* call the chain function of the given pad * Call the chain function of the given pad.
*/ */
void void
gst_pad_chain (GstPad *pad) gst_pad_chain (GstPad *pad)
@ -397,7 +397,7 @@ gst_pad_chain (GstPad *pad)
* @pad: the pad to handle the QoS message * @pad: the pad to handle the QoS message
* @qos_message: the QoS message to handle * @qos_message: the QoS message to handle
* *
* pass the qos message downstream * Pass the qos message downstream.
*/ */
void void
gst_pad_handle_qos(GstPad *pad, gst_pad_handle_qos(GstPad *pad,
@ -434,7 +434,7 @@ gst_pad_handle_qos(GstPad *pad,
* @srcpad: the source pad to disconnect * @srcpad: the source pad to disconnect
* @sinkpad: the sink pad to disconnect * @sinkpad: the sink pad to disconnect
* *
* disconnects the source pad from the sink pad * Disconnects the source pad from the sink pad.
*/ */
void void
gst_pad_disconnect (GstPad *srcpad, gst_pad_disconnect (GstPad *srcpad,
@ -464,7 +464,7 @@ gst_pad_disconnect (GstPad *srcpad,
* @srcpad: the source pad to connect * @srcpad: the source pad to connect
* @sinkpad: the sink pad to connect * @sinkpad: the sink pad to connect
* *
* connects the source pad to the sink pad * Connects the source pad to the sink pad.
*/ */
void void
gst_pad_connect (GstPad *srcpad, gst_pad_connect (GstPad *srcpad,
@ -521,7 +521,7 @@ gst_pad_connect (GstPad *srcpad,
* @pad: the pad to set the parent * @pad: the pad to set the parent
* @parent: the object to set the parent to * @parent: the object to set the parent to
* *
* sets the parent object of a pad. * Sets the parent object of a pad.
*/ */
void void
gst_pad_set_parent (GstPad *pad, gst_pad_set_parent (GstPad *pad,
@ -544,7 +544,7 @@ gst_pad_set_parent (GstPad *pad,
* @pad: the pad to set the ghost parent * @pad: the pad to set the ghost parent
* @parent: the object to set the ghost parent to * @parent: the object to set the ghost parent to
* *
* add a ghost parent object to a pad. * Add a ghost parent object to a pad.
*/ */
void void
gst_pad_add_ghost_parent (GstPad *pad, gst_pad_add_ghost_parent (GstPad *pad,
@ -564,7 +564,7 @@ gst_pad_add_ghost_parent (GstPad *pad,
* @pad: the pad to remove the ghost parent * @pad: the pad to remove the ghost parent
* @parent: the object to remove the ghost parent from * @parent: the object to remove the ghost parent from
* *
* remove a ghost parent object from a pad. * Remove a ghost parent object from a pad.
*/ */
void void
gst_pad_remove_ghost_parent (GstPad *pad, gst_pad_remove_ghost_parent (GstPad *pad,
@ -582,7 +582,7 @@ gst_pad_remove_ghost_parent (GstPad *pad,
* gst_pad_get_parent: * gst_pad_get_parent:
* @pad: the pad to get the parent from * @pad: the pad to get the parent from
* *
* get the parent object of this pad * Get the parent object of this pad.
* *
* Returns: the parent object * Returns: the parent object
*/ */
@ -599,9 +599,9 @@ gst_pad_get_parent (GstPad *pad)
* gst_pad_get_ghost_parents: * gst_pad_get_ghost_parents:
* @pad: the pad to get the ghost parents from * @pad: the pad to get the ghost parents from
* *
* get the ghost parents of this pad * Get the ghost parents of this pad.
* *
* Returns: a list of ghost parent objects * Returns: a GList of ghost parent objects
*/ */
GList* GList*
gst_pad_get_ghost_parents (GstPad *pad) gst_pad_get_ghost_parents (GstPad *pad)
@ -617,7 +617,7 @@ gst_pad_get_ghost_parents (GstPad *pad)
* @pad: the pad to set the caps to * @pad: the pad to set the caps to
* @caps: the capslist to attach to this pad * @caps: the capslist to attach to this pad
* *
* set the capabilities of this pad * Set the capabilities of this pad.
*/ */
void void
gst_pad_set_caps_list (GstPad *pad, gst_pad_set_caps_list (GstPad *pad,
@ -633,7 +633,7 @@ gst_pad_set_caps_list (GstPad *pad,
* gst_pad_get_caps_list: * gst_pad_get_caps_list:
* @pad: the pad to get the capabilities from * @pad: the pad to get the capabilities from
* *
* get the capabilities of this pad * Get the capabilities of this pad.
* *
* Returns: a list of capabilities of this pad * Returns: a list of capabilities of this pad
*/ */
@ -651,7 +651,7 @@ gst_pad_get_caps_list (GstPad *pad)
* @pad: the pad to get the capabilities from * @pad: the pad to get the capabilities from
* @name: the name of the capability to get * @name: the name of the capability to get
* *
* get the capabilities with the given name from this pad * Get the capabilities with the given name from this pad.
* *
* Returns: a capability or NULL if not found * Returns: a capability or NULL if not found
*/ */
@ -682,9 +682,9 @@ gst_pad_get_caps_by_name (GstPad *pad, gchar *name)
* @srcpad: the srcpad to check * @srcpad: the srcpad to check
* @sinkpad: the sinkpad to check against * @sinkpad: the sinkpad to check against
* *
* check if two pads have compatible capabilities * Check if two pads have compatible capabilities.
* *
* Returns: TRUE if they are compatible ot the capabilities * Returns: TRUE if they are compatible or the capabilities
* could not be checked * could not be checked
*/ */
gboolean gboolean
@ -714,7 +714,7 @@ gst_pad_check_compatibility (GstPad *srcpad, GstPad *sinkpad)
* gst_pad_get_peer: * gst_pad_get_peer:
* @pad: the pad to get the peer from * @pad: the pad to get the peer from
* *
* Get the peer pad of this pad * Get the peer pad of this pad.
* *
* Returns: the peer pad * Returns: the peer pad
*/ */
@ -828,7 +828,7 @@ gst_pad_save_thyself (GstPad *pad,
* @bin: the bin * @bin: the bin
* @parent: the parent XML node to save the description in * @parent: the parent XML node to save the description in
* *
* Saves the ghost pad into an xml representation * Saves the ghost pad into an xml representation.
* *
* Returns: the xml representation of the pad * Returns: the xml representation of the pad
*/ */
@ -897,7 +897,7 @@ GstBuffer *gst_pad_pullregion(GstPad *pad,gulong offset,gulong size) {
* gst_padtemplate_new: * gst_padtemplate_new:
* @factory: the padfactory to use * @factory: the padfactory to use
* *
* creates a new padtemplate from the factory * Creates a new padtemplate from the factory.
* *
* Returns: the new padtemplate * Returns: the new padtemplate
*/ */
@ -941,7 +941,7 @@ gst_padtemplate_new (GstPadFactory *factory)
* @presence: the presence of the pad * @presence: the presence of the pad
* @caps: a list of capabilities for the template * @caps: a list of capabilities for the template
* *
* creates a new padtemplate from the given arguments * Creates a new padtemplate from the given arguments.
* *
* Returns: the new padtemplate * Returns: the new padtemplate
*/ */
@ -968,7 +968,7 @@ gst_padtemplate_create (gchar *name_template,
* @pad: the padtemplate to save * @pad: the padtemplate to save
* @parent: the parent XML tree * @parent: the parent XML tree
* *
* saves the padtemplate into XML * Saves the padtemplate into XML.
* *
* Returns: the new XML tree * Returns: the new XML tree
*/ */
@ -999,7 +999,7 @@ gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent)
* gst_padtemplate_load_thyself: * gst_padtemplate_load_thyself:
* @parent: the source XML tree * @parent: the source XML tree
* *
* loads a padtemplate from the XML tree * Loads a padtemplate from the XML tree.
* *
* Returns: the new padtemplate * Returns: the new padtemplate
*/ */
@ -1083,7 +1083,7 @@ gst_pad_eos_func(GstPad *pad)
* gst_pad_set_eos: * gst_pad_set_eos:
* @pad: the pad to set to eos * @pad: the pad to set to eos
* *
* sets the given pad to the eos state * Sets the given pad to the EOS state.
* *
* Returns: TRUE if it succeeded * Returns: TRUE if it succeeded
*/ */

4
gst/gstpipeline.c
View file

@ -279,7 +279,7 @@ gst_pipeline_add_src (GstPipeline *pipeline, GstElement *src)
* @sink: the sink to add to the pipeline * @sink: the sink to add to the pipeline
* *
* Adds a sink element to the pipeline. This element * Adds a sink element to the pipeline. This element
* will be used as a sink for autoplugging * will be used as a sink for autoplugging.
*/ */
void void
gst_pipeline_add_sink (GstPipeline *pipeline, GstElement *sink) gst_pipeline_add_sink (GstPipeline *pipeline, GstElement *sink)
@ -523,7 +523,7 @@ gst_pipeline_change_state (GstElement *element)
/** /**
* gst_pipeline_iterate: * gst_pipeline_iterate:
* @pipeline: GstPipeline to iterate * @pipeline: #GstPipeline to iterate
* *
* Cause the pipeline's contents to be run through one full 'iteration'. * Cause the pipeline's contents to be run through one full 'iteration'.
*/ */

20
gst/gstprops.c
View file

@ -103,7 +103,7 @@ props_compare_func (gconstpointer a,
* *
* Register the factory. * Register the factory.
* *
* Returns: The new property created from the factory * Returns: the new property created from the factory
*/ */
GstProps * GstProps *
gst_props_register (GstPropsFactory factory) gst_props_register (GstPropsFactory factory)
@ -120,7 +120,7 @@ gst_props_register (GstPropsFactory factory)
* *
* Register the factory. * Register the factory.
* *
* Returns: The new property created from the factory * Returns: the new property created from the factory
*/ */
GstProps * GstProps *
gst_props_register_count (GstPropsFactory factory, guint *counter) gst_props_register_count (GstPropsFactory factory, guint *counter)
@ -200,9 +200,9 @@ end:
* @entry: the property entries for the property * @entry: the property entries for the property
* @...: the property entries for the property * @...: the property entries for the property
* *
* Create a new property from the list of entries * Create a new property from the list of entries.
* *
* Returns: The new property created from the list of entries * Returns: the new property created from the list of entries
*/ */
GstProps * GstProps *
gst_props_new (GstPropsFactoryEntry entry, ...) gst_props_new (GstPropsFactoryEntry entry, ...)
@ -277,9 +277,9 @@ gst_props_new (GstPropsFactoryEntry entry, ...)
* @props: the property to merge into * @props: the property to merge into
* @tomerge: the property to merge * @tomerge: the property to merge
* *
* Merge the properties of tomerge into props * Merge the properties of tomerge into props.
* *
* Returns: The new merged property * Returns: the new merged property
*/ */
GstProps* GstProps*
gst_props_merge (GstProps *props, GstProps *tomerge) gst_props_merge (GstProps *props, GstProps *tomerge)
@ -405,9 +405,9 @@ gst_props_entry_check_compatibility (GstPropsEntry *entry1, GstPropsEntry *entry
* @fromprops: a property * @fromprops: a property
* @toprops: a property * @toprops: a property
* *
* Checks whether two capabilities are compatible * Checks whether two capabilities are compatible.
* *
* Returns: true if compatible, false otherwise * Returns: TRUE if compatible, FALSE otherwise
*/ */
gboolean gboolean
gst_props_check_compatibility (GstProps *fromprops, GstProps *toprops) gst_props_check_compatibility (GstProps *fromprops, GstProps *toprops)
@ -505,7 +505,7 @@ gst_props_save_thyself_func (GstPropsEntry *entry, xmlNodePtr parent)
* @props: a property to save * @props: a property to save
* @parent: the parent XML tree * @parent: the parent XML tree
* *
* saves the property into an XML representation * Saves the property into an XML representation.
* *
* Returns: the new XML tree * Returns: the new XML tree
*/ */
@ -574,7 +574,7 @@ gst_props_load_thyself_func (xmlNodePtr field)
* gst_props_load_thyself: * gst_props_load_thyself:
* @parent: the XML tree to load from * @parent: the XML tree to load from
* *
* creates a new property out of an XML tree * Creates a new property out of an XML tree.
* *
* Returns: the new property * Returns: the new property
*/ */

6
gst/gsttee.c
View file

@ -96,7 +96,7 @@ static void gst_tee_init(GstTee *tee) {
* gst_tee_new: * gst_tee_new:
* @name: the name of the new tee * @name: the name of the new tee
* *
* create a new tee element * Create a new tee element.
* *
* Returns: the new tee element * Returns: the new tee element
*/ */
@ -110,7 +110,7 @@ GstElement *gst_tee_new(gchar *name) {
* gst_tee_new_pad: * gst_tee_new_pad:
* @tee: the tee to create the new pad on * @tee: the tee to create the new pad on
* *
* create a new pad on a given tee * Create a new pad on a given tee.
* *
* Returns: the name of the new pad * Returns: the name of the new pad
*/ */
@ -134,7 +134,7 @@ gchar *gst_tee_new_pad(GstTee *tee) {
* @pad: the pad to follow * @pad: the pad to follow
* @buf: the buffer to pass * @buf: the buffer to pass
* *
* chain a buffer on a pad * Chain a buffer on a pad.
*/ */
void gst_tee_chain(GstPad *pad,GstBuffer *buf) { void gst_tee_chain(GstPad *pad,GstBuffer *buf) {
GstTee *tee; GstTee *tee;

2
gst/gstthread.c
View file

@ -192,7 +192,7 @@ gst_thread_get_arg (GtkObject *object,
* gst_thread_new: * gst_thread_new:
* @name: the name of the thread * @name: the name of the thread
* *
* Create a new thrad with the given name * Create a new thread with the given name.
* *
* Returns: The new thread * Returns: The new thread
*/ */

14
gst/gsttype.c
View file

@ -56,7 +56,7 @@ _gst_type_initialize (void)
* gst_type_register: * gst_type_register:
* @factory: the type factory to register * @factory: the type factory to register
* *
* register a new type factory to the system * Register a new type factory to the system.
* *
* Returns: the new type id * Returns: the new type id
*/ */
@ -138,7 +138,7 @@ guint16 gst_type_find_by_mime_func (const gchar *mime)
* gst_type_find_by_mime: * gst_type_find_by_mime:
* @mime: the mime type to find * @mime: the mime type to find
* *
* find the type id of a given mime type * Find the type id of a given mime type.
* *
* Returns: the type id * Returns: the type id
*/ */
@ -152,7 +152,7 @@ gst_type_find_by_mime (const gchar *mime)
* gst_type_find_by_ext: * gst_type_find_by_ext:
* @ext: the extension to find * @ext: the extension to find
* *
* find the type id of a given extention * Find the type id of a given extention.
* *
* Returns: the type id * Returns: the type id
*/ */
@ -168,7 +168,7 @@ gst_type_find_by_ext (const gchar *ext)
* gst_type_find_by_id: * gst_type_find_by_id:
* @id: the type id to lookup * @id: the type id to lookup
* *
* find the type of a given type id * Find the type of a given type id.
* *
* Returns: the type * Returns: the type
*/ */
@ -191,7 +191,7 @@ gst_type_find_by_id (guint16 id)
/** /**
* gst_type_get_list: * gst_type_get_list:
* *
* return a list of all registered types * Return a list of all registered types.
* *
* Returns: a list of GstTypes * Returns: a list of GstTypes
*/ */
@ -206,7 +206,7 @@ gst_type_get_list (void)
* @factory: the type factory to save * @factory: the type factory to save
* @parent: the parent node to save into * @parent: the parent node to save into
* *
* save a typefactory into an XML representation * Save a typefactory into an XML representation.
* *
* Returns: the new xmlNodePtr * Returns: the new xmlNodePtr
*/ */
@ -258,7 +258,7 @@ gst_type_typefind_dummy (GstBuffer *buffer, gpointer priv)
* gst_typefactory_load_thyself: * gst_typefactory_load_thyself:
* @parent: the parent node to load from * @parent: the parent node to load from
* *
* load a typefactory from an XML representation * Load a typefactory from an XML representation.
* *
* Returns: the new typefactory * Returns: the new typefactory
*/ */

19
gst/gstutils.c
View file

@ -28,7 +28,7 @@
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as an integer * Retrieves a property of an object as an integer.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -45,7 +45,7 @@ gint gst_util_get_int_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a boolean * Retrieves a property of an object as a boolean.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -62,7 +62,7 @@ gint gst_util_get_bool_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a long * Retrieves a property of an object as a long.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -79,7 +79,7 @@ glong gst_util_get_long_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a float * Retrieves a property of an object as a float.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -96,7 +96,7 @@ gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a double * Retrieves a property of an object as a double.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -113,7 +113,7 @@ gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a string * Retrieves a property of an object as a string.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -130,7 +130,7 @@ guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a pointer * Retrieves a property of an object as a pointer.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -147,7 +147,7 @@ gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) {
* @object: the object to query * @object: the object to query
* @argname: the name of the argument * @argname: the name of the argument
* *
* retrieves a property of an object as a widget * Retrieves a property of an object as a widget.
* *
* Returns: the property of the object * Returns: the property of the object
*/ */
@ -164,8 +164,7 @@ GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) {
* @mem: a pointer to the memory to dump * @mem: a pointer to the memory to dump
* @size: the size of the memory block to dump * @size: the size of the memory block to dump
* *
* dumps the memory block into a hex representation. usefull * Dumps the memory block into a hex representation. Useful for debugging.
* for debugging.
*/ */
void gst_util_dump_mem(guchar *mem, guint size) { void gst_util_dump_mem(guchar *mem, guint size) {
guint i, j; guint i, j;