gstreamer/docs/gst/tmpl/gststructure.sgml

447 lines
5.2 KiB
Text
Raw Normal View History

<!-- ##### SECTION Title ##### -->
GstStructure
<!-- ##### SECTION Short_Description ##### -->
docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo... Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do major hacking of it. This checkin replaces any fine tuning that may have been done previously, with the benefit of actually being complete for much of the API that was changed since 0.6. Further fine tuning will occur shortly. (bug #134721) * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/GstBin.sgml: * docs/gst/tmpl/GstBuffer.sgml: * docs/gst/tmpl/GstCaps.sgml: * docs/gst/tmpl/GstClock.sgml: * docs/gst/tmpl/GstCompat.sgml: * docs/gst/tmpl/GstData.sgml: * docs/gst/tmpl/GstElement.sgml: * docs/gst/tmpl/GstEvent.sgml: * docs/gst/tmpl/GstIndex.sgml: * docs/gst/tmpl/GstStructure.sgml: * docs/gst/tmpl/GstTag.sgml: * docs/gst/tmpl/cothreads.sgml: * docs/gst/tmpl/cothreads_compat.sgml: * docs/gst/tmpl/gettext.sgml: * docs/gst/tmpl/grammar.tab.sgml: * docs/gst/tmpl/gst-i18n-app.sgml: * docs/gst/tmpl/gst-i18n-lib.sgml: * docs/gst/tmpl/gst.sgml: * docs/gst/tmpl/gst_private.sgml: * docs/gst/tmpl/gstaggregator.sgml: * docs/gst/tmpl/gstarch.sgml: * docs/gst/tmpl/gstatomic.sgml: * docs/gst/tmpl/gstatomic_impl.sgml: * docs/gst/tmpl/gstbin.sgml: * docs/gst/tmpl/gstbuffer.sgml: * docs/gst/tmpl/gstbufferstore.sgml: * docs/gst/tmpl/gstcaps.sgml: * docs/gst/tmpl/gstclock.sgml: * docs/gst/tmpl/gstcompat.sgml: * docs/gst/tmpl/gstconfig.sgml: * docs/gst/tmpl/gstcpu.sgml: * docs/gst/tmpl/gstdata.sgml: * docs/gst/tmpl/gstdata_private.sgml: * docs/gst/tmpl/gstelement.sgml: * docs/gst/tmpl/gstenumtypes.sgml: * docs/gst/tmpl/gsterror.sgml: * docs/gst/tmpl/gstevent.sgml: * docs/gst/tmpl/gstfakesink.sgml: * docs/gst/tmpl/gstfakesrc.sgml: * docs/gst/tmpl/gstfilesink.sgml: * docs/gst/tmpl/gstfilter.sgml: * docs/gst/tmpl/gstindex.sgml: * docs/gst/tmpl/gstinfo.sgml: * docs/gst/tmpl/gstinterface.sgml: * docs/gst/tmpl/gstlog.sgml: * docs/gst/tmpl/gstmacros.sgml: * docs/gst/tmpl/gstmarshal.sgml: * docs/gst/tmpl/gstmd5sink.sgml: * docs/gst/tmpl/gstmultifilesrc.sgml: * docs/gst/tmpl/gstobject.sgml: * docs/gst/tmpl/gstpad.sgml: * docs/gst/tmpl/gstparse.sgml: * docs/gst/tmpl/gstpipeline.sgml: * docs/gst/tmpl/gstplugin.sgml: * docs/gst/tmpl/gstpluginfeature.sgml: * docs/gst/tmpl/gstqueue.sgml: * docs/gst/tmpl/gstreamer-unused.sgml: * docs/gst/tmpl/gstregistry.sgml: * docs/gst/tmpl/gstregistrypool.sgml: * docs/gst/tmpl/gstscheduler.sgml: * docs/gst/tmpl/gstsearchfuncs.sgml: * docs/gst/tmpl/gstshaper.sgml: * docs/gst/tmpl/gstspider.sgml: * docs/gst/tmpl/gstspideridentity.sgml: * docs/gst/tmpl/gststructure.sgml: * docs/gst/tmpl/gstsystemclock.sgml: * docs/gst/tmpl/gsttag.sgml: * docs/gst/tmpl/gsttaginterface.sgml: * docs/gst/tmpl/gsttee.sgml: * docs/gst/tmpl/gstthread.sgml: * docs/gst/tmpl/gsttrace.sgml: * docs/gst/tmpl/gsttrashstack.sgml: * docs/gst/tmpl/gsttypefind.sgml: * docs/gst/tmpl/gsttypes.sgml: * docs/gst/tmpl/gsturi.sgml: * docs/gst/tmpl/gsturitype.sgml: * docs/gst/tmpl/gstutils.sgml: * docs/gst/tmpl/gstvalue.sgml: * docs/gst/tmpl/gstversion.sgml: * docs/gst/tmpl/gstxml.sgml: * docs/gst/tmpl/gstxmlregistry.sgml: * docs/gst/tmpl/gthread-cothreads.sgml: * docs/gst/tmpl/types.sgml:
2004-03-25 04:20:33 +00:00
Generic structure containing fields of names and values
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo... Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do major hacking of it. This checkin replaces any fine tuning that may have been done previously, with the benefit of actually being complete for much of the API that was changed since 0.6. Further fine tuning will occur shortly. (bug #134721) * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/GstBin.sgml: * docs/gst/tmpl/GstBuffer.sgml: * docs/gst/tmpl/GstCaps.sgml: * docs/gst/tmpl/GstClock.sgml: * docs/gst/tmpl/GstCompat.sgml: * docs/gst/tmpl/GstData.sgml: * docs/gst/tmpl/GstElement.sgml: * docs/gst/tmpl/GstEvent.sgml: * docs/gst/tmpl/GstIndex.sgml: * docs/gst/tmpl/GstStructure.sgml: * docs/gst/tmpl/GstTag.sgml: * docs/gst/tmpl/cothreads.sgml: * docs/gst/tmpl/cothreads_compat.sgml: * docs/gst/tmpl/gettext.sgml: * docs/gst/tmpl/grammar.tab.sgml: * docs/gst/tmpl/gst-i18n-app.sgml: * docs/gst/tmpl/gst-i18n-lib.sgml: * docs/gst/tmpl/gst.sgml: * docs/gst/tmpl/gst_private.sgml: * docs/gst/tmpl/gstaggregator.sgml: * docs/gst/tmpl/gstarch.sgml: * docs/gst/tmpl/gstatomic.sgml: * docs/gst/tmpl/gstatomic_impl.sgml: * docs/gst/tmpl/gstbin.sgml: * docs/gst/tmpl/gstbuffer.sgml: * docs/gst/tmpl/gstbufferstore.sgml: * docs/gst/tmpl/gstcaps.sgml: * docs/gst/tmpl/gstclock.sgml: * docs/gst/tmpl/gstcompat.sgml: * docs/gst/tmpl/gstconfig.sgml: * docs/gst/tmpl/gstcpu.sgml: * docs/gst/tmpl/gstdata.sgml: * docs/gst/tmpl/gstdata_private.sgml: * docs/gst/tmpl/gstelement.sgml: * docs/gst/tmpl/gstenumtypes.sgml: * docs/gst/tmpl/gsterror.sgml: * docs/gst/tmpl/gstevent.sgml: * docs/gst/tmpl/gstfakesink.sgml: * docs/gst/tmpl/gstfakesrc.sgml: * docs/gst/tmpl/gstfilesink.sgml: * docs/gst/tmpl/gstfilter.sgml: * docs/gst/tmpl/gstindex.sgml: * docs/gst/tmpl/gstinfo.sgml: * docs/gst/tmpl/gstinterface.sgml: * docs/gst/tmpl/gstlog.sgml: * docs/gst/tmpl/gstmacros.sgml: * docs/gst/tmpl/gstmarshal.sgml: * docs/gst/tmpl/gstmd5sink.sgml: * docs/gst/tmpl/gstmultifilesrc.sgml: * docs/gst/tmpl/gstobject.sgml: * docs/gst/tmpl/gstpad.sgml: * docs/gst/tmpl/gstparse.sgml: * docs/gst/tmpl/gstpipeline.sgml: * docs/gst/tmpl/gstplugin.sgml: * docs/gst/tmpl/gstpluginfeature.sgml: * docs/gst/tmpl/gstqueue.sgml: * docs/gst/tmpl/gstreamer-unused.sgml: * docs/gst/tmpl/gstregistry.sgml: * docs/gst/tmpl/gstregistrypool.sgml: * docs/gst/tmpl/gstscheduler.sgml: * docs/gst/tmpl/gstsearchfuncs.sgml: * docs/gst/tmpl/gstshaper.sgml: * docs/gst/tmpl/gstspider.sgml: * docs/gst/tmpl/gstspideridentity.sgml: * docs/gst/tmpl/gststructure.sgml: * docs/gst/tmpl/gstsystemclock.sgml: * docs/gst/tmpl/gsttag.sgml: * docs/gst/tmpl/gsttaginterface.sgml: * docs/gst/tmpl/gsttee.sgml: * docs/gst/tmpl/gstthread.sgml: * docs/gst/tmpl/gsttrace.sgml: * docs/gst/tmpl/gsttrashstack.sgml: * docs/gst/tmpl/gsttypefind.sgml: * docs/gst/tmpl/gsttypes.sgml: * docs/gst/tmpl/gsturi.sgml: * docs/gst/tmpl/gsturitype.sgml: * docs/gst/tmpl/gstutils.sgml: * docs/gst/tmpl/gstvalue.sgml: * docs/gst/tmpl/gstversion.sgml: * docs/gst/tmpl/gstxml.sgml: * docs/gst/tmpl/gstxmlregistry.sgml: * docs/gst/tmpl/gthread-cothreads.sgml: * docs/gst/tmpl/types.sgml:
2004-03-25 04:20:33 +00:00
<!-- ##### STRUCT GstStructure ##### -->
<para>
</para>
@type:
<!-- ##### USER_FUNCTION GstStructureForeachFunc ##### -->
<para>
</para>
@field_id:
@value:
@user_data:
@Returns:
<!-- ##### USER_FUNCTION GstStructureMapFunc ##### -->
<para>
</para>
@field_id:
@value:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_structure_empty_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_structure_id_empty_new ##### -->
<para>
</para>
@quark:
@Returns:
<!-- ##### FUNCTION gst_structure_new ##### -->
<para>
</para>
@name:
@firstfield:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_structure_new_valist ##### -->
<para>
</para>
@name:
@firstfield:
@varargs:
@Returns:
<!-- ##### FUNCTION gst_structure_copy ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_free ##### -->
<para>
</para>
@structure:
<!-- ##### FUNCTION gst_structure_get_name ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_has_name ##### -->
<para>
</para>
@structure:
@name:
@Returns:
<!-- ##### FUNCTION gst_structure_set_name ##### -->
<para>
</para>
@structure:
@name:
<!-- ##### FUNCTION gst_structure_get_name_id ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_id_get_value ##### -->
<para>
</para>
@structure:
@field:
@Returns:
<!-- ##### FUNCTION gst_structure_id_set_value ##### -->
<para>
</para>
@structure:
@field:
@value:
<!-- ##### FUNCTION gst_structure_get_value ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_set_value ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_set ##### -->
<para>
</para>
@structure:
@fieldname:
@Varargs:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_set_valist ##### -->
<para>
</para>
@structure:
@fieldname:
@varargs:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_remove_field ##### -->
<para>
</para>
@structure:
@fieldname:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_remove_fields ##### -->
<para>
</para>
@structure:
@fieldname:
@Varargs:
<!-- # Unused Parameters # -->
@fieldnamename:
<!-- ##### FUNCTION gst_structure_remove_fields_valist ##### -->
<para>
</para>
@structure:
@fieldname:
@varargs:
<!-- # Unused Parameters # -->
@fieldnamename:
<!-- ##### FUNCTION gst_structure_remove_all_fields ##### -->
<para>
</para>
@structure:
<!-- ##### FUNCTION gst_structure_get_field_type ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_foreach ##### -->
<para>
</para>
@structure:
@func:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_structure_n_fields ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_has_field ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_has_field_typed ##### -->
<para>
</para>
@structure:
@fieldname:
@type:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_boolean ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_int ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_fourcc ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_double ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@fieldnamename:
@field:
<!-- ##### FUNCTION gst_structure_get_string ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_map_in_place ##### -->
<para>
</para>
@structure:
@func:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_structure_nth_field_name ##### -->
<para>
</para>
@structure:
@index:
@Returns:
<!-- ##### FUNCTION gst_structure_set_parent_refcount ##### -->
<para>
</para>
@structure:
@refcount:
<!-- ##### FUNCTION gst_structure_to_string ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_from_string ##### -->
<para>
</para>
@string:
@end:
@Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns: