gstreamer/docs/gst/tmpl/gstprops.sgml
Wim Taymans 17f02e233d API docs updates
Original commit message from CVS:
API docs updates
2001-05-03 20:06:18 +00:00

290 lines
3.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>
</para>
@refcount:
@lock:
@properties: the properties
<!-- ##### 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>
@a...: the list of GstProps
<!-- ##### MACRO GST_PROPS_INT ##### -->
<para>
Create an integer property.
</para>
@a: the integer property
<!-- ##### 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_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
<!-- ##### FUNCTION gst_props_new ##### -->
<para>
</para>
@firstname:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_props_newv ##### -->
<para>
</para>
@firstname:
@var_args:
@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_destroy ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_ref ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_unref ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_check_compatibility ##### -->
<para>
</para>
@fromprops:
@toprops:
@Returns:
<!-- # Unused Parameters # -->
@props1:
@props2:
<!-- ##### FUNCTION gst_props_set ##### -->
<para>
</para>
@props:
@name:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@entry:
@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_get_string ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_float ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_save_thyself ##### -->
<para>
</para>
@props:
@parent:
@Returns:
<!-- ##### FUNCTION gst_props_load_thyself ##### -->
<para>
</para>
@parent:
@Returns: