mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 03:31:05 +00:00
Code Issues 1 Projects Releases Wiki Activity

API docs updates

Browse source 
Original commit message from CVS:
API docs updates
This commit is contained in:
Wim Taymans 2001-03-21 21:43:56 +00:00
parent d80375c632
commit 1d040471a4
21 changed files with 2112 additions and 1286 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -27,6 +27,8 @@
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
<!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
<!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
@ -150,6 +152,16 @@ with some more specialized elements.</para>
&videoraw;
</chapter>
<chapter id="autopluggers">
<title>GStreamer Autoppluggers</title>
<para>the autopluggers provide a way to automatically construct elements based on
sink and src capabilities</para>
&GstStaticAutoplug;
&GstStaticAutoplugRender;
</chapter>
<chapter id="gst-index">
<title>Index</title>

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

@ -120,6 +120,7 @@ gst_parse_launch
GST_ARCH_CALL
GST_ARCH_SET_SP
GST_ARCH_SETUP_STACK
GST_ARCH_PRESETJMP
</SECTION>
<SECTION>
@ -191,6 +192,7 @@ GST_ELEMENT_IS_COTHREAD_STOPPING
GST_ELEMENT_IS_EOS
GST_ELEMENT_PARENT
GST_ELEMENT_NAME
GST_ELEMENT_PADS
GstElement
GstElementDetails
GstElementFactory
@ -227,8 +229,6 @@ gst_elementfactory_find
gst_elementfactory_get_list
gst_elementfactory_can_src_caps
gst_elementfactory_can_sink_caps
gst_elementfactory_can_src_caps_list
gst_elementfactory_can_sink_caps_list
gst_elementfactory_create
gst_elementfactory_make
gst_elementfactory_save_thyself
@ -243,6 +243,32 @@ GST_IS_ELEMENT_CLASS
gst_element_get_type
</SECTION>
<SECTION>
<FILE>gstautoplug</FILE>
<TITLE>GstAutoplug</TITLE>
GstAutoplug
GstAutoplugFlags
GstAutoplugFactory
gst_autoplug_signal_new_object
gst_autoplug_to_caps
gst_autoplug_to_renderers
gst_autoplugfactory_new
gst_autoplugfactory_destroy
gst_autoplugfactory_find
gst_autoplugfactory_get_list
gst_autoplugfactory_create
gst_autoplugfactory_make
gst_autoplugfactory_save_thyself
gst_autoplugfactory_load_thyself
<SUBSECTION Standard>
GST_AUTOPLUG
GST_IS_AUTOPLUG
GST_TYPE_AUTOPLUG
gst_autoplug_get_type
GST_AUTOPLUG_CLASS
GST_IS_AUTOPLUG_CLASS
</SECTION>
<SECTION>
<FILE>gstclock</FILE>
GstClockTime
@ -341,6 +367,10 @@ GstPadGetRegionFunction
GstPadQoSFunction
GstPadEOSFunction
GstPadNegotiateReturn
GstPadNegotiateFunction
GstPadPushFunction
GstPadPullFunction
GstRegionType
@ -355,11 +385,11 @@ gst_pad_get_direction
gst_pad_set_chain_function
gst_pad_set_get_function
gst_pad_set_getregion_function
gst_pad_set_negotiate_function
gst_pad_set_qos_function
gst_pad_set_eos_function
gst_pad_set_caps_list
gst_pad_get_caps_list
gst_pad_get_caps_by_name
gst_pad_set_caps
gst_pad_get_caps
gst_pad_check_compatibility
gst_pad_set_name
gst_pad_get_name
@ -367,6 +397,7 @@ gst_pad_set_element_private
gst_pad_get_element_private
gst_pad_set_parent
gst_pad_get_parent
gst_pad_get_real_parent
gst_pad_add_ghost_pad
gst_pad_remove_ghost_pad
gst_pad_get_ghost_pad_list
@ -380,6 +411,11 @@ gst_pad_set_eos
gst_pad_handle_qos
gst_pad_eos
gst_pad_load_and_connect
gst_pad_negotiate_proxy
gst_pad_renegotiate
gst_pad_get_padtemplate
gst_pad_get_padtemplate_caps
GST_RPAD_LEN
GST_RPAD_OFFSET
@ -398,6 +434,7 @@ GST_RPAD_PULLFUNC
GST_RPAD_PULLREGIONFUNC
GST_RPAD_QOSFUNC
GST_RPAD_EOSFUNC
GST_RPAD_NEGOTIATEFUNC
GST_GPAD_REALPAD
GstGhostPad
@ -414,10 +451,16 @@ GST_PAD_FACTORY_CAPS
GstPadPresence
GstPadTemplate
GST_PADTEMPLATE_CAPS
GST_PADTEMPLATE_DIRECTION
GST_PADTEMPLATE_NAME_TEMPLATE
GST_PADTEMPLATE_PRESENCE
gst_padtemplate_new
gst_padtemplate_create
gst_padtemplate_load_thyself
gst_padtemplate_save_thyself
gst_padtemplate_get_caps
gst_padtemplate_get_caps_by_name
<SUBSECTION Standard>
GstPadClass
@ -451,6 +494,7 @@ GST_PADTEMPLATE_CLASS
GST_IS_PADTEMPLATE
GST_IS_PADTEMPLATE_CLASS
gst_padtemplate_get_type
GST_PAD_FACTORY_CAPS_ID
</SECTION>
<SECTION>
@ -458,9 +502,6 @@ gst_padtemplate_get_type
<TITLE>GstPipeline</TITLE>
GstPipeline
gst_pipeline_new
gst_pipeline_add_sink
gst_pipeline_add_src
gst_pipeline_autoplug
gst_pipeline_destroy
gst_pipeline_iterate
<SUBSECTION Standard>
@ -474,25 +515,6 @@ GST_IS_PIPELINE_CLASS
gst_pipeline_details
</SECTION>
<SECTION>
<FILE>gstautoplug</FILE>
<TITLE>GstAutoplug</TITLE>
GST_AUTOPLUG_MAX_COST
GstAutoplugCostFunction
GstAutoplugListFunction
gst_autoplug_caps
gst_autoplug_pads
gst_autoplug_caps_list
<SUBSECTION Standard>
GstAutoplug
GST_AUTOPLUG
GST_IS_AUTOPLUG
GST_TYPE_AUTOPLUG
gst_autoplug_get_type
GST_AUTOPLUG_CLASS
GST_IS_AUTOPLUG_CLASS
</SECTION>
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
@ -513,13 +535,15 @@ gst_plugin_add_path
gst_library_load
gst_plugin_add_factory
gst_plugin_add_type
gst_plugin_add_autoplugger
gst_plugin_find
gst_plugin_get_list
gst_plugin_get_factory_list
gst_plugin_get_type_list
gst_plugin_find_elementfactory
gst_plugin_get_autoplug_list
gst_plugin_load_elementfactory
gst_plugin_load_typefactory
gst_plugin_load_autoplugfactory
gst_plugin_load_thyself
gst_plugin_save_thyself
<SUBSECTION Standard>
@ -596,22 +620,36 @@ gst_typefactory_save_thyself
<FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
GstCaps
GstCapsFactory
GstCapsFactoryEntry
GstCapsFactory[]
gst_caps_new
gst_caps_new_with_props
gst_caps_destroy
gst_caps_ref
gst_caps_unref
gst_caps_register
gst_caps_register_count
gst_caps_copy
gst_caps_copy_on_write
gst_caps_append
gst_caps_prepend
gst_caps_set_name
gst_caps_get_name
gst_caps_set_mime
gst_caps_set_type_id
gst_caps_get_type_id
gst_caps_set_mime
gst_caps_get_mime
gst_caps_set_name
gst_caps_set_props
gst_caps_get_props
gst_caps_check_compatibility
gst_caps_list_check_compatibility
gst_caps_set
gst_caps_get_boolean
gst_caps_get_by_name
gst_caps_get_fourcc_int
gst_caps_get_int
gst_caps_save_thyself
gst_caps_load_thyself
<SUBSECTION Standard>
@ -633,7 +671,16 @@ gst_props_register
gst_props_register_count
gst_props_new
gst_props_merge
gst_props_copy
gst_props_copy_on_write
gst_props_destroy
gst_props_ref
gst_props_unref
gst_props_check_compatibility
gst_props_set
gst_props_get_boolean
gst_props_get_fourcc_int
gst_props_get_int
gst_props_save_thyself
gst_props_load_thyself
<SUBSECTION Standard>
@ -652,6 +699,7 @@ GST_PROPS_LAST_ID
<SECTION>
<FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
gst_util_set_object_arg
gst_util_get_int_arg
gst_util_get_bool_arg
gst_util_get_long_arg
@ -694,6 +742,32 @@ GstCPUFlags
gst_cpu_get_flags
</SECTION>
<SECTION>
<FILE>gststaticautoplug</FILE>
<TITLE>GstStaticAutoplug</TITLE>
<SUBSECTION Standard>
GstStaticAutoplug
GST_STATIC_AUTOPLUG
GST_IS_STATIC_AUTOPLUG
GST_TYPE_STATIC_AUTOPLUG
gst_static_autoplug_get_type
GST_STATIC_AUTOPLUG_CLASS
GST_IS_STATIC_AUTOPLUG_CLASS
</SECTION>
<SECTION>
<FILE>gststaticautoplugrender</FILE>
<TITLE>GstStaticAutoplugRender</TITLE>
<SUBSECTION Standard>
GstStaticAutoplugRender
GST_STATIC_AUTOPLUG_RENDER
GST_IS_STATIC_AUTOPLUG_RENDER
GST_TYPE_STATIC_AUTOPLUG_RENDER
gst_static_autoplug_render_get_type
GST_STATIC_AUTOPLUG_RENDER_CLASS
GST_IS_STATIC_AUTOPLUG_RENDER_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiosink</FILE>
<TITLE>GstAudioSink</TITLE>

