Commit 3d34ce7b authored by Wim Taymans's avatar Wim Taymans

Updated the manual and the docs.

Original commit message from CVS:
Updated the manual and the docs.
Removed the esdsink in gst/elements/ we have a real one not in the
plugins dir.
Added more APIs to query the plugins, types and caps. more fields now
have a getter and a setter. This is needed to make gstreamer wrapper
fiendly.
Added gst_element_disconnect beacuse we also have a gst_element_connect
parent ded7ca66
......@@ -196,6 +196,7 @@ gst_element_get_padtemplate_list
gst_element_add_ghost_pad
gst_element_remove_ghost_pad
gst_element_connect
gst_element_disconnect
gst_element_set_state
gst_element_error
gst_element_get_factory
......@@ -339,8 +340,10 @@ gst_pad_push
gst_pad_pull
gst_pad_pull_region
gst_pad_pullregion
gst_pad_handle_qos
gst_pad_select
gst_pad_set_eos
gst_pad_eos_func
gst_pad_handle_qos
gst_pad_eos
gst_pad_save_thyself
gst_pad_load_and_connect
......@@ -426,7 +429,12 @@ GstPlugin
GstPluginElement
GstPluginInitFunc
gst_plugin_new
gst_plugin_set_name
gst_plugin_get_name
gst_plugin_get_longname
gst_plugin_set_longname
gst_plugin_get_filename
gst_plugin_is_loaded
gst_plugin_load_all
gst_plugin_load
gst_plugin_load_absolute
......@@ -435,6 +443,8 @@ gst_plugin_add_factory
gst_plugin_add_type
gst_plugin_find
gst_plugin_get_list
gst_plugin_get_factory_list
gst_plugin_get_type_list
gst_plugin_find_elementfactory
gst_plugin_load_elementfactory
gst_plugin_load_typefactory
......@@ -521,6 +531,12 @@ gst_caps_new
gst_caps_new_with_props
gst_caps_register
gst_caps_register_count
gst_caps_get_name
gst_caps_set_mime
gst_caps_set_type_id
gst_caps_get_type_id
gst_caps_get_mime
gst_caps_set_name
gst_caps_set_props
gst_caps_get_props
gst_caps_check_compatibility
......
......@@ -32,3 +32,23 @@ the offset.
@GST_ASYNCDISKSRC_OPEN:
@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>
......@@ -14,3 +14,32 @@ Output to a sound card via OSS.
</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>
......@@ -14,3 +14,28 @@ Create buffers from an OSS sound card.
</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>
......@@ -121,3 +121,12 @@ Flags for a 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
......@@ -78,6 +78,60 @@ a mime-type and a set of properties.
@count:
<!-- ##### FUNCTION gst_caps_get_name ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_set_mime ##### -->
<para>
</para>
@caps:
@mime:
<!-- ##### FUNCTION gst_caps_set_type_id ##### -->
<para>
</para>
@caps:
@typeid:
<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_get_mime ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_set_name ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_set_props ##### -->
<para>
......
......@@ -33,3 +33,23 @@ with seeking capabilities use a <classname>GstAsynDiskSrc</classname> instead.
@GST_DISKSRC_OPEN:
@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>
......@@ -319,6 +319,17 @@ circumstances.
@destpadname:
<!-- ##### FUNCTION gst_element_disconnect ##### -->
<para>
</para>
@src:
@srcpadname:
@dest:
@destpadname:
<!-- ##### FUNCTION gst_element_set_state ##### -->
<para>
......@@ -501,3 +512,44 @@ circumstances.
@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,3 +16,15 @@ with the buffer. (fakesink)
</para>
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
</para>
@gstfakesink: the object which received the signal.
<!-- ##### ARG GstFakeSink:num_sources ##### -->
<para>
</para>
......@@ -14,3 +14,35 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</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>
......@@ -14,3 +14,8 @@ Write data to a file descriptor.
</para>
<!-- ##### ARG GstFdSink:fd ##### -->
<para>
The filedescriptor to write to.
</para>
......@@ -14,3 +14,18 @@ Read buffers from a file descriptor.
</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>
......@@ -14,3 +14,14 @@ Reads data from a URL.
</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>
......@@ -14,3 +14,8 @@ Pass data without modification.
</para>
<!-- ##### ARG GstIdentity:loop_based ##### -->
<para>
</para>
......@@ -174,3 +174,11 @@ This macro releases a lock on the object.
@Returns:
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
</para>
@gstobject: the object which received the signal.
@arg1: the new parent
......@@ -382,13 +382,14 @@ Destroy the pad
@size:
<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
<!-- ##### FUNCTION gst_pad_select ##### -->
<para>
</para>
@pad:
@qos_message:
@nextpad:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_pad_set_eos ##### -->
......@@ -400,6 +401,24 @@ Destroy the pad
@Returns:
<!-- ##### FUNCTION gst_pad_eos_func ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
<para>
</para>
@pad:
@qos_message:
<!-- ##### MACRO gst_pad_eos ##### -->
<para>
......@@ -537,3 +556,8 @@ Indicates when this pad will become available
@Returns:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>
......@@ -15,3 +15,8 @@ buffers from its output.
</para>
<!-- ##### ARG GstPipefilter:command ##### -->
<para>
Sets the command to be executed.
</para>
......@@ -54,6 +54,33 @@ by the loader at statup.
@Returns:
<!-- ##### FUNCTION gst_plugin_set_name ##### -->
<para>
</para>
@plugin:
@name:
<!-- ##### FUNCTION gst_plugin_get_name ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_get_longname ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_set_longname ##### -->
<para>
......@@ -63,6 +90,24 @@ by the loader at statup.
@longname:
<!-- ##### FUNCTION gst_plugin_get_filename ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_is_loaded ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_all ##### -->
<para>
......@@ -132,6 +177,24 @@ by the loader at statup.
@Returns:
<!-- ##### FUNCTION gst_plugin_get_factory_list ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_find_elementfactory ##### -->
<para>
......
......@@ -21,3 +21,19 @@ The default queue length is set to 10.
</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>
This diff is collapsed.
......@@ -14,3 +14,23 @@ Create a sine wave of a given frequency and volume.
</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>
......@@ -43,3 +43,9 @@ thread flags
@Returns:
<!-- ##### ARG GstThread:create_thread ##### -->
<para>
TRUE if the thread should be created.
</para>
......@@ -15,3 +15,16 @@ the detected mime type of the stream. It is used in autoplugging.
</para>
<!-- ##### SIGNAL GstTypeFind::have-type ##### -->
<para>
The signal to indicate the mime type was detected.
</para>
@gsttypefind: the object which received the signal.