diff options
| author | Wim Taymans <wim.taymans@gmail.com> | 2001-01-06 02:35:17 +0000 |
|---|---|---|
| committer | Wim Taymans <wim.taymans@gmail.com> | 2001-01-06 02:35:17 +0000 |
| commit | 3d34ce7b95508781cbc182b4d6364a49d821e5ab (patch) | |
| tree | b4b79dbe89cf8a5c267dcc433df45e6df5cbd757 /docs | |
| parent | ded7ca661667d922aa8368955b8b485c467a6078 (diff) | |
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
Diffstat (limited to 'docs')
33 files changed, 1419 insertions, 969 deletions
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index bf15ac9723..253412bfcf 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -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 diff --git a/docs/gst/tmpl/gstasyncdisksrc.sgml b/docs/gst/tmpl/gstasyncdisksrc.sgml index b355753553..ca7479d480 100644 --- a/docs/gst/tmpl/gstasyncdisksrc.sgml +++ b/docs/gst/tmpl/gstasyncdisksrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstaudiosink.sgml b/docs/gst/tmpl/gstaudiosink.sgml index 8ec48a9cb6..87e51aa4d3 100644 --- a/docs/gst/tmpl/gstaudiosink.sgml +++ b/docs/gst/tmpl/gstaudiosink.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstaudiosrc.sgml b/docs/gst/tmpl/gstaudiosrc.sgml index 68dabaab9b..721a58f3e7 100644 --- a/docs/gst/tmpl/gstaudiosrc.sgml +++ b/docs/gst/tmpl/gstaudiosrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 5375c597c4..98f827e650 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -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 + diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 6c53861409..2394e02bbf 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -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> diff --git a/docs/gst/tmpl/gstdisksrc.sgml b/docs/gst/tmpl/gstdisksrc.sgml index d8516af222..67c4fd6366 100644 --- a/docs/gst/tmpl/gstdisksrc.sgml +++ b/docs/gst/tmpl/gstdisksrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index e5607c86cf..3f251ebe29 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -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. + diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml index 361a67d1a7..9d405d62f4 100644 --- a/docs/gst/tmpl/gstfakesink.sgml +++ b/docs/gst/tmpl/gstfakesink.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml index dfc2d57101..490bd541cd 100644 --- a/docs/gst/tmpl/gstfakesrc.sgml +++ b/docs/gst/tmpl/gstfakesrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstfdsink.sgml b/docs/gst/tmpl/gstfdsink.sgml index ec3e297b20..a9f7327643 100644 --- a/docs/gst/tmpl/gstfdsink.sgml +++ b/docs/gst/tmpl/gstfdsink.sgml @@ -14,3 +14,8 @@ Write data to a file descriptor. </para> +<!-- ##### ARG GstFdSink:fd ##### --> +<para> +The filedescriptor to write to. +</para> + diff --git a/docs/gst/tmpl/gstfdsrc.sgml b/docs/gst/tmpl/gstfdsrc.sgml index dd2c183b71..882a451986 100644 --- a/docs/gst/tmpl/gstfdsrc.sgml +++ b/docs/gst/tmpl/gstfdsrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gsthttpsrc.sgml b/docs/gst/tmpl/gsthttpsrc.sgml index 2ba4a00e8d..f1c74b859a 100644 --- a/docs/gst/tmpl/gsthttpsrc.sgml +++ b/docs/gst/tmpl/gsthttpsrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstidentity.sgml b/docs/gst/tmpl/gstidentity.sgml index e5a1a65bde..0ec323dfd4 100644 --- a/docs/gst/tmpl/gstidentity.sgml +++ b/docs/gst/tmpl/gstidentity.sgml @@ -14,3 +14,8 @@ Pass data without modification. </para> +<!-- ##### ARG GstIdentity:loop_based ##### --> +<para> + +</para> + diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index ee6cdd88ad..27f67cfa4e 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -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 + diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 03b0829f45..c8d7b6cc79 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstpipefilter.sgml b/docs/gst/tmpl/gstpipefilter.sgml index 968c3132aa..55f1469e74 100644 --- a/docs/gst/tmpl/gstpipefilter.sgml +++ b/docs/gst/tmpl/gstpipefilter.sgml @@ -15,3 +15,8 @@ buffers from its output. </para> +<!-- ##### ARG GstPipefilter:command ##### --> +<para> +Sets the command to be executed. +</para> + diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index 0818ade2e8..802959e05a 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -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> diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index 0363d626a7..e3ae1dfdaa 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 7792b6e986..c7336384bf 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -1,41 +1,44 @@ -<!-- ##### FUNCTION gst_fakesink_chain ##### --> +<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### --> <para> </para> -@pad: -@buf: +@obj: -<!-- ##### ARG GstTypeFind:type ##### --> +<!-- ##### STRUCT GstSineSrc ##### --> <para> -Query the element for the current mime type + </para> -<!-- ##### FUNCTION gst_object_get_type ##### --> +<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### --> <para> </para> -@Returns: -<!-- ##### STRUCT GstSineSrcClass ##### --> +<!-- ##### MACRO DEBUG_SET_STRING ##### --> <para> </para> +@format: +@args...: -<!-- ##### ARG GstAudioSink:mute ##### --> +<!-- ##### FUNCTION gst_type_add_sink ##### --> <para> </para> +@id: +@sink: -<!-- ##### STRUCT GstFakeSrc ##### --> +<!-- ##### FUNCTION gst_fakesrc_push ##### --> <para> </para> +@src: <!-- ##### FUNCTION gst_tee_get_type ##### --> <para> @@ -44,304 +47,249 @@ Query the element for the current mime type @Returns: -<!-- ##### MACRO GST_IS_SINK ##### --> +<!-- ##### MACRO GST_FAKESRC ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_META ##### --> -<para> - -</para> - -@meta: - -<!-- ##### MACRO GST_IS_CONNECTION ##### --> +<!-- ##### MACRO GST_IS_ESDSINK_CLASS ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_TYPE_FAKESINK ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gst_fdsink_chain ##### --> +<!-- ##### SIGNAL GstSrc::eos ##### --> <para> +An eos signal is triggered whenever the GstSrc has reached the end of +the stream. </para> -@pad: -@buf: - -<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### --> -<para> -This macro usets the given flags. -</para> - -@src: -@flag: Flag to set, must be a single bit in guint32. -@obj: GstSrc to unset flag in. +@gstsrc: the object which received the signal. +@arg1: the object which received the signal -<!-- ##### SIGNAL GstElement::new-ghost-pad ##### --> +<!-- ##### FUNCTION gst_fdsink_new ##### --> <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 +@name: +@Returns: -<!-- ##### ARG GstAudioSrc:frequency ##### --> +<!-- ##### STRUCT GstAsyncDiskSrcClass ##### --> <para> -The frequency. -</para> - -<!-- ##### ARG GstHttpSrc:location ##### --> -<para> -Specify the location of the file. The location must be a fully qualified URL. </para> -<!-- ##### FUNCTION gst_identity_chain ##### --> +<!-- ##### MACRO GST_IS_FILTER_CLASS ##### --> <para> </para> -@pad: -@buf: +@obj: -<!-- ##### FUNCTION gst_audiosink_chain ##### --> +<!-- ##### STRUCT GstPadClass ##### --> <para> </para> -@pad: -@buf: -<!-- ##### FUNCTION gst_connection_get_type ##### --> +<!-- ##### STRUCT GstBinClass ##### --> <para> </para> -@Returns: -<!-- ##### MACRO GST_PIPELINE_CLASS ##### --> +<!-- ##### STRUCT GstConnection ##### --> <para> </para> -@klass: -<!-- ##### FUNCTION gst_elementfactory_add_src ##### --> +<!-- ##### MACRO GST_FDSRC ##### --> <para> </para> -@elementfactory: -@id: +@obj: -<!-- ##### MACRO GST_IS_SINK_CLASS ##### --> +<!-- ##### MACRO GST_IS_AUDIOSRC ##### --> <para> </para> @obj: -<!-- ##### STRUCT GstConnectionClass ##### --> +<!-- ##### FUNCTION gst_fakesink_new ##### --> <para> </para> +@name: +@Returns: -<!-- ##### MACRO GST_IS_PIPELINE_CLASS ##### --> +<!-- ##### MACRO GST_PIPELINE ##### --> <para> </para> @obj: -<!-- ##### ARG GstSineSrc:channels ##### --> -<para> -The number of channels. -</para> - - -<!-- ##### MACRO GST_PROPS_INT_RANGE_ID ##### --> +<!-- ##### MACRO GST_TYPE_SINK ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Title ##### --> -GstEsdSink - - -<!-- ##### MACRO DEBUG ##### --> -<para> -Use this macro to show debugging info. This is only usefull when developing new -plugin elements. -If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce -g_print messages. -</para> - -@format: the format specification as in g_print -@args...: arguments - -<!-- ##### MACRO GST_TYPE_IDENTITY ##### --> +<!-- ##### MACRO DEBUG_ENTER ##### --> <para> </para> +@format: +@args...: -<!-- ##### FUNCTION gst_type_save_thyself ##### --> +<!-- ##### MACRO GST_IS_HTTPSRC ##### --> <para> </para> -@type: -@parent: -@Returns: +@obj: -<!-- ##### SIGNAL GstElement::state-change ##### --> +<!-- ##### MACRO GST_IS_ELEMENT ##### --> <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 +@obj: -<!-- ##### STRUCT GstAudioSrc ##### --> +<!-- ##### STRUCT GstQueue ##### --> <para> </para> -<!-- ##### MACRO GST_TYPE_ELEMENT ##### --> -<para> +<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Short_Description ##### --> -</para> -<!-- ##### FUNCTION gst_audiosrc_push ##### --> +<!-- ##### MACRO GST_PAD_CLASS ##### --> <para> </para> -@src: +@klass: -<!-- ##### MACRO GST_IS_FAKESRC_CLASS ##### --> +<!-- ##### MACRO GST_PIPELINE_CLASS ##### --> <para> </para> -@obj: +@klass: -<!-- ##### ARG GstFakeSrc:patern ##### --> +<!-- ##### MACRO GST_IS_ASYNCDISKSRC ##### --> <para> </para> +@obj: -<!-- ##### MACRO GST_AUDIOSINK ##### --> +<!-- ##### FUNCTION plugin_initialize ##### --> <para> </para> -@obj: -<!-- ##### SECTION ./tmpl/gstsrc.sgml:See_Also ##### --> +<!-- ##### FUNCTION gst_pad_get_type ##### --> <para> </para> +@Returns: -<!-- ##### FUNCTION gst_esdsink_set_format ##### --> +<!-- ##### MACRO GST_PROPS_INT_RANGE_ID ##### --> <para> </para> -@esdsink: -@format: -<!-- ##### SIGNAL GstSrc::eos ##### --> +<!-- ##### MACRO GST_SINESRC ##### --> <para> -An eos signal is triggered whenever the GstSrc has reached the end of -the stream. </para> -@gstsrc: the object which received the signal. -@arg1: the object which received the signal +@obj: -<!-- ##### STRUCT GstIdentity ##### --> +<!-- ##### FUNCTION gst_object_get_type ##### --> <para> </para> +@Returns: -<!-- ##### MACRO GST_IS_FDSRC ##### --> +<!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### --> <para> </para> -@obj: -<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### --> +<!-- ##### MACRO GST_QUEUE_CLASS ##### --> <para> </para> +@klass: -<!-- ##### FUNCTION gst_thread_get_type ##### --> +<!-- ##### FUNCTION gst_audiosrc_get_type ##### --> <para> </para> @Returns: -<!-- ##### MACRO GST_QUEUE ##### --> +<!-- ##### MACRO DEBUG ##### --> <para> - +Use this macro to show debugging info. This is only usefull when developing new +plugin elements. +If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce +g_print messages. </para> -@obj: +@format: the format specification as in g_print +@args...: arguments -<!-- ##### ARG GstHttpSrc:bytesperread ##### --> +<!-- ##### MACRO DEBUG_LEAVE_STRING ##### --> <para> -Specify how many bytes to read at a time. </para> -<!-- ##### FUNCTION gst_disksrc_get_type ##### --> +<!-- ##### SECTION ./tmpl/gstconnection.sgml:See_Also ##### --> <para> </para> -@Returns: -<!-- ##### MACRO GST_THREAD ##### --> +<!-- ##### MACRO GST_IS_QUEUE ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### --> +<!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### --> <para> +The sink is the end of the filter graph. A typical sink would be an audio +or a video card. </para> -@obj: -<!-- ##### FUNCTION gst_fakesink_new ##### --> +<!-- ##### FUNCTION gst_queue_new ##### --> <para> </para> @@ -349,36 +297,32 @@ Specify how many bytes to read at a time. @name: @Returns: -<!-- ##### FUNCTION gst_pad_get_directory ##### --> +<!-- ##### FUNCTION gst_fdsrc_get_type ##### --> <para> </para> -@pad: @Returns: -<!-- ##### SECTION ./tmpl/gstsrc.sgml:Title ##### --> -GstSrc - - -<!-- ##### MACRO DEBUG_ENTER_STRING ##### --> +<!-- ##### MACRO GST_TYPE_DISKSRC ##### --> <para> </para> -<!-- ##### MACRO GST_IS_ESDSINK_CLASS ##### --> +<!-- ##### MACRO GST_PROPS_LIST_ID ##### --> <para> </para> -@obj: -<!-- ##### ARG GstFakeSrc:output ##### --> +<!-- ##### FUNCTION plugin_load ##### --> <para> </para> +@name: +@Returns: <!-- ##### SECTION ./tmpl/gstgetbits.sgml:See_Also ##### --> <para> @@ -386,60 +330,46 @@ GstSrc </para> -<!-- ##### MACRO GST_SRC ##### --> +<!-- ##### MACRO GST_IS_SRC ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_TYPE_AUDIOSRC ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gst_sink_new ##### --> +<!-- ##### FUNCTION gst_queue_push ##### --> <para> </para> -@name: -@Returns: +@connection: -<!-- ##### SECTION ./tmpl/plugin.sgml:See_Also ##### --> +<!-- ##### MACRO GST_SRC_ASYNC ##### --> <para> - +This macro checks to see if the GST_SRC_ASYNC flag is set. </para> +@obj: GstSrc to check for flag in. -<!-- ##### MACRO GST_PAD_CLASS ##### --> +<!-- ##### STRUCT GstFilter ##### --> <para> </para> -@klass: -<!-- ##### FUNCTION plugin_load_all ##### --> +<!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### --> <para> </para> -<!-- ##### MACRO GST_SINESRC_CLASS ##### --> +<!-- ##### MACRO GST_TEE_CLASS ##### --> <para> </para> @klass: -<!-- ##### MACRO GST_IS_TEE_CLASS ##### --> -<para> - -</para> - -@obj: - <!-- ##### FUNCTION gst_thread_main_loop ##### --> <para> @@ -447,130 +377,103 @@ GstSrc @arg: -<!-- ##### MACRO GST_IS_AUDIOSINK_CLASS ##### --> -<para> - -</para> - -@obj: - -<!-- ##### STRUCT GstDiskSrc ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/gstconnection.sgml:Title ##### --> -GstConnection - - -<!-- ##### ARG GstDiskSrc:bytesperread ##### --> -<para> -Specify how many bytes to read at a time. -</para> +<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Title ##### --> +GstEsdSink -<!-- ##### MACRO GST_TYPE_FDSRC ##### --> +<!-- ##### MACRO GST_TYPE_BIN ##### --> <para> </para> -<!-- ##### MACRO GST_IS_SRC_CLASS ##### --> +<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### --> <para> </para> @obj: -<!-- ##### ARG GstSineSrc:freq ##### --> +<!-- ##### MACRO GST_TYPE_TEE ##### --> <para> -The frequency. -</para> - -<!-- ##### ARG GstAsyncDiskSrc:bytesperread ##### --> -<para> -Specify how many bytes to read at a time. </para> -<!-- ##### MACRO GST_TYPE_PIPELINE ##### --> +<!-- ##### FUNCTION gst_fakesrc_new ##### --> <para> </para> +@name: +@Returns: -<!-- ##### STRUCT GstHttpSrcClass ##### --> +<!-- ##### SECTION ./tmpl/gstconnection.sgml:Long_Description ##### --> <para> +A connection is a bas class for a generic connection between +elements. A connection is typically a bas class for queues. </para> -<!-- ##### FUNCTION gst_filter_new ##### --> +<!-- ##### FUNCTION gst_src_get_type ##### --> <para> </para> -@name: @Returns: -<!-- ##### SECTION ./tmpl/GstElement.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/gstesdsink.sgml:See_Also ##### --> +<!-- ##### STRUCT GstDiskSrcClass ##### --> <para> </para> -<!-- ##### FUNCTION gst_sink_get_type ##### --> +<!-- ##### MACRO GST_PROPS_INT_ID ##### --> <para> </para> -@Returns: -<!-- ##### ARG GstSineSrc:volume ##### --> +<!-- ##### FUNCTION gst_fakesink_chain ##### --> <para> -The volume as a double 0.0 is silent, 1.0 is loudest. + </para> +@pad: +@buf: -<!-- ##### MACRO GST_TYPE_TEE ##### --> +<!-- ##### FUNCTION gst_type_add_src ##### --> <para> </para> +@id: +@src: -<!-- ##### FUNCTION gst_queue_push ##### --> +<!-- ##### FUNCTION gst_esdsink_get_type ##### --> <para> </para> -@connection: +@Returns: -<!-- ##### MACRO GST_FILTER_FLAG_LAST ##### --> +<!-- ##### FUNCTION gst_esdsink_chain ##### --> <para> -subclass use this to start their flag enumeration -</para> - -<!-- ##### SECTION ./tmpl/GstElement.sgml:Title ##### --> -GstElement +</para> +@pad: +@buf: -<!-- ##### MACRO GST_BIN ##### --> +<!-- ##### MACRO INFO ##### --> <para> </para> -@obj: +@cat: +@format: +@args...: <!-- ##### FUNCTION gst_type_get_sinks ##### --> <para> @@ -580,254 +483,243 @@ GstElement @id: @Returns: -<!-- ##### MACRO GST_BUFFER_POOL ##### --> -<para> - -</para> - -@buf: - -<!-- ##### FUNCTION gst_audiosink_set_channels ##### --> +<!-- ##### MACRO GST_TYPE_HTTPSRC ##### --> <para> </para> -@audiosink: -@channels: - -<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### --> -Generic connection between elements. - -<!-- ##### STRUCT GstSinkClass ##### --> +<!-- ##### MACRO GST_TYPE_ELEMENT ##### --> <para> </para> -<!-- ##### STRUCT GstEsdSink ##### --> +<!-- ##### STRUCT GstFakeSink ##### --> <para> </para> -<!-- ##### STRUCT GstFilterClass ##### --> +<!-- ##### MACRO GST_THREAD_CLASS ##### --> <para> </para> +@klass: -<!-- ##### MACRO GST_FDSINK ##### --> +<!-- ##### MACRO GST_BIN_CLASS ##### --> <para> </para> -@obj: +@klass: -<!-- ##### MACRO ERROR ##### --> +<!-- ##### MACRO GST_TYPE_OBJECT ##### --> <para> </para> -@element: -@format: -@args...: -<!-- ##### MACRO GST_IS_FAKESRC ##### --> +<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_FILTER ##### --> +<!-- ##### MACRO GST_IS_FDSRC_CLASS ##### --> <para> </para> @obj: -<!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### --> +<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### --> <para> -The sink is the end of the filter graph. A typical sink would be an audio -or a video card. </para> -<!-- ##### FUNCTION gst_esdsink_set_channels ##### --> +<!-- ##### MACRO GST_FAKESINK ##### --> <para> </para> -@esdsink: -@channels: - -<!-- ##### ARG GstDiskSrc:size ##### --> -<para> +@obj: -</para> +<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### --> +GstColorSpace -<!-- ##### FUNCTION gst_esdsink_get_type ##### --> +<!-- ##### STRUCT GstEsdSink ##### --> <para> </para> -@Returns: -<!-- ##### MACRO GST_IS_BIN_CLASS ##### --> +<!-- ##### MACRO GST_PAD ##### --> <para> </para> @obj: -<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### --> +<!-- ##### STRUCT GstSink ##### --> <para> </para> -<!-- ##### MACRO GST_ELEMENT ##### --> +<!-- ##### MACRO GST_IS_AUDIOSINK_CLASS ##### --> <para> </para> @obj: -<!-- ##### STRUCT GstEsdSinkClass ##### --> +<!-- ##### SECTION ./tmpl/gstsrc.sgml:See_Also ##### --> <para> </para> -<!-- ##### ARG GstQueue:block ##### --> +<!-- ##### FUNCTION gst_type_get_srcs ##### --> <para> </para> +@id: +@Returns: + +<!-- ##### SECTION ./tmpl/gstfilter.sgml:Short_Description ##### --> +Take data in and spit data out -<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### --> -<para> -Query whether this object has multiple input pads. +<!-- ##### SECTION ./tmpl/gstfilter.sgml:Long_Description ##### --> +<para> +Filters take data in and spit data out. They are the main Element in a filter graph. +Filters have zero or more inputs and zero or more outputs. Filters are connected +together to form filter graphs. A GstFilter is the base class and is not very usefull +on its own. </para> -@obj: Element to query for multiple input pads. -<!-- ##### FUNCTION gst_fdsink_new_with_fd ##### --> +<!-- ##### FUNCTION plugin_load_absolute ##### --> <para> </para> @name: -@fd: @Returns: -<!-- ##### MACRO DEBUG_NOPREFIX ##### --> +<!-- ##### FUNCTION gst_sinesrc_new ##### --> <para> </para> -@format: -@args...: +@name: +@Returns: -<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Long_Description ##### --> <para> </para> -<!-- ##### ARG GstAudioSink:frequency ##### --> +<!-- ##### FUNCTION gst_audiosrc_new ##### --> <para> </para> +@name: +@Returns: -<!-- ##### STRUCT GstFdSrc ##### --> +<!-- ##### MACRO DEBUG_NOPREFIX ##### --> <para> </para> +@format: +@args...: -<!-- ##### MACRO GST_IS_ELEMENT_CLASS ##### --> +<!-- ##### MACRO GST_QUEUE ##### --> <para> </para> @obj: -<!-- ##### STRUCT GstThreadClass ##### --> +<!-- ##### MACRO GST_FILTER ##### --> <para> </para> +@obj: -<!-- ##### STRUCT GstSrcClass ##### --> +<!-- ##### FUNCTION gst_src_push ##### --> <para> </para> +@src: -<!-- ##### ARG GstIdentity:control ##### --> +<!-- ##### FUNCTION gst_filter_new ##### --> <para> </para> +@name: +@Returns: -<!-- ##### TYPEDEF GstPropsListFactory[] ##### --> +<!-- ##### STRUCT GstThreadClass ##### --> <para> </para> -<!-- ##### MACRO GST_PAD ##### --> +<!-- ##### MACRO GST_IS_OBJECT ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_pad_set_pull_function ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Title ##### --> +GstGetbits -@pad: -@pull: -<!-- ##### STRUCT GstSink ##### --> +<!-- ##### MACRO GST_FILTER_CLASS ##### --> <para> </para> +@klass: -<!-- ##### FUNCTION gst_pipeline_get_type ##### --> +<!-- ##### MACRO ERROR ##### --> <para> </para> -@Returns: +@element: +@format: +@args...: -<!-- ##### MACRO GST_IS_THREAD ##### --> +<!-- ##### MACRO GST_IS_PAD_CLASS ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_TYPE_THREAD ##### --> -<para> - -</para> - - -<!-- ##### STRUCT GstAsyncDiskSrcClass ##### --> +<!-- ##### FUNCTION gst_src_push_region ##### --> <para> </para> +@src: +@offset: +@size: <!-- ##### FUNCTION gst_src_signal_eos ##### --> <para> @@ -836,67 +728,29 @@ Query whether this object has multiple input pads. @src: -<!-- ##### 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 - -<!-- ##### STRUCT GstHttpSrc ##### --> -<para> - -</para> - - -<!-- ##### MACRO GST_TYPE_SINK ##### --> -<para> - -</para> - - -<!-- ##### ARG GstDiskSrc:offset ##### --> -<para> -Get the current offset in the file. -</para> - - -<!-- ##### MACRO DEBUG_SET_STRING ##### --> -<para> - -</para> - -@format: -@args...: - -<!-- ##### STRUCT GstSrc ##### --> +<!-- ##### MACRO GST_SINESRC_CLASS ##### --> <para> </para> +@klass: -<!-- ##### MACRO GST_IS_THREAD_CLASS ##### --> +<!-- ##### MACRO GST_IS_FAKESRC_CLASS ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_bin_get_type ##### --> +<!-- ##### FUNCTION gst_connection_new ##### --> <para> </para> +@name: @Returns: -<!-- ##### ARG GstAsyncDiskSrc:offset ##### --> -<para> -Specify the current offset in the file. -</para> - - -<!-- ##### FUNCTION gst_queue_new ##### --> +<!-- ##### FUNCTION gst_sink_new ##### --> <para> </para> @@ -904,821 +758,777 @@ Specify the current offset in the file. @name: @Returns: -<!-- ##### MACRO GST_THREAD_CLASS ##### --> +<!-- ##### MACRO GST_ELEMENT_CLASS ##### --> <para> </para> @klass: -<!-- ##### MACRO GST_IS_FILTER_CLASS ##### --> +<!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### --> <para> +A GstSrc is the start of a filter graph. It typically is a file or an +audio source. It provides data for the next element in the graph. </para> -@obj: -<!-- ##### MACRO GST_TYPE_AUDIOSINK ##### --> +<!-- ##### FUNCTION gst_fdsink_chain ##### --> <para> </para> +@pad: +@buf: -<!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### --> +<!-- ##### MACRO GST_IS_IDENTITY ##### --> <para> </para> +@obj: -<!-- ##### MACRO GST_CONNECTION_CLASS ##### --> +<!-- ##### FUNCTION gst_esdsink_set_channels ##### --> <para> </para> -@klass: +@esdsink: +@channels: -<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### --> +<!-- ##### MACRO GST_FDSRC_CLASS ##### --> <para> </para> +@klass: -<!-- ##### FUNCTION gst_connection_new ##### --> +<!-- ##### MACRO GST_SINK_CLASS ##### --> <para> </para> -@name: -@Returns: +@klass: -<!-- ##### MACRO GST_FILTER_CLASS ##### --> +<!-- ##### STRUCT GstPipelineClass ##### --> <para> </para> -@klass: -<!-- ##### FUNCTION gst_identity_get_type ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/gstsrc.sgml:Title ##### --> +GstSrc -@Returns: -<!-- ##### MACRO GST_SINK ##### --> +<!-- ##### MACRO GST_IS_FDSINK_CLASS ##### --> <para> </para> @obj: -<!-- ##### ARG GstFakeSrc:num_sources ##### --> +<!-- ##### MACRO GST_ASYNCDISKSRC ##### --> <para> </para> +@obj: -<!-- ##### MACRO GST_PROPS_BOOL_ID ##### --> +<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### --> <para> </para> +@Returns: -<!-- ##### MACRO GST_FDSRC_CLASS ##### --> +<!-- ##### MACRO GST_ESDSINK ##### --> <para> </para> -@klass: +@obj: -<!-- ##### MACRO GST_TYPE_FAKESRC ##### --> +<!-- ##### FUNCTION gst_pipeline_get_type ##### --> <para> </para> +@Returns: -<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### --> - - - -<!-- ##### FUNCTION gst_pad_get_type ##### --> +<!-- ##### ARG GstSineSrc:freq ##### --> <para> - +The frequency. </para> -@Returns: -<!-- ##### STRUCT GstSineSrc ##### --> +<!-- ##### STRUCT GstIdentityClass ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### --> +<!-- ##### STRUCT GstSinkClass ##### --> <para> </para> -<!-- ##### MACRO GST_IS_AUDIOSINK ##### --> +<!-- ##### MACRO GST_IS_TEE_CLASS ##### --> <para> </para> @obj: -<!-- ##### SIGNAL GstElement::new-pad ##### --> +<!-- ##### MACRO GST_STATE_UNSET ##### --> <para> -Is trigered whenever a new pad is added to an element +This macro unsets the given state on the element. </para> -@gstelement: the object which received the signal. -@arg1: the new pad that was added +@obj: Element to unset state of. +@flag: State to unset, can be any number of bits in guint32. -<!-- ##### SECTION ./tmpl/gstfilter.sgml:Long_Description ##### --> +<!-- ##### STRUCT GstDiskSrc ##### --> <para> -Filters take data in and spit data out. They are the main Element in a filter graph. -Filters have zero or more inputs and zero or more outputs. Filters are connected -together to form filter graphs. A GstFilter is the base class and is not very usefull -on its own. + </para> -<!-- ##### MACRO GST_OBJECT ##### --> +<!-- ##### MACRO GST_SRC_FLAGS ##### --> <para> - +This macro returns the entire set of flags for the object. </para> -@obj: +@obj: GstSrc to return flags for. -<!-- ##### MACRO GST_IS_FDSINK ##### --> +<!-- ##### FUNCTION gst_sink_get_type ##### --> <para> </para> -@obj: +@Returns: -<!-- ##### MACRO GST_IS_DISKSRC ##### --> +<!-- ##### MACRO GST_TYPE_AUDIOSRC ##### --> <para> </para> -@obj: -<!-- ##### MACRO GST_FAKESINK_CLASS ##### --> +<!-- ##### MACRO GST_SRC_CLASS ##### --> <para> </para> @klass: -<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Short_Description ##### --> - +<!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### --> +The start point of a filter graph -<!-- ##### MACRO GST_TYPE_FDSINK ##### --> +<!-- ##### MACRO GST_FAKESINK_CLASS ##### --> <para> </para> +@klass: -<!-- ##### ARG GstAudioSink:format ##### --> +<!-- ##### MACRO GST_IS_SINK_CLASS ##### --> <para> </para> +@obj: -<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### --> +<!-- ##### STRUCT GstConnectionClass ##### --> <para> </para> -<!-- ##### MACRO GST_IS_FAKESINK_CLASS ##### --> +<!-- ##### MACRO GST_IS_PAD ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_pad_set_caps ##### --> +<!-- ##### STRUCT GstFdSinkClass ##### --> <para> </para> -@pad: -@caps: -<!-- ##### MACRO GST_AUDIOSRC_CLASS ##### --> +<!-- ##### FUNCTION gst_type_load_thyself ##### --> <para> </para> -@klass: +@parent: +@Returns: -<!-- ##### MACRO GST_IS_FILTER ##### --> +<!-- ##### FUNCTION gst_plugin_init ##### --> <para> </para> -@obj: -<!-- ##### STRUCT GstAudioSrcClass ##### --> +<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Short_Description ##### --> + + + +<!-- ##### MACRO DEBUG_LEAVE ##### --> <para> </para> +@format: +@args...: -<!-- ##### MACRO GST_TYPE_FILTER ##### --> +<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### --> <para> </para> +@klass: -<!-- ##### FUNCTION gst_identity_new ##### --> +<!-- ##### MACRO GST_ESDSINK_CLASS ##### --> <para> </para> -@name: -@Returns: +@klass: -<!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### --> +<!-- ##### MACRO GST_IS_BIN_CLASS ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_audiosrc_new ##### --> +<!-- ##### FUNCTION gst_element_get_type ##### --> <para> </para> -@name: @Returns: -<!-- ##### STRUCT GstIdentityClass ##### --> +<!-- ##### STRUCT GstSineSrcClass ##### --> <para> </para> -<!-- ##### MACRO GST_IS_PAD_CLASS ##### --> +<!-- ##### MACRO GST_IS_PIPELINE ##### --> <para> </para> @obj: -<!-- ##### STRUCT GstConnection ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/gstconnection.sgml:Title ##### --> +GstConnection -<!-- ##### STRUCT GstQueueClass ##### --> +<!-- ##### MACRO GST_TYPE_THREAD ##### --> <para> </para> -<!-- ##### MACRO GST_SINK_FLAG_LAST ##### --> +<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### --> <para> </para> -<!-- ##### MACRO GST_IDENTITY_CLASS ##### --> +<!-- ##### STRUCT GstHttpSrc ##### --> <para> </para> -@klass: -<!-- ##### ARG GstTypeFind:caps ##### --> +<!-- ##### MACRO GST_STATE_SET ##### --> <para> - +This macro sets the given state on the element. </para> +@obj: Element to set state of. +@flag: State to set, can be any number of bits in guint32. -<!-- ##### MACRO GST_IS_FDSINK_CLASS ##### --> +<!-- ##### MACRO DEBUG_ENTER_STRING ##### --> <para> </para> -@obj: -<!-- ##### FUNCTION gst_fakesrc_push ##### --> +<!-- ##### MACRO GST_AUDIOSRC_CLASS ##### --> <para> </para> -@src: +@klass: -<!-- ##### FUNCTION gst_type_add_sink ##### --> +<!-- ##### ENUM GstCapsDefinition ##### --> <para> </para> -@id: -@sink: +@GST_CAPS_ALWAYS: +@GST_CAPS_MAYBE: -<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### --> +<!-- ##### MACRO GST_DISKSRC ##### --> <para> </para> @obj: -<!-- ##### STRUCT GstFakeSinkClass ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### --> +Generic connection between elements. -<!-- ##### MACRO GST_SRC_FLAGS ##### --> +<!-- ##### MACRO GST_TYPE_AUDIOSINK ##### --> <para> -This macro returns the entire set of flags for the object. -</para> - -@obj: GstSrc to return flags for. - -<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Title ##### --> -GstGetbits - -<!-- ##### ARG GstFdSink:fd ##### --> -<para> -The filedescriptor to write to. </para> -<!-- ##### ARG GstAsyncDiskSrc:length ##### --> +<!-- ##### STRUCT GstFdSrcClass ##### --> <para> -Get the size of the current file. + </para> -<!-- ##### MACRO GST_FDSINK_CLASS ##### --> +<!-- ##### FUNCTION gst_esdsink_sync_parms ##### --> <para> </para> -@klass: +@esdsink: -<!-- ##### FUNCTION gst_fdsink_new ##### --> +<!-- ##### MACRO GST_IS_SINK ##### --> <para> </para> -@name: -@Returns: - -<!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### --> -The start point of a filter graph - +@obj: -<!-- ##### FUNCTION gst_src_push ##### --> +<!-- ##### MACRO GST_IS_THREAD ##### --> <para> </para> -@src: +@obj: -<!-- ##### MACRO GST_IS_TEE ##### --> +<!-- ##### MACRO GST_SINK ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_type_get_sink_to_src ##### --> +<!-- ##### MACRO GST_TYPE_FDSINK ##### --> <para> </para> -@sinkid: -@srcid: -@Returns: -<!-- ##### MACRO GST_IS_ESDSINK ##### --> +<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_PROPS_INT_ID ##### --> +<!-- ##### MACRO GST_IS_PIPELINE_CLASS ##### --> <para> </para> +@obj: -<!-- ##### STRUCT GstTeeClass ##### --> +<!-- ##### SECTION ./tmpl/plugin.sgml:Title ##### --> +plugin + + +<!-- ##### MACRO GST_TYPE_SRC ##### --> <para> </para> -<!-- ##### FUNCTION gst_sinesrc_push ##### --> +<!-- ##### FUNCTION gst_identity_chain ##### --> <para> </para> -@src: +@pad: +@buf: -<!-- ##### MACRO GST_FAKESINK ##### --> +<!-- ##### STRUCT GstAsyncDiskSrc ##### --> <para> </para> -@obj: -<!-- ##### FUNCTION gst_type_get_srcs ##### --> +<!-- ##### FUNCTION gst_identity_new ##### --> <para> </para> -@id: +@name: @Returns: -<!-- ##### FUNCTION gst_esdsink_set_frequency ##### --> +<!-- ##### MACRO GST_IS_HTTPSRC_CLASS ##### --> <para> </para> -@esdsink: -@frequency: +@obj: -<!-- ##### ARG GstFdSrc:bytesperread ##### --> +<!-- ##### MACRO GST_IS_FAKESRC ##### --> <para> -The number of bytes per read. -</para> - -<!-- ##### ARG GstFdSrc:location ##### --> -<para> -The filedescriptor to read from. Pass the argument as a char* (???) </para> +@obj: -<!-- ##### MACRO GST_FAKESRC_CLASS ##### --> +<!-- ##### STRUCT GstHttpSrcClass ##### --> <para> </para> -@klass: -<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Short_Description ##### --> +<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### --> +<para> +</para> -<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### --> +<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### --> <para> - +This macro usets the given flags. </para> +@src: +@flag: Flag to set, must be a single bit in guint32. +@obj: GstSrc to unset flag in. -<!-- ##### STRUCT GstBinClass ##### --> +<!-- ##### FUNCTION gst_audiosink_sync_parms ##### --> <para> </para> +@audiosink: -<!-- ##### MACRO GST_TYPE_DISKSRC ##### --> +<!-- ##### MACRO GST_IS_OBJECT_CLASS ##### --> <para> </para> +@obj: -<!-- ##### MACRO GST_TYPE_SRC ##### --> +<!-- ##### FUNCTION gst_pad_get_directory ##### --> <para> </para> +@pad: +@Returns: -<!-- ##### FUNCTION gst_audiosrc_get_type ##### --> +<!-- ##### MACRO GST_HTTPSRC ##### --> <para> </para> -@Returns: +@obj: -<!-- ##### MACRO GST_FAKESRC ##### --> +<!-- ##### MACRO GST_ELEMENT ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_httpsrc_get_type ##### --> +<!-- ##### MACRO GST_CPU_FLAG_SSE ##### --> <para> - +A flag indicating that SSE instructions are supported. </para> -@Returns: -<!-- ##### MACRO GST_IS_HTTPSRC ##### --> +<!-- ##### FUNCTION gst_pad_set_type_id ##### --> <para> </para> -@obj: +@pad: +@id: -<!-- ##### MACRO GST_DISKSRC_CLASS ##### --> +<!-- ##### STRUCT GstAudioSrcClass ##### --> <para> </para> -@klass: -<!-- ##### MACRO GST_IDENTITY ##### --> +<!-- ##### MACRO GST_IS_FDSINK ##### --> <para> </para> @obj: -<!-- ##### ARG GstAudioSrc:format ##### --> +<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### --> <para> -The audio format as defined in soundcard.h + </para> -<!-- ##### MACRO GST_IS_HTTPSRC_CLASS ##### --> +<!-- ##### ARG GstIdentity:control ##### --> <para> </para> -@obj: -<!-- ##### MACRO GST_ESDSINK_CLASS ##### --> -<para> +<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Short_Description ##### --> -</para> -@klass: -<!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### --> +<!-- ##### SECTION ./tmpl/gstsink.sgml:Short_Description ##### --> +The end point of a filter graph + + +<!-- ##### FUNCTION gst_connection_get_type ##### --> <para> </para> +@Returns: -<!-- ##### FUNCTION gst_audiosink_sync_parms ##### --> +<!-- ##### MACRO GST_FDSINK_CLASS ##### --> <para> </para> -@audiosink: +@klass: -<!-- ##### FUNCTION gst_elementfactory_add_sink ##### --> +<!-- ##### STRUCT GstFakeSrcClass ##### --> <para> </para> -@elementfactory: -@id: -<!-- ##### MACRO GST_IS_OBJECT ##### --> +<!-- ##### MACRO GST_OBJECT ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_STATE_UNSET ##### --> +<!-- ##### FUNCTION gst_thread_get_type ##### --> <para> -This macro unsets the given state on the element. + </para> -@obj: Element to unset state of. -@flag: State to unset, can be any number of bits in guint32. +@Returns: -<!-- ##### MACRO GST_IS_FAKESINK ##### --> +<!-- ##### MACRO GST_IS_SRC_CLASS ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_QUEUE_CLASS ##### --> +<!-- ##### FUNCTION gst_bin_get_type ##### --> <para> </para> -@klass: +@Returns: -<!-- ##### FUNCTION gst_pad_set_type_id ##### --> +<!-- ##### FUNCTION gst_pad_set_caps ##### --> <para> </para> @pad: -@id: +@caps: -<!-- ##### MACRO GST_TYPE_OBJECT ##### --> +<!-- ##### MACRO GST_IS_FAKESINK ##### --> <para> </para> +@obj: -<!-- ##### ARG GstSineSrc:frequency ##### --> +<!-- ##### MACRO GST_STATE_IS_SET ##### --> <para> -The fequency. +This macro checks to see if the given state is set. </para> +@obj: Element to check for state. +@flag: State to check for, must be a single bit in guint32. -<!-- ##### FUNCTION gst_src_get_type ##### --> +<!-- ##### FUNCTION gst_type_save_thyself ##### --> <para> </para> +@type: +@parent: @Returns: -<!-- ##### ARG GstSineSrc:format ##### --> -<para> -The format ad defined in soundcard.h -</para> - - -<!-- ##### FUNCTION gst_audiosink_set_frequency ##### --> +<!-- ##### MACRO GST_IS_SINESRC ##### --> <para> </para> -@audiosink: -@frequency: +@obj: -<!-- ##### MACRO GST_TYPE_BIN ##### --> +<!-- ##### FUNCTION gst_sinesrc_get_type ##### --> <para> </para> +@Returns: -<!-- ##### STRUCT GstAudioSink ##### --> +<!-- ##### MACRO GST_BIN ##### --> <para> </para> +@obj: -<!-- ##### FUNCTION gst_elementfactory_register ##### --> +<!-- ##### FUNCTION plugin_load_all ##### --> <para> </para> -@elementfactory: -<!-- ##### ARG GstAudioSrc:bytes_per_read ##### --> -<para> -The number of bytes per read. -</para> - - -<!-- ##### MACRO GST_IS_QUEUE ##### --> +<!-- ##### MACRO GST_TEE ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### --> -<para> -</para> - -@argc: -@argv: -@Returns: - -<!-- ##### MACRO GST_IS_SINESRC ##### --> +<!-- ##### FUNCTION gst_fdsink_get_type ##### --> <para> </para> -@obj: +@Returns: -<!-- ##### SIGNAL GstAudioSink::handoff ##### --> +<!-- ##### MACRO GST_SRC_SET_FLAGS ##### --> <para> -The buffer is sent to the sound card. +This macro sets the given flags. </para> -@gstaudiosink: the object which received the signal. -@arg1: the audiosink. +@src: +@flag: Flag to set, can by any number of bits in guint32. +@obj: GstSrc to set flag in. -<!-- ##### ARG GstDiskSrc:location ##### --> +<!-- ##### MACRO GST_SRC_IS_ASYNC ##### --> <para> -Specify the location of the file to read. +Query a GstSrc for the ASYNC flag </para> +@obj: The GstSrc to query -<!-- ##### MACRO GST_IS_FDSRC_CLASS ##### --> +<!-- ##### MACRO GST_TYPE_IDENTITY ##### --> <para> </para> -@obj: -<!-- ##### SIGNAL GstElement::eos ##### --> +<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### --> <para> - </para> -@gstelement: the object which received the signal. +@argc: +@argv: +@Returns: -<!-- ##### FUNCTION gst_sinesrc_get_type ##### --> +<!-- ##### MACRO GST_TYPE_FDSRC ##### --> <para> </para> -@Returns: -<!-- ##### MACRO ERROR_OBJECT ##### --> +<!-- ##### FUNCTION gst_type_initialize ##### --> <para> </para> -@element: -@object: -@format: -@args...: -<!-- ##### ARG GstThread:create_thread ##### --> +<!-- ##### STRUCT GstAudioSrc ##### --> <para> -TRUE if the thread should be created. </para> -<!-- ##### MACRO GST_IS_IDENTITY ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### --> +GstSink -@obj: -<!-- ##### MACRO GST_AUDIOSRC ##### --> +<!-- ##### FUNCTION gst_type_get_sink_to_src ##### --> <para> </para> -@obj: +@sinkid: +@srcid: +@Returns: -<!-- ##### MACRO GST_TYPE_ESDSINK ##### --> +<!-- ##### MACRO GST_TYPE_FAKESRC ##### --> <para> </para> -<!-- ##### MACRO GST_FDSRC ##### --> +<!-- ##### MACRO GST_SINK_FLAG_LAST ##### --> <para> </para> -@obj: -<!-- ##### MACRO GST_IS_OBJECT_CLASS ##### --> +<!-- ##### FUNCTION gst_queue_get_type ##### --> <para> </para> -@obj: +@Returns: -<!-- ##### FUNCTION gst_esdsink_chain ##### --> +<!-- ##### STRUCT GstSrc ##### --> <para> </para> -@pad: -@buf: -<!-- ##### ARG GstFakeSrc:loop_based ##### --> +<!-- ##### FUNCTION gst_connection_push ##### --> <para> </para> +@connection: -<!-- ##### FUNCTION gst_audiosink_get_type ##### --> +<!-- ##### MACRO GST_TYPE_CONNECTION ##### --> <para> </para> -@Returns: -<!-- ##### MACRO GST_OBJECT_CLASS ##### --> +<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### --> <para> </para> -@klass: -<!-- ##### SECTION ./tmpl/gstconnection.sgml:Long_Description ##### --> +<!-- ##### MACRO GST_AUDIOSRC ##### --> <para> -A connection is a bas class for a generic connection between -elements. A connection is typically a bas class for queues. </para> +@obj: <!-- ##### MACRO GST_BUFFER ##### --> <para> @@ -1727,37 +1537,23 @@ elements. A connection is typically a bas class for queues. @buf: -<!-- ##### MACRO GST_SRC_IS_ASYNC ##### --> -<para> -Query a GstSrc for the ASYNC flag -</para> - -@obj: The GstSrc to query - -<!-- ##### MACRO GST_PIPELINE ##### --> +<!-- ##### STRUCT GstQueueClass ##### --> <para> </para> -@obj: -<!-- ##### MACRO GST_STATE_SET ##### --> +<!-- ##### ARG GstTypeFind:type ##### --> <para> -This macro sets the given state on the element. +Query the element for the current mime type </para> -@obj: Element to set state of. -@flag: State to set, can be any number of bits in guint32. -<!-- ##### FUNCTION gst_queue_chain ##### --> -<para> +<!-- ##### SECTION ./tmpl/GstElement.sgml:Short_Description ##### --> -</para> -@pad: -@buf: -<!-- ##### MACRO GST_TYPE_QUEUE ##### --> +<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### --> <para> </para> @@ -1770,733 +1566,624 @@ This macro sets the given state on the element. @Returns: -<!-- ##### SIGNAL GstFakeSink::handoff ##### --> +<!-- ##### FUNCTION gst_element_change_state ##### --> <para> </para> -@gstfakesink: the object which received the signal. +@element: +@state: +@Returns: -<!-- ##### MACRO GST_TYPE_CONNECTION ##### --> +<!-- ##### MACRO GST_FAKESRC_CLASS ##### --> <para> </para> +@klass: -<!-- ##### MACRO GST_CONNECTION ##### --> +<!-- ##### FUNCTION gst_type_dump ##### --> <para> </para> -@obj: -<!-- ##### MACRO GST_TYPE_HTTPSRC ##### --> +<!-- ##### STRUCT GstAudioSinkClass ##### --> <para> </para> -<!-- ##### MACRO GST_TYPE_PAD ##### --> +<!-- ##### MACRO GST_IDENTITY_CLASS ##### --> <para> </para> +@klass: -<!-- ##### FUNCTION gst_src_push_region ##### --> +<!-- ##### STRUCT GstFdSink ##### --> <para> </para> -@src: -@offset: -@size: -<!-- ##### FUNCTION gst_fdsink_get_type ##### --> +<!-- ##### ENUM GstPropsId ##### --> <para> </para> -@Returns: +@GST_PROPS_END_ID_NUM: +@GST_PROPS_LIST_ID_NUM: +@GST_PROPS_INT_ID_NUM: +@GST_PROPS_INT_RANGE_ID_NUM: +@GST_PROPS_FOURCC_ID_NUM: +@GST_PROPS_BOOL_ID_NUM: -<!-- ##### STRUCT GstPipelineClass ##### --> +<!-- ##### STRUCT GstEsdSinkClass ##### --> <para> </para> -<!-- ##### MACRO GST_IS_AUDIOSRC ##### --> +<!-- ##### FUNCTION gst_esdsink_set_frequency ##### --> <para> </para> -@obj: +@esdsink: +@frequency: -<!-- ##### MACRO DEBUG_ENTER ##### --> +<!-- ##### ARG GstAsyncDiskSrc:length ##### --> <para> - +Get the size of the current file. </para> -@format: -@args...: -<!-- ##### MACRO GST_DISKSRC ##### --> +<!-- ##### MACRO GST_FILTER_FLAG_LAST ##### --> <para> - +subclass use this to start their flag enumeration </para> -@obj: -<!-- ##### MACRO INFO_ELEMENT ##### --> +<!-- ##### MACRO ERROR_OBJECT ##### --> <para> </para> -@cat: @element: +@object: @format: @args...: -<!-- ##### MACRO GST_ELEMENT_CLASS ##### --> +<!-- ##### ENUM GstSrcFlags ##### --> <para> - +Flags for the GstSrc element </para> -@klass: +@GST_SRC_ASYNC: Indicates that this src is asynchronous +@GST_SRC_FLAG_LAST: subclasses can use this to number their flags -<!-- ##### FUNCTION gst_fakesrc_new ##### --> +<!-- ##### MACRO GST_TYPE_PIPELINE ##### --> <para> </para> -@name: -@Returns: -<!-- ##### MACRO GST_SINK_CLASS ##### --> +<!-- ##### MACRO GST_TYPE_SINESRC ##### --> <para> </para> -@klass: -<!-- ##### STRUCT GstAudioSinkClass ##### --> +<!-- ##### FUNCTION gst_esdsink_new ##### --> <para> </para> +@name: +@Returns: -<!-- ##### FUNCTION gst_type_add_src ##### --> +<!-- ##### FUNCTION gst_audiosink_set_channels ##### --> <para> </para> -@id: -@src: +@audiosink: +@channels: -<!-- ##### STRUCT GstFdSink ##### --> +<!-- ##### STRUCT GstSrcClass ##### --> <para> </para> -<!-- ##### FUNCTION gst_fakesrc_get_type ##### --> +<!-- ##### FUNCTION gst_thread_iterate ##### --> <para> </para> -@Returns: +@thread: -<!-- ##### MACRO GST_IS_PIPELINE ##### --> +<!-- ##### MACRO GST_AUDIOSINK ##### --> <para> </para> @obj: -<!-- ##### STRUCT GstFdSinkClass ##### --> +<!-- ##### SECTION ./tmpl/plugin.sgml:See_Also ##### --> <para> </para> -<!-- ##### MACRO GST_IS_SINESRC_CLASS ##### --> +<!-- ##### MACRO GST_IS_BIN ##### --> <para> </para> @obj: -<!-- ##### SECTION ./tmpl/gstfilter.sgml:Short_Description ##### --> -Take data in and spit data out - - -<!-- ##### MACRO GST_SRC_ASYNC ##### --> -<para> -This macro checks to see if the GST_SRC_ASYNC flag is set. -</para> - -@obj: GstSrc to check for flag in. - -<!-- ##### MACRO GST_TYPE_SINESRC ##### --> -<para> - -</para> - - -<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### STRUCT GstFdSrcClass ##### --> -<para> - -</para> - - -<!-- ##### MACRO GST_CPU_FLAG_SSE ##### --> -<para> -A flag indicating that SSE instructions are supported. -</para> - - -<!-- ##### FUNCTION gst_esdsink_sync_parms ##### --> +<!-- ##### MACRO GST_TYPE_PAD ##### --> <para> </para> -@esdsink: -<!-- ##### MACRO GST_IS_CONNECTION_CLASS ##### --> +<!-- ##### MACRO GST_IS_TEE ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_connection_push ##### --> +<!-- ##### FUNCTION gst_elementfactory_add_sink ##### --> <para> </para> -@connection: +@elementfactory: +@id: -<!-- ##### SIGNAL GstBin::object-added ##### --> +<!-- ##### FUNCTION gst_fakesrc_get_type ##### --> <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 +@Returns: -<!-- ##### STRUCT GstDiskSrcClass ##### --> +<!-- ##### TYPEDEF GstPropsListFactory[] ##### --> <para> </para> -<!-- ##### FUNCTION gst_audiosink_new ##### --> +<!-- ##### FUNCTION gst_pad_get_type_id ##### --> <para> </para> -@name: +@pad: @Returns: -<!-- ##### ARG GstAsyncDiskSrc:size ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gst_element_get_type ##### --> +<!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### --> <para> </para> -@Returns: -<!-- ##### MACRO GST_ESDSINK ##### --> +<!-- ##### FUNCTION gst_queue_chain ##### --> <para> </para> -@obj: +@pad: +@buf: -<!-- ##### STRUCT GstElementClass ##### --> +<!-- ##### STRUCT GstAudioSink ##### --> <para> </para> -<!-- ##### MACRO GST_IS_SRC ##### --> +<!-- ##### FUNCTION gst_audiosink_chain ##### --> <para> </para> -@obj: +@pad: +@buf: -<!-- ##### FUNCTION gst_type_initialize ##### --> +<!-- ##### MACRO GST_OBJECT_CLASS ##### --> <para> </para> +@klass: -<!-- ##### SECTION ./tmpl/gstfilter.sgml:Title ##### --> -GstFilter - - -<!-- ##### MACRO GST_TEE ##### --> +<!-- ##### MACRO GST_THREAD ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### --> +<!-- ##### MACRO GST_IS_FAKESINK_CLASS ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_fdsrc_get_type ##### --> +<!-- ##### MACRO GST_CONNECTION_CLASS ##### --> <para> </para> -@Returns: +@klass: -<!-- ##### SIGNAL GstFakeSrc::handoff ##### --> +<!-- ##### STRUCT GstFdSrc ##### --> <para> </para> -@gstfakesrc: the object which received the signal. -<!-- ##### ENUM GstPropsId ##### --> +<!-- ##### STRUCT GstTeeClass ##### --> <para> </para> -@GST_PROPS_END_ID_NUM: -@GST_PROPS_LIST_ID_NUM: -@GST_PROPS_INT_ID_NUM: -@GST_PROPS_INT_RANGE_ID_NUM: -@GST_PROPS_FOURCC_ID_NUM: -@GST_PROPS_BOOL_ID_NUM: -<!-- ##### FUNCTION gst_pad_get_caps ##### --> +<!-- ##### FUNCTION gst_sinesrc_push ##### --> <para> </para> -@pad: -@Returns: +@src: -<!-- ##### FUNCTION gst_pad_get_type_id ##### --> +<!-- ##### FUNCTION gst_audiosink_set_frequency ##### --> <para> </para> -@pad: -@Returns: +@audiosink: +@frequency: -<!-- ##### FUNCTION gst_thread_iterate ##### --> +<!-- ##### MACRO GST_TYPE_QUEUE ##### --> <para> </para> -@thread: -<!-- ##### ENUM GstCapsDefinition ##### --> +<!-- ##### FUNCTION gst_elementfactory_register ##### --> <para> </para> -@GST_CAPS_ALWAYS: -@GST_CAPS_MAYBE: +@elementfactory: -<!-- ##### ARG GstFdSrc:offset ##### --> +<!-- ##### FUNCTION gst_audiosink_get_type ##### --> <para> -Get the current offset in the file. -</para> - -<!-- ##### ARG GstPipefilter:command ##### --> -<para> -Sets the command to be executed. </para> +@Returns: -<!-- ##### STRUCT GstPadClass ##### --> +<!-- ##### MACRO GST_META ##### --> <para> </para> +@meta: -<!-- ##### ENUM GstSrcFlags ##### --> +<!-- ##### FUNCTION gst_httpsrc_get_type ##### --> <para> -Flags for the GstSrc element -</para> - -@GST_SRC_ASYNC: Indicates that this src is asynchronous -@GST_SRC_FLAG_LAST: subclasses can use this to number their flags -<!-- ##### ARG GstQueue:max_level ##### --> -<para> -Specify the maximum number of buffers in the queue before the queue -blocks. </para> +@Returns: -<!-- ##### ARG GstQueue:level ##### --> +<!-- ##### FUNCTION gst_identity_get_type ##### --> <para> -Get the number of buffers in the queue. + </para> +@Returns: -<!-- ##### MACRO GST_HTTPSRC ##### --> +<!-- ##### MACRO GST_IS_ESDSINK ##### --> <para> </para> @obj: -<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### --> -GstColorSpace - - -<!-- ##### STRUCT GstAsyncDiskSrc ##### --> +<!-- ##### FUNCTION gst_disksrc_get_type ##### --> <para> </para> +@Returns: -<!-- ##### FUNCTION gst_element_change_state ##### --> +<!-- ##### MACRO GST_FDSINK ##### --> <para> </para> -@element: -@state: -@Returns: +@obj: -<!-- ##### STRUCT GstQueue ##### --> +<!-- ##### STRUCT GstElementClass ##### --> <para> </para> -<!-- ##### STRUCT GstFilter ##### --> +<!-- ##### MACRO GST_TYPE_FILTER ##### --> <para> </para> -<!-- ##### MACRO GST_IS_BIN ##### --> +<!-- ##### MACRO GST_IS_SINESRC_CLASS ##### --> <para> </para> @obj: -<!-- ##### FUNCTION plugin_initialize ##### --> +<!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### --> <para> </para> +@obj: -<!-- ##### ARG GstAsyncDiskSrc:location ##### --> -<para> -Specify the location of the file to read. -</para> - - -<!-- ##### MACRO GST_TEE_CLASS ##### --> +<!-- ##### MACRO GST_IS_FDSRC ##### --> <para> </para> -@klass: +@obj: -<!-- ##### FUNCTION gst_queue_get_type ##### --> +<!-- ##### STRUCT GstObjectClass ##### --> <para> </para> -@Returns: -<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/GstElement.sgml:Title ##### --> +GstElement -@Returns: -<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### --> +<!-- ##### MACRO GST_IS_ELEMENT_CLASS ##### --> <para> </para> -@klass: +@obj: -<!-- ##### ARG GstIdentity:loop_based ##### --> +<!-- ##### STRUCT GstFilterClass ##### --> <para> </para> -<!-- ##### MACRO GST_SRC_CLASS ##### --> +<!-- ##### STRUCT GstFakeSrc ##### --> <para> </para> -@klass: -<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Long_Description ##### --> +<!-- ##### SECTION ./tmpl/gstesdsink.sgml:See_Also ##### --> <para> </para> -<!-- ##### FUNCTION gst_type_load_thyself ##### --> +<!-- ##### FUNCTION gst_pad_set_pull_function ##### --> <para> </para> -@parent: -@Returns: +@pad: +@pull: -<!-- ##### FUNCTION gst_esdsink_new ##### --> +<!-- ##### STRUCT GstFakeSinkClass ##### --> <para> </para> -@name: -@Returns: -<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### --> +<!-- ##### FUNCTION gst_esdsink_set_format ##### --> <para> </para> +@esdsink: +@format: -<!-- ##### MACRO DEBUG_LEAVE ##### --> +<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### --> <para> +Query whether this object has multiple input pads. </para> -@format: -@args...: +@obj: Element to query for multiple input pads. -<!-- ##### FUNCTION gst_audiosink_set_format ##### --> +<!-- ##### MACRO GST_DISKSRC_CLASS ##### --> <para> </para> -@audiosink: -@format: +@klass: -<!-- ##### MACRO GST_SINESRC ##### --> +<!-- ##### MACRO GST_PROPS_BOOL_ID ##### --> <para> </para> -@obj: - -<!-- ##### SECTION ./tmpl/gstsink.sgml:Short_Description ##### --> -The end point of a filter graph - -<!-- ##### MACRO INFO ##### --> +<!-- ##### MACRO GST_TYPE_FAKESINK ##### --> <para> </para> -@cat: -@format: -@args...: -<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### --> +<!-- ##### MACRO GST_CONNECTION ##### --> <para> </para> @obj: -<!-- ##### FUNCTION gst_sinesrc_new ##### --> -<para> +<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### --> -</para> -@name: -@Returns: -<!-- ##### ARG GstAudioSrc:curoffset ##### --> +<!-- ##### FUNCTION gst_audiosrc_push ##### --> <para> -Get the current number of bytes read. -</para> - -<!-- ##### ARG GstAudioSrc:channels ##### --> -<para> -The number of channels (mono, stereo, ...) </para> +@src: -<!-- ##### FUNCTION gst_plugin_init ##### --> +<!-- ##### MACRO GST_HTTPSRC_CLASS ##### --> <para> </para> +@klass: -<!-- ##### STRUCT GstFakeSink ##### --> +<!-- ##### MACRO GST_IS_CONNECTION_CLASS ##### --> <para> </para> +@obj: -<!-- ##### SECTION ./tmpl/plugin.sgml:Title ##### --> -plugin - - -<!-- ##### MACRO GST_STATE_IS_SET ##### --> -<para> -This macro checks to see if the given state is set. -</para> - -@obj: Element to check for state. -@flag: State to check for, must be a single bit in guint32. - -<!-- ##### SIGNAL GstObject::parent-set ##### --> +<!-- ##### MACRO GST_IS_FILTER ##### --> <para> </para> -@gstobject: the object which received the signal. -@arg1: the new parent +@obj: -<!-- ##### MACRO GST_IS_PAD ##### --> +<!-- ##### MACRO GST_IS_THREAD_CLASS ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_PROPS_LIST_ID ##### --> +<!-- ##### MACRO GST_IDENTITY ##### --> <para> </para> +@obj: -<!-- ##### SECTION ./tmpl/gstconnection.sgml:See_Also ##### --> +<!-- ##### STRUCT GstIdentity ##### --> <para> </para> -<!-- ##### FUNCTION plugin_load ##### --> +<!-- ##### FUNCTION gst_fdsink_new_with_fd ##### --> <para> </para> @name: +@fd: @Returns: -<!-- ##### MACRO GST_IS_ELEMENT ##### --> -<para> - -</para> +<!-- ##### SECTION ./tmpl/gstfilter.sgml:Title ##### --> +GstFilter -@obj: -<!-- ##### STRUCT GstFakeSrcClass ##### --> +<!-- ##### FUNCTION gst_elementfactory_add_src ##### --> <para> </para> +@elementfactory: +@id: -<!-- ##### FUNCTION gst_type_dump ##### --> +<!-- ##### MACRO GST_BUFFER_POOL ##### --> <para> </para> +@buf: -<!-- ##### MACRO GST_IS_ASYNCDISKSRC ##### --> +<!-- ##### FUNCTION gst_pad_get_caps ##### --> <para> </para> -@obj: +@pad: +@Returns: -<!-- ##### SIGNAL GstElement::error ##### --> +<!-- ##### FUNCTION gst_audiosink_set_format ##### --> <para> -Is trigered whenever an error occured </para> -@gstelement: the object which received the signal. -@arg1: the error message +@audiosink: +@format: -<!-- ##### ARG GstAudioSink:channels ##### --> +<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### --> <para> </para> +@klass: -<!-- ##### MACRO GST_SRC_SET_FLAGS ##### --> +<!-- ##### MACRO GST_IS_AUDIOSINK ##### --> <para> -This macro sets the given flags. + </para> -@src: -@flag: Flag to set, can by any number of bits in guint32. -@obj: GstSrc to set flag in. +@obj: -<!-- ##### MACRO GST_BIN_CLASS ##### --> +<!-- ##### FUNCTION gst_filter_get_type ##### --> <para> </para> -@klass: +@Returns: -<!-- ##### MACRO GST_ASYNCDISKSRC ##### --> +<!-- ##### MACRO GST_SRC ##### --> <para> </para> @obj: -<!-- ##### MACRO GST_HTTPSRC_CLASS ##### --> +<!-- ##### MACRO INFO_ELEMENT ##### --> <para> </para> -@klass: +@cat: +@element: +@format: +@args...: -<!-- ##### MACRO DEBUG_LEAVE_STRING ##### --> +<!-- ##### MACRO GST_IS_CONNECTION ##### --> <para> </para> +@obj: -<!-- ##### ARG GstPad:active ##### --> -<para> -Indicates this pad is active -</para> - - -<!-- ##### FUNCTION gst_filter_get_type ##### --> +<!-- ##### MACRO GST_IS_DISKSRC ##### --> <para> </para> -@Returns: +@obj: -<!-- ##### FUNCTION plugin_load_absolute ##### --> +<!-- ##### FUNCTION gst_audiosink_new ##### --> <para> </para> @@ -2504,24 +2191,12 @@ Indicates this pad is active @name: @Returns: -<!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### --> -<para> -A GstSrc is the start of a filter graph. It typically is a file or an -audio source. It provides data for the next element in the graph. - -</para> - - -<!-- ##### STRUCT GstObjectClass ##### --> +<!-- ##### MACRO GST_TYPE_ESDSINK ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### --> -GstSink - - <!-- ##### MACRO GST_CPU_FLAG_MMX ##### --> <para> A flag indicating that MMX instructions are supported. diff --git a/docs/gst/tmpl/gstsinesrc.sgml b/docs/gst/tmpl/gstsinesrc.sgml index 687c03392d..7768424330 100644 --- a/docs/gst/tmpl/gstsinesrc.sgml +++ b/docs/gst/tmpl/gstsinesrc.sgml @@ -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> + diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 659af8e5a5..1a0aed88c8 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -43,3 +43,9 @@ thread flags @Returns: +<!-- ##### ARG GstThread:create_thread ##### --> +<para> +TRUE if the thread should be created. + +</para> + diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml index 4fb5972710..ace6c21877 100644 --- a/docs/gst/tmpl/gsttypefind.sgml +++ b/docs/gst/tmpl/gsttypefind.sgml @@ -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. +@arg1: The mime type that was detected + +<!-- ##### ARG GstTypeFind:caps ##### --> +<para> + +</para> + diff --git a/docs/manual/Makefile.am b/docs/manual/Makefile.am index 2da008035b..4caef094b3 100644 --- a/docs/manual/Makefile.am +++ b/docs/manual/Makefile.am @@ -12,7 +12,6 @@ sgml_files = gstreamer-manual.sgml \ dynamic.sgml \ elements.sgml \ factories.sgml \ - ghostpads.sgml \ goals.sgml \ helloworld.sgml \ helloworld2.sgml \ diff --git a/docs/manual/bins.sgml b/docs/manual/bins.sgml index e9069b326c..eb89b4c475 100644 --- a/docs/manual/bins.sgml +++ b/docs/manual/bins.sgml @@ -41,31 +41,119 @@ </itemizedlist> </para> - <para> - The application programmer can create custom bins packed with elements to perform a - specific task. This allow you to write an MPEG audio decoder with just the follwing lines - of code: + <sect1 id="sec-bin-create"> + <title>Creating a bin</title> + <para> + You create a bin with a specified name 'mybin' with: + </para> + <programlisting> + GstElement *bin; + + gst_bin_new ("mybin"); + ... + </programlisting> + <para> + A thread can be created with: + </para> + <programlisting> + GstElement *thread; + + gst_thread_new ("mythread"); + ... + </programlisting> + <para> + Pipelines are created with gst_pipeline_new ("name"); + </para> + </sect1> + <sect1 id="sec-bin-adding"> + <title>Adding elements to a bin</title> + <para> + Elements are added to a bin with the following code sample: + </para> + <programlisting> + GstElement *element; + GstElement *bin; + + bin = gst_bin_new ("mybin"); + + element = gst_elementfactory_make ("mpg123", "decoder"); + gst_bin_add (GST_BIN (bin), element); + ... + </programlisting> + <para> + Bins and threads can be added to other bins too. This allows you to create nested + bins. + </para> + <para> + To get an element from the bin you can use: + </para> + <programlisting> + GstElement *element; + + element = gst_bin_get_by_name (GST_BIN (bin), "decoder"); + ... + </programlisting> + <para> + You can see that the name of the element becomes very handy for retrieving the + element from an bin by using the elements name. gst_bin_get_by_name () will + recursively search nested bins. + </para> + <para> + To get a list of elements in a bin, use: + </para> <programlisting> + GList *elements; + + elements = gst_bin_get_list (GST_BIN (bin)); - // create the mp3player element - GstElement *mp3player = gst_elementfactory_make("mp3player","mp3player"); - // set the source mp3 audio file - gtk_object_set(GTK_OBJECT(mp3player), "location", "helloworld.mp3", NULL); - // tell the mp3player to prepare itself - gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_READY); - // start playback - gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_PLAYING); - ... - // pause playback - gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_PAUSED); - ... - // stop - gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_NULL); + while (elements) { + GstElement *element = GST_ELEMENT (elements->data); + + g_print ("element in bin: %s\n", gst_element_get_name (element)); + + elements = g_list_next (elements); + } + ... </programlisting> + <para> + To remove an element from a bin use: + </para> + <programlisting> + GstElement *element; + + gst_bin_remove (GST_BIN (bin), element); + ... + </programlisting> + </sect1> - Custom bins can be created with a plugin or an XML description. - </para> + <sect1 id="sec-bin-custom"> + <title>Custom bins</title> + <para> + The application programmer can create custom bins packed with elements to perform a + specific task. This allow you to write an MPEG audio decoder with just the follwing lines + of code: + + <programlisting> + + // create the mp3player element + GstElement *mp3player = gst_elementfactory_make("mp3player","mp3player"); + // set the source mp3 audio file + gtk_object_set(GTK_OBJECT(mp3player), "location", "helloworld.mp3", NULL); + // start playback + gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_PLAYING); + ... + // pause playback + gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_PAUSED); + ... + // stop + gst_element_set_state(GST_ELEMENT(mp3player),GST_STATE_NULL); + </programlisting> + + Custom bins can be created with a plugin or an XML description. You will find more + information about creating custom bin in the Filter-Writers-Guide. + </para> + </sect1> <sect1 id="sec-bin-ghostpads"> <title>Ghostpads</title> @@ -76,7 +164,8 @@ <para> A ghostpad is a pad from some element in the bin that has been promoted to the bin. This way, the bin also has a pad. The bin becomes just another element with a pad and - you can then use the bin just like any other element. + you can then use the bin just like any other element. This is a very important feature + for creating custom bins. </para> <figure float="1" id="sec-bin-ghost-img"> @@ -87,6 +176,35 @@ Above is a representation of a ghostpad. the sinkpad of element one is now also a pad of the bin. </para> + <para> + Ghostpads can actually be added to all <classname>GstElement</classname>s and not just + <classname>GstBin</classname>s. Use the following code example to add a ghostpad to a bin: + </para> + <programlisting> + GstElement *bin; + GstElement *element; + + element = gst_elementfactory_create ("mpg123", "decoder"); + bin = gst_bin_new ("mybin"); + + gst_bin_add (GST_BIN (bin), element); + + gst_element_add_ghost_pad (bin, gst_element_get_pad (element, "sink")); + + </programlisting> + <para> + In the above example, the bin now also has a pad: the pad called 'sink' of the + given element. We can now, for example, connect the srcpad of a disksrc to the + bin with: + </para> + <programlisting> + GstElement *disksrc; + + disksrc = gst_elementfactory_create ("disksrc", "disk_reader"); + + gst_element_connect (disksrc, "src", bin, "sink"); + ... + </programlisting> </sect1> </chapter> diff --git a/docs/manual/connections.sgml b/docs/manual/connections.sgml index 814aaf1065..ca352dc240 100644 --- a/docs/manual/connections.sgml +++ b/docs/manual/connections.sgml @@ -21,4 +21,41 @@ audiocard. We will use this simple graph to construct an mpeg player later in this manual. </para> + <para> + You can connect two pads with: + </para> + <programlisting> + GstPad *srcpad, *sinkpad; + + srcpad = gst_element_get_pad (element1, "src"); + sinpad = gst_element_get_pad (element2, "sink"); + + // connect them + gst_pad_connect (srcpad, sinkpad); + .... + // and disconnect them + gst_pad_disconnect (srcpad, sinkpad); + + </programlisting> + <para> + A convenient shortcut for the above code is done with the gst_element_connect () + function: + </para> + <programlisting> + + // connect them + gst_element_connect (element1, "src", element2, "sink"); + .... + // and disconnect them + gst_element_disconnect (element1, "src", element2, "sink"); + + </programlisting> + <para> + You can query if a pad is connected with GST_PAD_IS_CONNECTED (pad). + </para> + <para> + To query for the <classname>GstPad</classname> this srcpad is connected to, use + gst_pad_get_peer (srcpad). + </para> + </chapter> diff --git a/docs/manual/elements.sgml b/docs/manual/elements.sgml index 84f8c8e2f1..0702fc9818 100644 --- a/docs/manual/elements.sgml +++ b/docs/manual/elements.sgml @@ -93,4 +93,53 @@ </figure> </sect2> </sect1> + <sect1 id="sec-elements-create"> + <title>Creating a GstElement</title> + <para> + GstElements are created from factories. To create an element, one has to get + access the a <classname>GstElementFactory</classname> using a unique factoryname. + </para> + <para> + The following code example is used to get a factory that can be used to create the + mpg123 element, an mp3 decoder. + </para> + <programlisting> + GstElementFactory *factory; + + factory = gst_elementfactory_find ("mpg123"); + </programlisting> + <para> + Once you have the handle to the elementfactory, you can create a real element with + the following code fragment: + </para> + <programlisting> + GstElement *element; + + element = gst_elementfactory_create (factory, "decoder"); + </programlisting> + <para> + gst_elementfactory_create () will use the elementfactory to create an element with the + given name. The name of the element is something you can use later on to lookup the + element in a bin, for example. + </para> + <para> + A simple shortcut exists for creating an element from a factory. The following example + creates an element, named "decoder" from the elementfactory named "mpg123". This + convenient function is most widly used to create an element. + </para> + <programlisting> + GstElement *element; + + element = gst_elementfactory_make ("mpg123", "decoder"); + </programlisting> + <para> + An element can be destroyed with: + </para> + <programlisting> + GstElement *element; + + ... + gst_element_destroy (element); + </programlisting> + </sect1> </chapter> diff --git a/docs/manual/ghostpads.sgml b/docs/manual/ghostpads.sgml deleted file mode 100644 index 276ab416d5..0000000000 --- a/docs/manual/ghostpads.sgml +++ /dev/null @@ -1,6 +0,0 @@ -<chapter id="cha-ghostpads"> - <title>Ghostpads</title> - <para> - </para> - -</chapter> diff --git a/docs/manual/gstreamer-manual.sgml b/docs/manual/gstreamer-manual.sgml index be062eae77..06d9b221bd 100644 --- a/docs/manual/gstreamer-manual.sgml +++ b/docs/manual/gstreamer-manual.sgml @@ -18,7 +18,6 @@ <!ENTITY QUEUES SYSTEM "queues.sgml"> <!ENTITY COTHREADS SYSTEM "cothreads.sgml"> <!ENTITY DYNAMIC SYSTEM "dynamic.sgml"> -<!ENTITY GHOSTPADS SYSTEM "ghostpads.sgml"> <!ENTITY TYPEDETECTION SYSTEM "typedetection.sgml"> <!ENTITY UTILITY SYSTEM "utility.sgml"> @@ -98,6 +97,8 @@ <!-- ############ Basic concepts - chapter ############# --> &ELEMENTS; + &PLUGINS; + &PADS; &CONNECTIONS; @@ -107,6 +108,7 @@ &BUFFERS; &STATES; + </part> <!-- ############ Building Apps - part ############# --> @@ -151,8 +153,6 @@ &DYNAMIC; - &GHOSTPADS; - &TYPEDETECTION; &UTILITY; @@ -173,19 +173,6 @@ &XML; </part> -<!-- ############ XML in GStreamer - part ############# --> - - <part id="plugins"><title>plugin development in <application>GStreamer</application></title> - - <partintro> - <para> - In this part we will describe how you can create a new plugin - to be used in <application>GStreamer</application>. - </para> - </partintro> - - &PLUGINS; - </part> <!-- ############ Appendices - part ############# --> diff --git a/docs/manual/helloworld.sgml b/docs/manual/helloworld.sgml index f4acf28185..f9802e01c6 100644 --- a/docs/manual/helloworld.sgml +++ b/docs/manual/helloworld.sgml @@ -138,7 +138,7 @@ main (int argc, char *argv[]) bin = gst_bin_new ("bin"); </programlisting> <para> - We use the standard constructor for a bin: gst_bin_new (" + We use the standard constructor for a bin: gst_bin_new ("name"). </para> <para> diff --git a/docs/manual/pads.sgml b/docs/manual/pads.sgml index 5a7fbf050d..357bb3f6ec 100644 --- a/docs/manual/pads.sgml +++ b/docs/manual/pads.sgml @@ -9,6 +9,55 @@ The description of this media type is done with capabilities (<classname>GstCaps</classname>) </para> + <sect1 id="sec-pads-get"> + <title>Getting pads from an element</title> + <para> + Once you have created an element, you can get one of its pads with: + </para> + <programlisting> + GstPad *srcpad; + ... + srcpad = gst_element_get_pad (element, "src"); + ... + </programlisting> + <para> + This function will get the pad named "src" from the given element. + </para> + <para> + Alternatively, you can also request a GList of pads from the element. The following + code example will print the names of all the pads of an element. + </para> + <programlisting> + GList *pads; + ... + pads = gst_element_get_pad_list (element); + while (pads) { + GstPad *pad = GST_PAD (pads->data); + + g_print ("pad name %s\n", gst_pad_get_name (pad)); + + pads = g_list_next (pads); + } + ... + </programlisting> + <sect2 id="sec-pads-functions"> + <title>Usefull pad functions</title> + <para> + You can get the name of a pad with gst_pad_get_name () and set its name with + get_pad_set_name(); + </para> + <para> + gst_pad_get_direction (GstPad *pad) can be used to query if the pad is a sink + or a src pad. Remember a src pad is a pad that can output data and a sink pad is + one that accepts data. + </para> + <para> + You can get the parent of the pad, this is the element that this pad belongs to, + with get_pad_set_parent(GstPad *pad). This function will return a pointer to a + GstObject. + </para> + </sect2> + </sect1> <sect1 id="sec-pads-description"> <title>Capabilities of a GstPad</title> <para> @@ -136,6 +185,30 @@ Pads: </listitem> </itemizedlist> </sect2> + <sect2 id="sec-pads-caps-get"> + <title>Getting the capabilities of a pad</title> + <para> + A pad can have a GList of capabilities attached to it. You can get the capabilities list + with: + </para> + <programlisting> + GList *caps; + ... + caps = gst_pad_get_caps_list (pad); + + g_print ("pad name %s\n", gst_pad_get_name (pad)); + + while (caps) { + GstCaps *cap = (GstCaps *) caps->data; + + g_print (" Capability name %s, MIME type\n", gst_caps_get_name (cap), + gst_caps_get_mime (cap)); + + caps = g_list_next (caps); + } + ... + </programlisting> + </sect2> </sect1> </chapter> diff --git a/docs/manual/plugins.sgml b/docs/manual/plugins.sgml index 00ffa18986..4f7c57cbed 100644 --- a/docs/manual/plugins.sgml +++ b/docs/manual/plugins.sgml @@ -1,6 +1,63 @@ <chapter id="cha-plugins"> - <title>Plugin development</title> + <title>What are Plugins</title> <para> + A plugin is a shared library that contains at least one of the following items: </para> + <itemizedlist> + <listitem> + <para> + one or more elementfactories + </para> + </listitem> + <listitem> + <para> + one or more typedefinitions + </para> + </listitem> + </itemizedlist> + <para> + The plugins have one simple method: plugin_init () where all the elementfactories are + created and the typedefinitions are registered. + </para> + <para> + the plugins are maintained in the plugin system. Optionally, the typedefinitions and + the elementfactories can be saved into an XML representation so that the plugin system + does not have to load all available plugins in order to know their definition. + </para> + + <para> + The basic plugin structure has the following fields: + </para> + <programlisting> +struct _GstPlugin { + gchar *name; /* name of the plugin */ + gchar *longname; /* long name of plugin */ + gchar *filename; /* filename it came from */ + + GList *types; /* list of types provided */ + gint numtypes; + GList *elements; /* list of elements provided */ + gint numelements; + + gboolean loaded; /* if the plugin is in memory */ +}; + </programlisting> + + <para> + You can query a GList of available plugins with: + </para> + <programlisting> + GList *plugins; + + plugins = gst_plugin_get_list (); + + while (plugins) { + GstPlugin *plugin = (GstPlugin *)plugins->data; + + g_print ("plugin: %s\n", gst_plugin_get_name (plugin)); + + plugins = g_list_next (plugins); + } + </programlisting> </chapter> diff --git a/docs/manuals.mak b/docs/manuals.mak index 91940a63fb..4bba6ae992 100644 --- a/docs/manuals.mak +++ b/docs/manuals.mak @@ -15,6 +15,7 @@ $(manualname)/$(htmlname): $(sgml_files) $(png_files) else $(manualname)/$(htmlname): $(sgml_files) endif + if HAVE_DB2HTML db2html $(manualname).sgml else |