7
docs/gst/tmpl/gstarch.sgml
View file

@ -38,3 +38,10 @@ gstarch
@sp:
<!-- ##### MACRO GST_ARCH_PRESETJMP ##### -->
<para>
</para>

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

@ -2,12 +2,12 @@
GstAutoplug
<!-- ##### SECTION Short_Description ##### -->
Provide automatic element selection.
Automatically create and connect elements
<!-- ##### SECTION Long_Description ##### -->
<para>
The autoplugger can select a list of elements that are needed
to convert a certain GstCaps to another one.
GstAutoplug is an abstract class that is used for constructing and
connecting elements.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -15,18 +15,134 @@ to convert a certain GstCaps to another one.
</para>
<!-- ##### FUNCTION gst_autoplug_caps_list ##### -->
<!-- ##### STRUCT GstAutoplug ##### -->
<para>
</para>
@object:
<!-- ##### ENUM GstAutoplugFlags ##### -->
<para>
</para>
@GST_AUTOPLUG_TO_CAPS:
@GST_AUTOPLUG_TO_RENDERER:
@GST_AUTOPLUG_FLAG_LAST:
<!-- ##### STRUCT GstAutoplugFactory ##### -->
<para>
</para>
@name:
@longdesc:
@type:
<!-- ##### FUNCTION gst_autoplug_signal_new_object ##### -->
<para>
</para>
@autoplug:
@object:
<!-- ##### FUNCTION gst_autoplug_to_caps ##### -->
<para>
</para>
@autoplug:
@srcpad:
@sinkpad:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@srccaps:
@sinkcaps:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_autoplug_to_renderers ##### -->
<para>
</para>
@autoplug:
@srccaps:
@target:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_new ##### -->
<para>
</para>
@name:
@longdesc:
@type:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gst_autoplugfactory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_create ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_make ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_autoplugfactory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:

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

@ -22,7 +22,15 @@ a mime-type and a set of properties.
@name: the name of the capability, for the application
@id: the typeid of the capability
@refcount:
@properties: the properties of the capability
@next:
<!-- ##### TYPEDEF GstCapsFactory ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
@ -57,6 +65,30 @@ a mime-type and a set of properties.
@Returns:
<!-- ##### FUNCTION gst_caps_destroy ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_ref ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_unref ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_register ##### -->
<para>
@ -78,6 +110,53 @@ a mime-type and a set of properties.
@count:
<!-- ##### FUNCTION gst_caps_copy ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_append ##### -->
<para>
</para>
@caps:
@capstoadd:
@Returns:
<!-- ##### FUNCTION gst_caps_prepend ##### -->
<para>
</para>
@caps:
@capstoadd:
@Returns:
<!-- ##### FUNCTION gst_caps_set_name ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_get_name ##### -->
<para>
@ -87,6 +166,27 @@ a mime-type and a set of properties.
@Returns:
<!-- ##### FUNCTION gst_caps_set_type_id ##### -->
<para>
</para>
@caps:
@type_id:
<!-- # Unused Parameters # -->
@Param2:
@typeid:
<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_set_mime ##### -->
<para>
@ -96,26 +196,6 @@ a mime-type and a set of properties.
@mime:
<!-- ##### FUNCTION gst_caps_set_type_id ##### -->
<para>
</para>
@caps:
@Param2:
<!-- # Unused Parameters # -->
@typeid:
<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_get_mime ##### -->
<para>
@ -125,15 +205,6 @@ a mime-type and a set of properties.
@Returns:
<!-- ##### FUNCTION gst_caps_set_name ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_set_props ##### -->
<para>
@ -166,16 +237,53 @@ a mime-type and a set of properties.
@caps2:
<!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
<!-- ##### MACRO gst_caps_set ##### -->
<para>
</para>
@fromcaps:
@tocaps:
@caps:
@name:
@args...:
<!-- ##### MACRO gst_caps_get_boolean ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_get_by_name ##### -->
<para>
</para>
@caps:
@name:
@Returns:
<!-- ##### MACRO gst_caps_get_fourcc_int ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### MACRO gst_caps_get_int ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
<para>

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

@ -25,6 +25,8 @@ features of the CPU.
@GST_CPU_FLAG_MMX:
@GST_CPU_FLAG_SSE:
@GST_CPU_FLAG_MMXEXT:
@GST_CPU_FLAG_3DNOW:
<!-- ##### FUNCTION gst_cpu_get_flags ##### -->
<para>

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

@ -174,6 +174,14 @@ Get the name of this element.
@obj: The element to query
<!-- ##### MACRO GST_ELEMENT_PADS ##### -->
<para>
Get the pads of this elements.
</para>
@obj: The element to query
<!-- ##### STRUCT GstElement ##### -->
<para>
@ -519,26 +527,6 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_can_src_caps_list ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_can_sink_caps_list ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_create ##### -->
<para>

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

@ -155,6 +155,26 @@ The function that will be called in an EOS case.
@Returns: TRUE if EOS was successful, FALSE otherwise
<!-- ##### ENUM GstPadNegotiateReturn ##### -->
<para>
The possible results from padnegotiation.
</para>
@GST_PAD_NEGOTIATE_FAIL: The pads could not agree about the media type.
@GST_PAD_NEGOTIATE_AGREE: The pads agreed about the media type.
@GST_PAD_NEGOTIATE_TRY: The pad did not agree and suggests another media type.
<!-- ##### USER_FUNCTION GstPadNegotiateFunction ##### -->
<para>
The function that will be called when negotiating.
</para>
@pad: The pad that is being negotiated
@caps: The current caps that are being negotiated
@count: A counter to keep track of the negotiation process
@Returns: The result of the negotiation process
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para>
@ -282,6 +302,15 @@ Destroy the pad.
@getregion:
<!-- ##### FUNCTION gst_pad_set_negotiate_function ##### -->
<para>
</para>
@pad:
@nego:
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
<para>
@ -300,31 +329,22 @@ Destroy the pad.
@eos:
<!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
<!-- ##### FUNCTION gst_pad_set_caps ##### -->
<para>
</para>
@pad:
@caps:
<!-- ##### FUNCTION gst_pad_get_caps_list ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_caps_by_name ##### -->
<!-- ##### FUNCTION gst_pad_get_caps ##### -->
<para>
</para>
@pad:
@name:
@Returns:
@ -392,6 +412,15 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_add_ghost_pad ##### -->
<para>
@ -435,6 +464,7 @@ Destroy the pad.
@srcpad:
@sinkpad:
@Returns:
<!-- ##### FUNCTION gst_pad_disconnect ##### -->
@ -518,6 +548,47 @@ Call the EOS function of the pad
@elements:
<!-- ##### FUNCTION gst_pad_negotiate_proxy ##### -->
<para>
</para>
@srcpad:
@destpad:
@caps:
@counter:
@Returns:
<!-- # Unused Parameters # -->
@count:
<!-- ##### FUNCTION gst_pad_renegotiate ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_padtemplate ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_padtemplate_caps ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### MACRO GST_RPAD_LEN ##### -->
<para>
@ -564,6 +635,7 @@ Call the EOS function of the pad
@pushfunc:
@pullfunc:
@pullregionfunc:
@negotiatefunc:
@ghostpads:
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
@ -662,6 +734,14 @@ Get the EOS function of the real pad.
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
@ -766,6 +846,38 @@ Indicates when this pad will become available.
@presence:
@caps:
<!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### -->
<para>
</para>
@templ:
<!-- ##### MACRO GST_PADTEMPLATE_DIRECTION ##### -->
<para>
</para>
@templ:
<!-- ##### MACRO GST_PADTEMPLATE_NAME_TEMPLATE ##### -->
<para>
</para>
@templ:
<!-- ##### MACRO GST_PADTEMPLATE_PRESENCE ##### -->
<para>
</para>
@templ:
<!-- ##### FUNCTION gst_padtemplate_new ##### -->
<para>
@ -808,3 +920,22 @@ Indicates when this pad will become available.
@pad:
<!-- ##### FUNCTION gst_padtemplate_get_caps ##### -->
<para>
</para>
@templ:
@Returns:
<!-- ##### FUNCTION gst_padtemplate_get_caps_by_name ##### -->
<para>
</para>
@templ:
@name:
@Returns:

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

@ -170,6 +170,15 @@ by the loader at statup.
@factory:
<!-- ##### FUNCTION gst_plugin_add_autoplugger ##### -->
<para>
</para>
@plugin:
@factory:
<!-- ##### FUNCTION gst_plugin_find ##### -->
<para>
@ -205,6 +214,15 @@ by the loader at statup.
@Returns:
<!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
<para>
</para>
@plugin:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_elementfactory ##### -->
<para>
@ -222,6 +240,15 @@ by the loader at statup.
@mime:
<!-- ##### FUNCTION gst_plugin_load_autoplugfactory ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
<para>

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

@ -20,6 +20,7 @@ GstCaps
</para>
@refcount:
@properties: the properties
<!-- ##### TYPEDEF GstPropsFactoryEntry ##### -->
@ -125,6 +126,48 @@ Create a boolean property.
@Returns:
<!-- ##### FUNCTION gst_props_copy ##### -->
<para>
</para>
@props:
@Returns:
<!-- ##### FUNCTION gst_props_copy_on_write ##### -->
<para>
</para>
@props:
@Returns:
<!-- ##### FUNCTION gst_props_destroy ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_ref ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_unref ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_check_compatibility ##### -->
<para>
@ -138,6 +181,50 @@ Create a boolean property.
@props2:
<!-- ##### FUNCTION gst_props_set ##### -->
<para>
</para>
@props:
@name:
@entry:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@value:
<!-- ##### FUNCTION gst_props_get_boolean ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_fourcc_int ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_int ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_save_thyself ##### -->
<para>

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

