gstformat.sgml 1.62 KB
Newer Older
Wim Taymans's avatar
Wim Taymans committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- ##### SECTION Title ##### -->
GstFormat

<!-- ##### SECTION Short_Description ##### -->
Dynamically register new formats

<!-- ##### SECTION Long_Description ##### -->
<para>
GstFormats functions are used to register a new format to the gstreamer core.
formats can be used to perform seeking or conversions/query operations.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
Wim Taymans's avatar
Wim Taymans committed
15
#GstPad, #GstElement
Wim Taymans's avatar
Wim Taymans committed
16 17
</para>

Wim Taymans's avatar
Wim Taymans committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
<!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
<para>
The PERCENT format is between 0 and this value
</para>



<!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### -->
<para>
The value used to scale down the reported PERCENT format value to
its real value.
</para>



Wim Taymans's avatar
Wim Taymans committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
<!-- ##### STRUCT GstFormatDefinition ##### -->
<para>
A format definition
</para>

@value: The unique id of this format
@nick: A short nick of the format
@description: A longer description of the format

<!-- ##### MACRO GST_FORMATS_FUNCTION ##### -->
<para>
A convenience function to define a function that returns an array
of formats.
</para>

Wim Taymans's avatar
Wim Taymans committed
48
@type: The type of the first argument of the function
Wim Taymans's avatar
Wim Taymans committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
@functionname: The name of the function
@...: comma separated list of functions closed with 0


<!-- ##### FUNCTION gst_format_register ##### -->
<para>

</para>

@nick: 
@description: 
@Returns: 


<!-- ##### FUNCTION gst_format_get_by_nick ##### -->
<para>

</para>

@nick: 
@Returns: 


Wim Taymans's avatar
Wim Taymans committed
72 73 74 75 76 77 78 79 80 81
<!-- ##### FUNCTION gst_formats_contains ##### -->
<para>

</para>

@formats: 
@format: 
@Returns: 


Wim Taymans's avatar
Wim Taymans committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
<!-- ##### FUNCTION gst_format_get_details ##### -->
<para>

</para>

@format: 
@Returns: 


<!-- ##### FUNCTION gst_format_get_definitions ##### -->
<para>

</para>

@Returns: