2004-01-30 19:06:13 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GstStructure
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2004-03-25 04:20:33 +00:00
|
|
|
Generic structure containing fields of names and values
|
2004-01-30 19:06:13 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2005-08-05 10:02:44 +00:00
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### STRUCT GstStructure ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@type:
|
|
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstStructureForeachFunc ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@field_id:
|
|
|
|
@value:
|
|
|
|
@user_data:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2005-08-26 11:56:11 +00:00
|
|
|
<!-- ##### USER_FUNCTION GstStructureMapFunc ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@field_id:
|
|
|
|
@value:
|
|
|
|
@user_data:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
|
|
|
2005-08-01 16:17:31 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_has_name ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@name:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_set_name ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@name:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_get_name_id ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_structure_id_get_value ##### -->
|
2004-01-30 19:06:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@field:
|
2004-04-22 16:39:23 +00:00
|
|
|
@Returns:
|
2004-01-30 19:06:13 +00:00
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_id_set_value ##### -->
|
2004-01-30 19:06:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@field:
|
2004-04-22 16:39:23 +00:00
|
|
|
@value:
|
2004-01-30 19:06:13 +00:00
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_get_value ##### -->
|
2004-01-30 19:06:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@fieldname:
|
2004-04-22 16:39:23 +00:00
|
|
|
@Returns:
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@field:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_set_value ##### -->
|
2004-01-30 19:06:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@fieldname:
|
2004-04-22 16:39:23 +00:00
|
|
|
@value:
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@field:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_set ##### -->
|
2004-01-30 19:06:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
2004-04-22 16:39:23 +00:00
|
|
|
@fieldname:
|
|
|
|
@Varargs:
|
|
|
|
<!-- # Unused Parameters # -->
|
2004-01-30 19:06:13 +00:00
|
|
|
@field:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_set_valist ##### -->
|
2004-01-30 19:06:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@fieldname:
|
2004-04-22 16:39:23 +00:00
|
|
|
@varargs:
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- # 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:
|
|
|
|
|
|
|
|
|
2005-08-26 11:56:11 +00:00
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
|
|
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- ##### FUNCTION gst_structure_to_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_structure_from_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@string:
|
|
|
|
@end:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2005-06-19 10:54:12 +00:00
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
|
|
|