File diff suppressed because it is too large Load diff

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

@ -24,13 +24,23 @@ The volume as a double 0.0 is silent, 1.0 is loudest.
The format ad defined in soundcard.h
</para>
<!-- ##### ARG GstSineSrc:channels ##### -->
<!-- ##### ARG GstSineSrc:samplerate ##### -->
<para>
The number of channels.
</para>
<!-- ##### ARG GstSineSrc:frequency ##### -->
<!-- ##### ARG GstSineSrc:tablesize ##### -->
<para>
The fequency.
</para>
<!-- ##### ARG GstSineSrc:freq ##### -->
<para>
The frequency.
</para>
<!-- ##### ARG GstSineSrc:buffersize ##### -->
<para>
</para>

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

@ -14,6 +14,16 @@ Some convenience functions
</para>
<!-- ##### FUNCTION gst_util_set_object_arg ##### -->
<para>
</para>
@object:
@name:
@value:
<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
<para>

89
gst/gstautoplug.c
View file

@ -94,6 +94,16 @@ _gst_autoplug_initialize (void)
_gst_autoplugfactories = NULL;
}
/**
* gst_autoplug_signal_new_object:
* @autoplug: The autoplugger to emit the signal
* @object: The object that is passed to the signal
*
* Emit a new_object signal. autopluggers are supposed to
* emit this signal whenever a new object has been added to
* the autoplugged pipeline.
*
*/
void
gst_autoplug_signal_new_object (GstAutoplug *autoplug, GstObject *object)
{
@ -101,6 +111,18 @@ gst_autoplug_signal_new_object (GstAutoplug *autoplug, GstObject *object)
}
/**
* gst_autoplug_to_caps:
* @autoplug: The autoplugger perform the autoplugging
* @srccaps: The source cpabilities
* @sinkcaps: The target capabilities
* @...: more target capabilities
*
* Perform the autoplugging procedure on the given autoplugger.
* The src caps will be connected to the sink caps.
*
* Returns: A new Element that connects the src caps to the sink caps.
*/
GstElement*
gst_autoplug_to_caps (GstAutoplug *autoplug, GstCaps *srccaps, GstCaps *sinkcaps, ...)
{
@ -119,6 +141,18 @@ gst_autoplug_to_caps (GstAutoplug *autoplug, GstCaps *srccaps, GstCaps *sinkcaps
return element;
}
/**
* gst_autoplug_to_renderers:
* @autoplug: The autoplugger perform the autoplugging
* @srccaps: The source cpabilities
* @target: The target element
* @...: more target elements
*
* Perform the autoplugging procedure on the given autoplugger.
* The src caps will be connected to the target elements.
*
* Returns: A new Element that connects the src caps to the target elements.
*/
GstElement*
gst_autoplug_to_renderers (GstAutoplug *autoplug, GstCaps *srccaps, GstElement *target, ...)
{
@ -168,27 +202,27 @@ gst_autoplugfactory_new (const gchar *name, const gchar *longdesc, GtkType type)
/**
* gst_autoplugfactory_destroy:
* @autoplug: factory to destroy
* @factory: factory to destroy
*
* Removes the autoplug from the global list.
*/
void
gst_autoplugfactory_destroy (GstAutoplugFactory *autoplug)
gst_autoplugfactory_destroy (GstAutoplugFactory *factory)
{
g_return_if_fail (autoplug != NULL);
g_return_if_fail (factory != NULL);
_gst_autoplugfactories = g_list_remove (_gst_autoplugfactories, autoplug);
_gst_autoplugfactories = g_list_remove (_gst_autoplugfactories, factory);
// we don't free the struct bacause someone might have a handle to it..
}
/**
* gst_autoplug_find:
* @name: name of autoplugger to find
* gst_autoplugfactory_find:
* @name: name of autoplugfactory to find
*
* Search for an autoplugger of the given name.
* Search for an autoplugfactory of the given name.
*
* Returns: #GstAutoplug if found, NULL otherwise
* Returns: #GstAutoplugFactory if found, NULL otherwise
*/
GstAutoplugFactory*
gst_autoplugfactory_find (const gchar *name)
@ -214,9 +248,9 @@ gst_autoplugfactory_find (const gchar *name)
/**
* gst_autoplugfactory_get_list:
*
* Get the global list of elementfactories.
* Get the global list of autoplugfactories.
*
* Returns: GList of type #GstElementFactory
* Returns: GList of type #GstAutoplugFactory
*/
GList*
gst_autoplugfactory_get_list (void)
@ -224,6 +258,15 @@ gst_autoplugfactory_get_list (void)
return _gst_autoplugfactories;
}
/**
* gst_autoplugfactory_create:
* @factory: the factory used to create the instance
*
* Create a new #GstAutoplug instance from the
* given autoplugfactory.
*
* Returns: A new #GstAutoplug instance.
*/
GstAutoplug*
gst_autoplugfactory_create (GstAutoplugFactory *factory)
{
@ -242,6 +285,15 @@ gst_autoplugfactory_create (GstAutoplugFactory *factory)
return new;
}
/**
* gst_autoplugfactory_make:
* @name: the name of the factory used to create the instance
*
* Create a new #GstAutoplug instance from the
* autoplugfactory with the given name.
*
* Returns: A new #GstAutoplug instance.
*/
GstAutoplug*
gst_autoplugfactory_make (const gchar *name)
{
@ -257,6 +309,15 @@ gst_autoplugfactory_make (const gchar *name)
return gst_autoplugfactory_create (factory);;
}
/**
* gst_autoplugfactory_save_thyself:
* @factory: The facory to save
* @parent: the parent XML node pointer
*
* Save the autoplugfactory into an XML representation
*
* Returns: The new XML parent.
*/
xmlNodePtr
gst_autoplugfactory_save_thyself (GstAutoplugFactory *factory, xmlNodePtr parent)
{
@ -268,6 +329,14 @@ gst_autoplugfactory_save_thyself (GstAutoplugFactory *factory, xmlNodePtr parent
return parent;
}
/**
* gst_autoplugfactory_load_thyself:
* @parent: the parent XML node pointer
*
* Load an autoplugfactory from the given XML parent node.
*
* Returns: A new factory based on the XML node.
*/
GstAutoplugFactory*
gst_autoplugfactory_load_thyself (xmlNodePtr parent)
{

26
gst/gstcaps.c
View file

@ -214,10 +214,12 @@ gst_caps_ref (GstCaps *caps)
}
/**
* gst_caps_copy_on_write:
* gst_caps_copy:
* @caps: the caps to copy
*
* Copies the caps if the refcount is greater than 1
* Copies the caps.
*
* Returns: a copy of the GstCaps structure.
*/
GstCaps*
gst_caps_copy (GstCaps *caps)
@ -239,6 +241,9 @@ gst_caps_copy (GstCaps *caps)
* @caps: the caps to copy
*
* Copies the caps if the refcount is greater than 1
*
* Returns: a pointer to a GstCaps strcuture that can
* be safely written to
*/
GstCaps*
gst_caps_copy_on_write (GstCaps *caps)
@ -347,7 +352,7 @@ gst_caps_get_type_id (GstCaps *caps)
/**
* gst_caps_set_type_id:
* @caps: the caps to set the type id to
* @typeid: the type id to set
* @type_id: the type id to set
*
* Set the type id of the caps.
*/
@ -446,6 +451,17 @@ gst_caps_prepend (GstCaps *caps, GstCaps *capstoadd)
return orig;
}
/**
* gst_caps_get_by_name:
* @caps: a capabilty
* @name: the name of the capability to get
*
* Get the capability with the given name from this
* chain of capabilities.
*
* Returns: the first capability in the chain with the
* given name
*/
GstCaps*
gst_caps_get_by_name (GstCaps *caps, const gchar *name)
{
@ -487,11 +503,11 @@ gst_caps_check_compatibility_func (GstCaps *fromcaps, GstCaps *tocaps)
}
/**
* gst_caps_list_check_compatibility:
* gst_caps_check_compatibility:
* @fromcaps: a capabilty
* @tocaps: a capabilty
*
* Checks whether two capability lists are compatible.
* Checks whether two capabilities are compatible.
*
* Returns: TRUE if compatible, FALSE otherwise
*/

51
gst/gstpad.c
View file

@ -411,11 +411,11 @@ gst_pad_set_eos_function (GstPad *pad,
}
/**
* gst_pad_set_eos_function:
* @pad: the pad to set the eos function for
* @eos: the eos function
* gst_pad_set_negotiate_function:
* @pad: the pad to set the negotiate function for
* @nego: the negotiate function
*
* Set the given EOS function for the pad.
* Set the given negotiate function for the pad.
*/
void
gst_pad_set_negotiate_function (GstPad *pad,
@ -607,12 +607,12 @@ gst_pad_set_parent (GstPad *pad,
}
/**
* gst_pad_get_parent:
* @pad: the pad to get the parent from
* gst_pad_get_padtemplate:
* @pad: the pad to get the padtemplate from
*
* Get the parent object of this pad.
* Get the padtemplate object of this pad.
*
* Returns: the parent object
* Returns: the padtemplate object
*/
GstPadTemplate*
gst_pad_get_padtemplate (GstPad *pad)
@ -726,9 +726,11 @@ gst_pad_get_ghost_pad_list (GstPad *pad)
/**
* gst_pad_set_caps:
* @pad: the pad to set the caps to
* @caps: a GList of the capabilities to attach to this pad
* @caps: the capabilities to attach to this pad
*
* Set the capabilities of this pad.
*
* Returns: a boolean indicating the caps could be set on the pad
*/
gboolean
gst_pad_set_caps (GstPad *pad,
@ -753,12 +755,12 @@ gst_pad_set_caps (GstPad *pad,
}
/**
* gst_pad_get_caps_list:
* gst_pad_get_caps:
* @pad: the pad to get the capabilities from
*
* Get the capabilities of this pad.
*
* Returns: a list of the capabilities of this pad
* Returns: the capabilities of this pad
*/
GstCaps*
gst_pad_get_caps (GstPad *pad)
@ -774,6 +776,14 @@ gst_pad_get_caps (GstPad *pad)
return NULL;
}
/**
* gst_pad_get_padtemplate_caps:
* @pad: the pad to get the capabilities from
*
* Get the capabilities of this pad.
*
* Returns: a list of the capabilities of this pad
*/
GstCaps*
gst_pad_get_padtemplate_caps (GstPad *pad)
{
@ -788,11 +798,11 @@ gst_pad_get_padtemplate_caps (GstPad *pad)
/**
* gst_pad_get_caps_by_name:
* @pad: the pad to get the capabilities from
* gst_padtemplate_get_caps_by_name:
* @templ: the padtemplate to get the capabilities from
* @name: the name of the capability to get
*
* Get the capabilities with the given name from this pad.
* Get the capability with the given name from this padtemplate.
*
* Returns: a capability or NULL if not found
*/
@ -1058,7 +1068,18 @@ gst_pad_renegotiate (GstPad *pad)
return result;
}
/**
* gst_pad_negotiate_proxy:
* @srcpad: the pad that proxies
* @destpad: the pad to proxy the negotiation to
* @caps: the current caps
* @counter: a counter to keep track of the negotiation process
*
* Proxies the negotiation pad from srcpad to destpad. Further
* negotiation is done on the peers of both pad instead.
*
* Returns: the result of the negotiation preocess.
*/
GstPadNegotiateReturn
gst_pad_negotiate_proxy (GstPad *srcpad, GstPad *destpad, GstCaps **caps, gint counter)
{

2
gst/gstpad.h
View file

@ -309,7 +309,7 @@ gboolean gst_pad_connect (GstPad *srcpad, GstPad *sinkpad);
void gst_pad_disconnect (GstPad *srcpad, GstPad *sinkpad);
gboolean gst_pad_renegotiate (GstPad *pad);
GstPadNegotiateReturn gst_pad_negotiate_proxy (GstPad *srcpad, GstPad *destpad, GstCaps **caps, gint count);
GstPadNegotiateReturn gst_pad_negotiate_proxy (GstPad *srcpad, GstPad *destpad, GstCaps **caps, gint counter);
#if 1
void gst_pad_push (GstPad *pad, GstBuffer *buf);

8
gst/gstplugin.c
View file

@ -776,11 +776,11 @@ gst_plugin_add_type (GstPlugin *plugin, GstTypeFactory *factory)
}
/**
* gst_plugin_add_type:
* @plugin: plugin to add type to
* @factory: the typefactory to add
* gst_plugin_add_autoplugger:
* @plugin: plugin to add the autoplugger to
* @factory: the autoplugfactory to add
*
* Add a typefactory to the list of those provided by the plugin.
* Add an autoplugfactory to the list of those provided by the plugin.
*/
void
gst_plugin_add_autoplugger (GstPlugin *plugin, GstAutoplugFactory *factory)

77
gst/gstprops.c
View file

@ -239,7 +239,7 @@ end:
*
* Returns: the new property created from the list of entries
*/
GstProps *
GstProps*
gst_props_new (GstPropsFactoryEntry entry, ...)
{
va_list var_args;
@ -307,6 +307,17 @@ gst_props_new (GstPropsFactoryEntry entry, ...)
return props;
}
/**
* gst_props_set:
* @props: the props to modify
* @name: the name of the entry to modify
* @entry: The new value of the property entry
* @...: More property entries.
*
* Modifies the value of the given entry in the props struct.
*
* Returns: the new modified property structure.
*/
GstProps*
gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry entry, ...)
{
@ -356,6 +367,13 @@ gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry entry, .
return props;
}
/**
* gst_props_unref:
* @props: the props to unref
*
* Decrease the refcount of the property structure, destroying
* the property if the refcount is 0.
*/
void
gst_props_unref (GstProps *props)
{
@ -367,6 +385,12 @@ gst_props_unref (GstProps *props)
gst_props_destroy (props);
}
/**
* gst_props_ref:
* @props: the props to ref
*
* Increase the refcount of the property structure.
*/
void
gst_props_ref (GstProps *props)
{
@ -375,6 +399,13 @@ gst_props_ref (GstProps *props)
props->refcount++;
}
/**
* gst_props_destroy:
* @props: the props to destroy
*
* Destroy the property, freeing all the memory that
* was allocated.
*/
void
gst_props_destroy (GstProps *props)
{
@ -398,6 +429,15 @@ gst_props_destroy (GstProps *props)
g_list_free (props->properties);
}
/**
* gst_props_copy:
* @props: the props to copy
*
* Copy the property structure.
*
* Returns: the new property that is a copy of the original
* one.
*/
GstProps*
gst_props_copy (GstProps *props)
{
@ -434,6 +474,14 @@ gst_props_copy (GstProps *props)
return new;
}
/**
* gst_props_copy_on_write:
* @props: the props to copy on write
*
* Copy the property structure if the refcount is >1.
*
* Returns: A new props that can be safely written to.
*/
GstProps*
gst_props_copy_on_write (GstProps *props)
{
@ -449,6 +497,15 @@ gst_props_copy_on_write (GstProps *props)
return props;
}
/**
* gst_props_get_int:
* @props: the props to get the int value from
* @name: the name of the props entry to get.
*
* Get the named entry as an integer.
*
* Returns: the integer value of the named entry, 0 if not found.
*/
gint
gst_props_get_int (GstProps *props, const gchar *name)
{
@ -470,6 +527,15 @@ gst_props_get_int (GstProps *props, const gchar *name)
return 0;
}
/**
* gst_props_get_fourcc_int:
* @props: the props to get the fourcc value from
* @name: the name of the props entry to get.
*
* Get the named entry as a gulong fourcc.
*
* Returns: the fourcc value of the named entry, 0 if not found.
*/
gulong
gst_props_get_fourcc_int (GstProps *props, const gchar *name)
{
@ -491,6 +557,15 @@ gst_props_get_fourcc_int (GstProps *props, const gchar *name)
return 0;
}
/**
* gst_props_get_boolean:
* @props: the props to get the fourcc value from
* @name: the name of the props entry to get.
*
* Get the named entry as a boolean value.
*
* Returns: the boolean value of the named entry, 0 if not found.
*/
gboolean
gst_props_get_boolean (GstProps *props, const gchar *name)
{

2
gst/gstprops.h
View file

@ -91,7 +91,7 @@ GstProps* gst_props_merge (GstProps *props, GstProps *tomerge);
gboolean gst_props_check_compatibility (GstProps *fromprops, GstProps *toprops);
GstProps* gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry value, ...);
GstProps* gst_props_set (GstProps *props, const gchar *name, GstPropsFactoryEntry entry, ...);
gint gst_props_get_int (GstProps *props, const gchar *name);
gulong gst_props_get_fourcc_int (GstProps *props, const gchar *name);

50
gst/gstutils.c
View file

@ -35,7 +35,9 @@
*
* Returns: the property of the object
*/
gint gst_util_get_int_arg(GtkObject *object,guchar *argname) {
gint
gst_util_get_int_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
@ -52,7 +54,9 @@ gint gst_util_get_int_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
gint gst_util_get_bool_arg(GtkObject *object,guchar *argname) {
gint
gst_util_get_bool_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
@ -69,7 +73,9 @@ gint gst_util_get_bool_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
glong gst_util_get_long_arg(GtkObject *object,guchar *argname) {
glong
gst_util_get_long_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
@ -86,7 +92,9 @@ glong gst_util_get_long_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) {
gfloat
gst_util_get_float_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
@ -103,7 +111,9 @@ gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) {
gdouble
gst_util_get_double_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
@ -120,7 +130,9 @@ gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) {
guchar*
gst_util_get_string_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
@ -137,11 +149,14 @@ guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) {
gpointer
gst_util_get_pointer_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
gtk_object_getv(GTK_OBJECT(object),1,&arg);
return GTK_VALUE_POINTER(arg);
}
@ -154,11 +169,14 @@ gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) {
*
* Returns: the property of the object
*/
GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) {
GtkWidget*
gst_util_get_widget_arg (GtkObject *object,guchar *argname)
{
GtkArg arg;
arg.name = argname;
gtk_object_getv(GTK_OBJECT(object),1,&arg);
return GTK_WIDGET(GTK_VALUE_OBJECT(arg));
}
@ -169,7 +187,9 @@ GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) {
*
* Dumps the memory block into a hex representation. Useful for debugging.
*/
void gst_util_dump_mem(guchar *mem, guint size) {
void
gst_util_dump_mem (guchar *mem, guint size)
{
guint i, j;
i = j =0;
@ -187,7 +207,17 @@ void gst_util_dump_mem(guchar *mem, guint size) {
g_print("\n");
}
void gst_util_set_object_arg (GtkObject *object, guchar *name, gchar *value)
/**
* gst_util_set_object_arg:
* @object: the object to set the argument of
* @name: the name of the argument to set
* @value: the string value to set
*
* Convertes the string value to the type of the objects argument and
* sets the argument with it.
*/
void
gst_util_set_object_arg (GtkObject *object, guchar *name, gchar *value)
{
if (name && value) {
GtkType type = GTK_OBJECT_TYPE (object);