mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 12:11:13 +00:00
1211e26e59
Original commit message from CVS: docs fixes: comment macros in templates, not in headers (stupid gtk-doc)
682 lines
8.7 KiB
Text
682 lines
8.7 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstProps
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Properties
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
GstProps is used to attach certain properties to a pad. Properties
|
|
are usually used in conjunction with GstCaps.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
#GstCaps
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GstProps ##### -->
|
|
<para>
|
|
The props structure
|
|
</para>
|
|
|
|
@refcount: a refcount for this struct
|
|
@flags:
|
|
@properties: the properties
|
|
|
|
<!-- ##### ENUM GstPropsType ##### -->
|
|
<para>
|
|
The property type
|
|
</para>
|
|
|
|
@GST_PROPS_END_TYPE:
|
|
@GST_PROPS_INVALID_TYPE:
|
|
@GST_PROPS_INT_TYPE:
|
|
@GST_PROPS_FLOAT_TYPE:
|
|
@GST_PROPS_FOURCC_TYPE:
|
|
@GST_PROPS_BOOLEAN_TYPE:
|
|
@GST_PROPS_STRING_TYPE:
|
|
@GST_PROPS_VAR_TYPE:
|
|
@GST_PROPS_LIST_TYPE:
|
|
@GST_PROPS_GLIST_TYPE:
|
|
@GST_PROPS_FLOAT_RANGE_TYPE:
|
|
@GST_PROPS_INT_RANGE_TYPE:
|
|
@GST_PROPS_LAST_TYPE:
|
|
|
|
<!-- ##### ENUM GstPropsFlags ##### -->
|
|
<para>
|
|
Flags for this property
|
|
</para>
|
|
|
|
@GST_PROPS_FIXED: The property has no variable entries
|
|
@GST_PROPS_FLOATING: The property is not owned by anyone
|
|
|
|
<!-- ##### MACRO GST_PROPS_TRACE_NAME ##### -->
|
|
<para>
|
|
The name used for tracing memory allocations for the properties
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FLAGS ##### -->
|
|
<para>
|
|
The flags of this property
|
|
</para>
|
|
|
|
@props: The props to query
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FLAG_IS_SET ##### -->
|
|
<para>
|
|
Check if a flag is set on the property
|
|
</para>
|
|
|
|
@props: The property to check
|
|
@flag: The flag to check for
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FLAG_SET ##### -->
|
|
<para>
|
|
Set a flag on the property
|
|
</para>
|
|
|
|
@props: The property to modify
|
|
@flag: The flag to set
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FLAG_UNSET ##### -->
|
|
<para>
|
|
Unset a flag in the property
|
|
</para>
|
|
|
|
@props: The property to modify
|
|
@flag: The flag to unset
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_IS_FIXED ##### -->
|
|
<para>
|
|
Check if the property is fixed, ie. it has no variable property entries.
|
|
</para>
|
|
|
|
@props: The property to check
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_IS_FLOATING ##### -->
|
|
<para>
|
|
Check if the property is floating
|
|
</para>
|
|
|
|
@props: The property to check
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_PROPERTIES ##### -->
|
|
<para>
|
|
Get the property entries of this property
|
|
</para>
|
|
|
|
@props: The property to query
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_REFCOUNT ##### -->
|
|
<para>
|
|
Get the refcount of the property
|
|
</para>
|
|
|
|
@props: The property to query
|
|
|
|
|
|
<!-- ##### MACRO GST_TYPE_PROPS ##### -->
|
|
<para>
|
|
The GType of the props boxed type, for use in GValues.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
|
|
<para>
|
|
Create a FOURCC value that can easily be used to construct
|
|
a fourcc property.
|
|
<programlisting>
|
|
...
|
|
"format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('Y','U','Y','2')),
|
|
...
|
|
</programlisting>
|
|
</para>
|
|
|
|
@a: first fourcc byte
|
|
@b: second fourcc byte
|
|
@c: third fourcc byte
|
|
@d: fourth fourcc byte
|
|
|
|
|
|
<!-- ##### MACRO GST_STR_FOURCC ##### -->
|
|
<para>
|
|
Create a FOURCC value from a string. example:
|
|
<programlisting>
|
|
...
|
|
"format", GST_PROPS_FOURCC (GST_STR_FOURCC ("YUY2")),
|
|
...
|
|
</programlisting>
|
|
</para>
|
|
|
|
@f: the string describing the fourcc value.
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_LIST ##### -->
|
|
<para>
|
|
Create a list of properties.
|
|
</para>
|
|
|
|
@...: the list of GstProps
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_GLIST ##### -->
|
|
<para>
|
|
Create a list from a GList of #GstPropsEntry.
|
|
</para>
|
|
|
|
@a: A GList of props entries
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_INT ##### -->
|
|
<para>
|
|
Create an integer property.
|
|
</para>
|
|
|
|
@a: the integer property
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_INT_ANY ##### -->
|
|
<para>
|
|
Create an integer property that can hold any int.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_INT_RANGE ##### -->
|
|
<para>
|
|
Create an integer range property.
|
|
</para>
|
|
|
|
@a: the min value for the range
|
|
@b: the max value for the range
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_INT_NEGATIVE ##### -->
|
|
<para>
|
|
Create an integer property that can hold negative ints.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FOURCC ##### -->
|
|
<para>
|
|
Construct a fourcc property out of four bytes.
|
|
</para>
|
|
|
|
@a: a fourcc value usualy created with GST_FOURCC_MAKE ()
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_BOOLEAN ##### -->
|
|
<para>
|
|
Create a boolean property.
|
|
</para>
|
|
|
|
@a: the boolean property
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_STRING ##### -->
|
|
<para>
|
|
Create a string value.
|
|
</para>
|
|
|
|
@a: the string value.
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FLOAT ##### -->
|
|
<para>
|
|
Create a floating point value.
|
|
</para>
|
|
|
|
@a: the float value
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_FLOAT_RANGE ##### -->
|
|
<para>
|
|
Create a float range value.
|
|
</para>
|
|
|
|
@a: lower float bounds
|
|
@b: upper float bounds
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_INT_POSITIVE ##### -->
|
|
<para>
|
|
Create an integer property that can hold positive ints.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GstPropsEntry ##### -->
|
|
<para>
|
|
An entry hols one key/value pair.
|
|
</para>
|
|
|
|
|
|
<!-- ##### MACRO GST_PROPS_ENTRY_TRACE_NAME ##### -->
|
|
<para>
|
|
The name used for tracing memory allocations.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@firstname:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_newv ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@firstname:
|
|
@var_args:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_empty_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_merge ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@tomerge:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_copy_on_write ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_ref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_unref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_replace ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@oldprops:
|
|
@newprops:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_replace_sink ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@oldprops:
|
|
@newprops:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_sink ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_check_compatibility ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@fromprops:
|
|
@toprops:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_has_property ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_normalize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@name:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_get ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@first_name:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_get_safe ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@first_name:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_has_fixed_property ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_has_property_typed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@name:
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_intersect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props1:
|
|
@props2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_debug ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_save_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@parent:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_load_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_get_entry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_add_entry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@entry:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_remove_entry ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@entry:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_remove_entry_by_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@props:
|
|
@name:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_destroy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_boolean ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@val:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_float ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@val:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_float_range ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@min:
|
|
@max:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_fourcc_int ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@val:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_int ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@val:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_int_range ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@min:
|
|
@max:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@val:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_string ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@val:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_get_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_props_entry_is_fixed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@Returns:
|
|
|
|
|