removed gstenumtypes section from docs and put all the enums into their sections
authorStefan Kost <ensonic@users.sourceforge.net>
Thu, 30 Dec 2004 11:45:12 +0000 (11:45 +0000)
committerStefan Kost <ensonic@users.sourceforge.net>
Thu, 30 Dec 2004 11:45:12 +0000 (11:45 +0000)
Original commit message from CVS:
removed gstenumtypes section from docs and put all the enums into their sections

ChangeLog
docs/gst/gstreamer-docs.sgml
docs/gst/gstreamer-sections.txt
docs/gst/tmpl/gstenumtypes.sgml
docs/gst/tmpl/gsterror.sgml
docs/gst/tmpl/gstevent.sgml
docs/gst/tmpl/gstpad.sgml
docs/gst/tmpl/gstpadtemplate.sgml
docs/gst/tmpl/gstthread.sgml

index f6093cc..fbd737c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2004-12-30  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/gst/gstreamer-docs.sgml:
+       * docs/gst/gstreamer-sections.txt:
+       * docs/gst/tmpl/gstenumtypes.sgml:
+       * docs/gst/tmpl/gsterror.sgml:
+       * docs/gst/tmpl/gstevent.sgml:
+       * docs/gst/tmpl/gstpad.sgml:
+       * docs/gst/tmpl/gstpadtemplate.sgml:
+       * docs/gst/tmpl/gstthread.sgml:
+      removed gstenumtypes section from docs and put all the enums into their sections
+
 2004-12-27  Stephane Loeuillet  <stephane.loeuillet@tiscali.fr>
 
        * gst/gstplugin.c:
index 9e30603..7410e50 100644 (file)
@@ -16,7 +16,6 @@
 <!ENTITY GstElement SYSTEM "xml/gstelement.xml">
 <!ENTITY GstElementDetails SYSTEM "xml/gstelementdetails.xml">
 <!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
-<!ENTITY GstEnumTypes SYSTEM "xml/gstenumtypes.xml">
 <!ENTITY GstError SYSTEM "xml/gsterror.xml">
 <!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
 <!ENTITY GstFilter SYSTEM "xml/gstfilter.xml">
     &GstElement;
     &GstElementDetails;
     &GstElementFactory;
-    &GstEnumTypes;
     &GstError;
     &GstEvent;
     &GstFilter;
index b2ad2e8..c05cf9c 100644 (file)
@@ -65,8 +65,10 @@ GST_TYPE_BIN
 GST_BIN_CLASS
 GST_IS_BIN_CLASS
 GST_BIN_GET_CLASS
+GST_TYPE_BIN_FLAGS
 <SUBSECTION Private>
 gst_bin_get_type
+gst_bin_flags_get_type
 </SECTION>
 
 <SECTION>
@@ -126,8 +128,10 @@ GST_BUFFER_MAXSIZE_IS_VALID
 GST_BUFFER
 GST_IS_BUFFER
 GST_TYPE_BUFFER
+GST_TYPE_BUFFER_FLAG
 <SUBSECTION Private>
 gst_buffer_get_type
+gst_buffer_flag_get_type
 </SECTION>
 
 <SECTION>
@@ -247,8 +251,16 @@ GST_TYPE_CLOCK
 GST_CLOCK_CLASS
 GST_IS_CLOCK_CLASS
 GST_CLOCK_GET_CLASS
+GST_TYPE_CLOCK_ENTRY_STATUS
+GST_TYPE_CLOCK_ENTRY_TYPE
+GST_TYPE_CLOCK_FLAGS
+GST_TYPE_CLOCK_RETURN
 <SUBSECTION Private>
 gst_clock_get_type
+gst_clock_entry_status_get_type
+gst_clock_entry_type_get_type
+gst_clock_flags_get_type
+gst_clock_return_get_type
 </SECTION>
 
 <SECTION>
@@ -302,6 +314,10 @@ GST_PLUGIN_EXPORT
 <TITLE>GstCPU</TITLE>
 GstCPUFlags
 gst_cpu_get_flags
+<SUBSECTION Standard>
+GST_TYPE_CPU_FLAGS
+<SUBSECTION Private>
+gst_cpu_flags_get_type
 </SECTION>
 
 <SECTION>
@@ -333,8 +349,10 @@ gst_data_unref
 GST_TYPE_DATA
 GST_DATA_FLAG_SET
 GST_DATA_FLAG_IS_SET
+GST_TYPE_DATA_FLAGS
 <SUBSECTION Private>
 gst_data_get_type
+gst_data_flags_get_type
 </SECTION>
 
 <SECTION>
@@ -457,8 +475,10 @@ GST_ELEMENT_CLASS
 GST_IS_ELEMENT_CLASS
 GST_ELEMENT_GET_CLASS
 GST_TYPE_ELEMENT
+GST_TYPE_ELEMENT_FLAGS
 <SUBSECTION Private>
 gst_element_get_type
+gst_element_flags_get_type
 </SECTION>
 
 <SECTION>
@@ -501,120 +521,15 @@ gst_element_factory_get_type
 </SECTION>
 
 <SECTION>
-<FILE>gstenumtypes</FILE>
-<TITLE>GstEnumTypes</TITLE>
-<SUBSECTION Standard>
-GST_TYPE_ALLOC_TRACE_FLAGS
-GST_TYPE_ASSOC_FLAGS
-GST_TYPE_BIN_FLAGS
-GST_TYPE_BUFFER_FLAG
-GST_TYPE_CLOCK_ENTRY_STATUS
-GST_TYPE_CLOCK_ENTRY_TYPE
-GST_TYPE_CLOCK_FLAGS
-GST_TYPE_CLOCK_RETURN
-GST_TYPE_CORE_ERROR
-GST_TYPE_CPU_FLAGS
-GST_TYPE_DATA_FLAGS
-GST_TYPE_DEBUG_COLOR_FLAGS
-GST_TYPE_DEBUG_LEVEL
-GST_TYPE_ELEMENT_FLAGS
-GST_TYPE_ELEMENT_STATE
-GST_TYPE_ELEMENT_STATE_RETURN
-GST_TYPE_EVENT_FLAG
-GST_TYPE_EVENT_TYPE
-GST_TYPE_FORMAT
-GST_TYPE_INDEX_CERTAINTY
-GST_TYPE_INDEX_ENTRY_TYPE
-GST_TYPE_INDEX_FLAGS
-GST_TYPE_INDEX_LOOKUP_METHOD
-GST_TYPE_INDEX_RESOLVER_METHOD
-GST_TYPE_LIBRARY_ERROR
-GST_TYPE_OBJECT_FLAGS
-GST_TYPE_PAD_DIRECTION
-GST_TYPE_PAD_FLAGS
-GST_TYPE_PAD_LINK_RETURN
-GST_TYPE_PAD_PRESENCE
-GST_TYPE_PAD_TEMPLATE_FLAGS
-GST_TYPE_PARSE_ERROR
-GST_TYPE_PLUGIN_ERROR
-GST_TYPE_QUERY_TYPE
-GST_TYPE_REGISTRY_FLAGS
-GST_TYPE_REGISTRY_RETURN
-GST_TYPE_RESOURCE_ERROR
-GST_TYPE_RESULT
-GST_TYPE_RANK
-GST_TYPE_SCHEDULER_FLAGS
-GST_TYPE_SCHEDULER_STATE
-GST_TYPE_SEEK_ACCURACY
-GST_TYPE_SEEK_TYPE
-GST_TYPE_STREAM_ERROR
-GST_TYPE_TAG_FLAG
-GST_TYPE_TAG_MERGE_MODE
-GST_TYPE_THREAD_STATE
-GST_TYPE_TYPE_FIND_PROBABILITY
-GST_TYPE_URI_TYPE
-<SUBSECTION Private>
-gst_alloc_trace_flags_get_type
-gst_assoc_flags_get_type
-gst_bin_flags_get_type
-gst_buffer_flag_get_type
-gst_clock_entry_status_get_type
-gst_clock_entry_type_get_type
-gst_clock_flags_get_type
-gst_clock_return_get_type
-gst_core_error_get_type
-gst_cpu_flags_get_type
-gst_data_flags_get_type
-gst_debug_color_flags_get_type
-gst_debug_level_get_type
-gst_element_flags_get_type
-gst_element_state_get_type
-gst_element_state_return_get_type
-gst_event_flag_get_type
-gst_event_type_get_type
-gst_format_get_type
-gst_index_certainty_get_type
-gst_index_entry_type_get_type
-gst_index_flags_get_type
-gst_index_lookup_method_get_type
-gst_index_resolver_method_get_type
-gst_library_error_get_type
-gst_object_flags_get_type
-gst_pad_direction_get_type
-gst_pad_flags_get_type
-gst_pad_link_return_get_type
-gst_pad_presence_get_type
-gst_pad_template_flags_get_type
-gst_parse_error_get_type
-gst_plugin_error_get_type
-gst_query_type_get_type
-gst_registry_flags_get_type
-gst_registry_return_get_type
-gst_resource_error_get_type
-gst_result_get_type
-gst_rank_get_type
-gst_scheduler_flags_get_type
-gst_scheduler_state_get_type
-gst_seek_accuracy_get_type
-gst_seek_type_get_type
-gst_stream_error_get_type
-gst_tag_flag_get_type
-gst_tag_merge_mode_get_type
-gst_thread_state_get_type
-gst_type_find_probability_get_type
-gst_uri_type_get_type
-</SECTION>
-
-<SECTION>
 <FILE>gsterror</FILE>
 <TITLE>GstGError</TITLE>
 GstCoreError
 GstLibraryError
 GstResourceError
 GstStreamError
+GST_CORE_ERROR
 GST_LIBRARY_ERROR
 GST_RESOURCE_ERROR
-GST_CORE_ERROR
 GST_STREAM_ERROR
 GST_ERROR_SYSTEM
 gst_error_get_message
@@ -624,8 +539,16 @@ gst_resource_error_quark
 gst_library_error_quark
 <SUBSECTION Standard>
 GST_TYPE_G_ERROR
+GST_TYPE_CORE_ERROR
+GST_TYPE_LIBRARY_ERROR
+GST_TYPE_RESOURCE_ERROR
+GST_TYPE_STREAM_ERROR
 <SUBSECTION Private>
 gst_g_error_get_type
+gst_core_error_get_type
+gst_library_error_get_type
+gst_resource_error_get_type
+gst_stream_error_get_type
 </SECTION>
 
 <SECTION>
@@ -680,8 +603,16 @@ gst_event_new_flush
 GST_EVENT
 GST_IS_EVENT
 GST_TYPE_EVENT
+GST_TYPE_EVENT_FLAG
+GST_TYPE_EVENT_TYPE
+GST_TYPE_SEEK_ACCURACY
+GST_TYPE_SEEK_TYPE
 <SUBSECTION Private>
 gst_event_get_type
+gst_event_flag_get_type
+gst_event_type_get_type
+gst_seek_accuracy_get_type
+gst_seek_type_get_type
 </SECTION>
 
 <SECTION>
@@ -704,6 +635,10 @@ gst_format_get_by_nick
 gst_formats_contains
 gst_format_get_details
 gst_format_get_definitions
+<SUBSECTION Standard>
+GST_TYPE_FORMAT
+<SUBSECTION Private>
+gst_format_get_type
 </SECTION>
 
 <SECTION>
@@ -778,8 +713,20 @@ GST_INDEX_CLASS
 GST_IS_INDEX_CLASS
 GST_INDEX_GET_CLASS
 GST_TYPE_INDEX_ENTRY
+GST_TYPE_ASSOC_FLAGS
+GST_TYPE_INDEX_CERTAINTY
+GST_TYPE_INDEX_ENTRY_TYPE
+GST_TYPE_INDEX_FLAGS
+GST_TYPE_INDEX_LOOKUP_METHOD
+GST_TYPE_INDEX_RESOLVER_METHOD
 <SUBSECTION Private>
 gst_index_get_type
+gst_assoc_flags_get_type
+gst_index_certainty_get_type
+gst_index_entry_type_get_type
+gst_index_flags_get_type
+gst_index_lookup_method_get_type
+gst_index_resolver_method_get_type
 </SECTION>
 
 <SECTION>
@@ -872,10 +819,15 @@ gst_debug_reset_log_function
 gst_debug_print_stack_trace
 GST_TIME_FORMAT
 GST_TIME_ARGS
+<SUBSECTION Standard>
+GST_TYPE_DEBUG_COLOR_FLAGS
+GST_TYPE_DEBUG_LEVEL
 <SUBSECTION Private>
 GST_DEBUG_FG_MASK
 GST_DEBUG_BG_MASK
 GST_DEBUG_FORMAT_MASK
+gst_debug_color_flags_get_type
+gst_debug_level_get_type
 </SECTION>
 
 <SECTION>
@@ -960,8 +912,10 @@ GST_OBJECT_CLASS
 GST_IS_OBJECT_CLASS
 GST_OBJECT_GET_CLASS
 GST_TYPE_OBJECT
+GST_TYPE_OBJECT_FLAGS
 <SUBSECTION Private>
 gst_object_get_type
+gst_object_flags_get_type
 xmlNodePtr
 </SECTION>
 
@@ -970,7 +924,6 @@ xmlNodePtr
 <TITLE>GstPad</TITLE>
 GstPad
 GstPadLink
-GstPadLinkReturn
 GST_PAD_LINK_FAILED
 GST_PAD_LINK_SUCCESSFUL
 GST_PAD_QUERY_TYPE_FUNCTION
@@ -993,6 +946,8 @@ GstPadBufferAllocFunction
 GstPadDispatcherFunction
 GstPadDirection
 GstPadFlags
+GstPadLinkReturn
+GstPadPresence
 GST_PAD_NAME
 GST_PAD_PARENT
 GST_PAD_ELEMENT_PRIVATE
@@ -1009,7 +964,6 @@ GST_PAD_IS_USABLE
 GST_PAD_CAN_PULL
 GST_PAD_IS_SRC
 GST_PAD_IS_SINK
-GstPadPresence
 gst_pad_new
 gst_pad_new_from_template
 gst_pad_custom_new
@@ -1105,8 +1059,16 @@ GST_IS_PAD
 GST_PAD_CLASS
 GST_IS_PAD_CLASS
 GST_TYPE_PAD
+GST_TYPE_PAD_DIRECTION
+GST_TYPE_PAD_FLAGS
+GST_TYPE_PAD_LINK_RETURN
+GST_TYPE_PAD_PRESENCE
 <SUBSECTION Private>
 gst_pad_get_type
+gst_pad_direction_get_type
+gst_pad_flags_get_type
+gst_pad_link_return_get_type
+gst_pad_presence_get_type
 </SECTION>
 
 <SECTION>
@@ -1134,8 +1096,10 @@ GST_PAD_TEMPLATE_CLASS
 GST_IS_PAD_TEMPLATE_CLASS
 GST_STATIC_PAD_TEMPLATE
 GST_TYPE_PAD_TEMPLATE
+GST_TYPE_PAD_TEMPLATE_FLAGS
 <SUBSECTION Private>
 gst_pad_template_get_type
+gst_pad_template_flags_get_type
 </SECTION>
 
 <SECTION>
@@ -1146,6 +1110,10 @@ GST_PARSE_ERROR
 GstParseError
 gst_parse_launch
 gst_parse_launchv
+<SUBSECTION Standard>
+GST_TYPE_PARSE_ERROR
+<SUBSECTION Private>
+gst_parse_error_get_type
 </SECTION>
 
 <SECTION>
@@ -1202,8 +1170,11 @@ gst_library_load
 <SUBSECTION Standard>
 GST_PLUGIN
 GST_TYPE_PLUGIN
+GST_TYPE_PLUGIN_ERROR
 <SUBSECTION Private>
 gst_plugin_get_type
+<SUBSECTION Private>
+gst_plugin_error_get_type
 </SECTION>
 
 <SECTION>
@@ -1262,6 +1233,10 @@ gst_query_type_get_by_nick
 gst_query_types_contains
 gst_query_type_get_details
 gst_query_type_get_definitions
+<SUBSECTION Standard>
+GST_TYPE_QUERY_TYPE
+<SUBSECTION Private>
+gst_query_type_get_type
 </SECTION>
 
 <SECTION>
@@ -1360,8 +1335,12 @@ GST_REGISTRY_CLASS
 GST_IS_REGISTRY_CLASS
 GST_REGISTRY_GET_CLASS
 GST_TYPE_REGISTRY
+GST_TYPE_REGISTRY_FLAGS
+GST_TYPE_REGISTRY_RETURN
 <SUBSECTION Private>
 gst_registry_get_type
+gst_registry_flags_get_type
+gst_registry_return_get_type
 </SECTION>
 
 <SECTION>
@@ -1421,8 +1400,12 @@ GST_SCHEDULER_CLASS
 GST_IS_SCHEDULER_CLASS
 GST_SCHEDULER_GET_CLASS
 GST_TYPE_SCHEDULER
+GST_TYPE_SCHEDULER_FLAGS
+GST_TYPE_SCHEDULER_STATE
 <SUBSECTION Private>
 gst_scheduler_get_type
+gst_scheduler_flags_get_type
+gst_scheduler_state_get_type
 </SECTION>
 
 <SECTION>
@@ -1609,8 +1592,12 @@ GST_IS_TAG_LIST
 GST_TAG_FLAG_IS_VALID
 GST_TAG_MODE_IS_VALID
 GST_TYPE_TAG_LIST
+GST_TYPE_TAG_FLAG
+GST_TYPE_TAG_MERGE_MODE
 <SUBSECTION Private>
 gst_tag_list_get_type
+gst_tag_flag_get_type
+gst_tag_merge_mode_get_type
 </SECTION>
 
 <SECTION>
@@ -1653,8 +1640,10 @@ GST_THREAD_CLASS
 GST_IS_THREAD_CLASS
 GST_THREAD_GET_CLASS
 GST_TYPE_THREAD
+GST_TYPE_THREAD_STATE
 <SUBSECTION Private>
 gst_thread_get_type
+gst_thread_state_get_type
 </SECTION>
 
 <SECTION>
@@ -1685,6 +1674,10 @@ gst_alloc_trace_register
 gst_alloc_trace_new
 gst_alloc_trace_free
 gst_trace_add_entry
+<SUBSECTION Standard>
+GST_TYPE_ALLOC_TRACE_FLAGS
+<SUBSECTION Private>
+gst_alloc_trace_flags_get_type
 </SECTION>
 
 <SECTION>
@@ -1708,7 +1701,9 @@ gst_type_find_suggest
 gst_type_find_get_length
 gst_type_find_register
 <SUBSECTION Standard>
+GST_TYPE_TYPE_FIND_PROBABILITY
 <SUBSECTION Private>
+gst_type_find_probability_get_type
 </SECTION>
 
 <SECTION>
@@ -1741,6 +1736,15 @@ GstRank
 GST_PADDING
 GST_PADDING_INIT
 <SUBSECTION Standard>
+GST_TYPE_ELEMENT_STATE
+GST_TYPE_ELEMENT_STATE_RETURN
+GST_TYPE_RANK
+GST_TYPE_RESULT
+<SUBSECTION Private>
+gst_element_state_get_type
+gst_element_state_return_get_type
+gst_rank_get_type
+gst_result_get_type
 </SECTION>
 
 <SECTION>
@@ -1776,8 +1780,10 @@ gst_uri_handler_get_type
 GstURIType
 <SUBSECTION Standard>
 GST_TYPE_URI
+GST_TYPE_URI_TYPE
 <SUBSECTION Private>
 gst_uri_get_uri_type
+gst_uri_type_get_type
 </SECTION>
 
 <SECTION>
index e9361f1..5250640 100644 (file)
@@ -14,3 +14,372 @@ all gstreamer core related enumerations
 
 </para>
 
+<!-- ##### ENUM GstAllocTraceFlags ##### -->
+<para>
+Flags indicating which tracing feature to enable.
+</para>
+
+@GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory
+@GST_ALLOC_TRACE_MEM_LIVE: trace pointers of unfreed memory
+
+<!-- ##### ENUM GstAssocFlags ##### -->
+<para>
+flags for an association entry
+</para>
+
+@GST_ASSOCIATION_FLAG_NONE: no extra flags
+@GST_ASSOCIATION_FLAG_KEY_UNIT: the entry marks a key unit, a key unit is one
+                                that marks a place where one can randomly seek to.
+@GST_ASSOCIATION_FLAG_DELTA_UNIT: 
+@GST_ASSOCIATION_FLAG_LAST: extra user defined flags should start here.
+
+<!-- ##### ENUM GstDebugColorFlags ##### -->
+<para>
+These are some terminal-oriented flags you can use when creating your debugging
+categories to make them stand out in debugging output.
+</para>
+
+@GST_DEBUG_FG_BLACK: Use black as foreground color.
+@GST_DEBUG_FG_RED: Use red as foreground color.
+@GST_DEBUG_FG_GREEN: Use green as foreground color.
+@GST_DEBUG_FG_YELLOW: Use yellow as foreground color.
+@GST_DEBUG_FG_BLUE: Use blue as foreground color.
+@GST_DEBUG_FG_MAGENTA: Use magenta as foreground color.
+@GST_DEBUG_FG_CYAN: Use cyan as foreground color.
+@GST_DEBUG_FG_WHITE: Use white as foreground color.
+@GST_DEBUG_BG_BLACK: Use black as background color.
+@GST_DEBUG_BG_RED: Use red as background color.
+@GST_DEBUG_BG_GREEN: Use green as background color.
+@GST_DEBUG_BG_YELLOW: Use yellow as background color.
+@GST_DEBUG_BG_BLUE: Use blue as background color.
+@GST_DEBUG_BG_MAGENTA: Use magenta as background color.
+@GST_DEBUG_BG_CYAN: Use cyan as background color.
+@GST_DEBUG_BG_WHITE: Use white as background color.
+@GST_DEBUG_BOLD: Make the output bold.
+@GST_DEBUG_UNDERLINE: Underline the output.
+
+<!-- ##### ENUM GstDebugLevel ##### -->
+<para>
+The level defines the importance of a debugging message. The more important a 
+message is, the greater the probability that the debugging system outputs it.
+</para>
+
+@GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
+debugging output.
+@GST_LEVEL_ERROR: Error messages are to be used only when an error occured 
+that stops the application from keeping working correctly.
+An examples is gst_element_error, which outputs a message with this priority.
+It does not mean that the application is terminating as with g_errror.
+@GST_LEVEL_WARNING: Warning messages are to inform about abnormal behaviour
+that could lead to problems or weird behaviour later on. An example of this 
+would be clocking issues ("your computer is pretty slow") or broken input
+data ("Can't synchronize to stream.")
+@GST_LEVEL_INFO: Informational messages should be used to keep the developer
+updated about what is happening.
+Examples where this should be used are when a typefind function has 
+successfully determined the type of the stream or when an mp3 plugin detects
+the format to be used. ("This file has mono sound.")
+@GST_LEVEL_DEBUG: Debugging messages should be used when something common
+happens that is not the expected default behavior. 
+An example would be notifications about state changes or receiving/sending of
+events.
+@GST_LEVEL_LOG: Log messages are messages that are very common but might be 
+useful to know. As a rule of thumb a pipeline that is iterating as expected
+should never output anzthing else but LOG messages.
+Examples for this are referencing/dereferencing of objects or cothread switches.
+@GST_LEVEL_COUNT: The number of defined debugging levels.
+
+<!-- ##### ENUM GstElementState ##### -->
+<para>
+These contants describe the state a #GstElement is in and transition scheduled for the #GstElement (the pending state).
+</para>
+
+@GST_STATE_VOID_PENDING: no transition is schedules for this element
+@GST_STATE_NULL: this is the default state all elements are in, after they have been created and are doing nothing
+@GST_STATE_READY: the element is ready to start doing something
+@GST_STATE_PAUSED: the element is paused for a period of time
+@GST_STATE_PLAYING: the element is doing something
+
+<!-- ##### ENUM GstElementStateReturn ##### -->
+<para>
+One of these values is returned from a gst_element_set_state() call.
+As GST_STATE_FAILURE is equal to 0, one can use a boolean comparission
+against the GstElementStateReturn value.
+</para>
+
+@GST_STATE_FAILURE: the state of the element could not be changed
+@GST_STATE_SUCCESS: the state of the element has already be changed
+@GST_STATE_ASYNC: the state of the element will change in the near future
+
+<!-- ##### ENUM GstEventFlag ##### -->
+<para>
+Event flags are used when querying for supported events
+</para>
+
+@GST_EVENT_FLAG_NONE: no value
+@GST_RATE_FLAG_NEGATIVE: indicates negative rates are supported
+
+<!-- ##### ENUM GstEventType ##### -->
+<para>
+The different major types of events.
+</para>
+
+@GST_EVENT_UNKNOWN: unknown event.
+@GST_EVENT_EOS: an end-of-stream event.
+@GST_EVENT_FLUSH: a flush event.
+@GST_EVENT_EMPTY: an empty event.
+@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
+@GST_EVENT_QOS: a quality of service event
+@GST_EVENT_SEEK: a seek event.
+@GST_EVENT_SEEK_SEGMENT: a segment seek with start and stop position
+@GST_EVENT_SEGMENT_DONE: the event that will be emited when the segment seek has ended
+@GST_EVENT_SIZE: a size suggestion for a peer element
+@GST_EVENT_RATE: adjust the output rate of an element
+@GST_EVENT_FILLER: a dummy event that should be ignored by plugins
+@GST_EVENT_TS_OFFSET: an event to set the time offset on buffers
+@GST_EVENT_INTERRUPT: mainly used by _get based elements when they were interrupted
+                      while waiting for a buffer.
+@GST_EVENT_NAVIGATION: 
+@GST_EVENT_TAG: 
+
+<!-- ##### ENUM GstFormat ##### -->
+<para>
+Standard predefined formats
+</para>
+
+@GST_FORMAT_UNDEFINED: undefined format
+@GST_FORMAT_DEFAULT: the default format of the pad/element
+@GST_FORMAT_BYTES: bytes
+@GST_FORMAT_TIME: time in nanoseconds
+@GST_FORMAT_BUFFERS: buffers
+@GST_FORMAT_PERCENT: percentage of stream
+
+<!-- ##### ENUM GstIndexCertainty ##### -->
+<para>
+The certainty of a group in the index.
+</para>
+
+@GST_INDEX_UNKNOWN: accuracy is not known
+@GST_INDEX_CERTAIN: accuracy is perfect
+@GST_INDEX_FUZZY: accuracy is fuzzy
+
+<!-- ##### ENUM GstIndexEntryType ##### -->
+<para>
+The different types of entries in the index.
+</para>
+
+@GST_INDEX_ENTRY_ID: This entry is an id that maps an index id to its owner object
+@GST_INDEX_ENTRY_ASSOCIATION: This entry is an association between formats
+@GST_INDEX_ENTRY_OBJECT: An object
+@GST_INDEX_ENTRY_FORMAT: A format definition
+
+<!-- ##### ENUM GstIndexFlags ##### -->
+<para>
+Flags for this index
+</para>
+
+@GST_INDEX_WRITABLE: The index is writable
+@GST_INDEX_READABLE: The index is readable
+@GST_INDEX_FLAG_LAST: First flag that can be used by subclasses
+
+<!-- ##### ENUM GstIndexLookupMethod ##### -->
+<para>
+Specify the method to find an index entry in the index.
+</para>
+
+@GST_INDEX_LOOKUP_EXACT: There has to be an exact indexentry with the given format/value
+@GST_INDEX_LOOKUP_BEFORE: The exact entry or the one before it
+@GST_INDEX_LOOKUP_AFTER: The exact entry or the one after it
+
+<!-- ##### ENUM GstIndexResolverMethod ##### -->
+<para>
+The method used to resolve index writers
+</para>
+
+@GST_INDEX_RESOLVER_CUSTOM: Use a custom resolver
+@GST_INDEX_RESOLVER_GTYPE: Resolve based on the GType of the object
+@GST_INDEX_RESOLVER_PATH: Resolve on the path in graph
+
+<!-- ##### ENUM GstObjectFlags ##### -->
+<para>
+Flags for an object
+</para>
+
+@GST_DESTROYED: The object is flagged for destruction
+@GST_FLOATING: The object is created but has no parent yet to manage it
+@GST_OBJECT_FLAG_LAST: subclasses can add additional flags starting from this flag
+
+<!-- ##### ENUM GstPadDirection ##### -->
+<para>
+The direction of a pad.
+</para>
+
+@GST_PAD_UNKNOWN: direction is unknown.
+@GST_PAD_SRC: the pad is a source pad.
+@GST_PAD_SINK: the pad is a sink pad.
+
+<!-- ##### ENUM GstPadLinkReturn ##### -->
+<para>
+The result of a pad link.
+</para>
+
+@GST_PAD_LINK_REFUSED: the link was refused.
+@GST_PAD_LINK_DELAYED: the link was delayed, probably because the
+                       element needs more specific pad capabilitiess.
+@GST_PAD_LINK_OK:      the link succeeded.
+@GST_PAD_LINK_DONE:    the link succeeded, 
+                       any more attempts are not needed.
+
+<!-- ##### ENUM GstPadPresence ##### -->
+<para>
+Indicates when this pad will become available.
+</para>
+
+@GST_PAD_ALWAYS: the pad is always available
+@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
+@GST_PAD_REQUEST: th pad is only available on request with 
+gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
+
+<!-- ##### ENUM GstPadTemplateFlags ##### -->
+<para>
+Flags for the padtemplate
+</para>
+
+@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
+@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
+
+<!-- ##### ENUM GstPluginError ##### -->
+<para>
+The plugin loading errors
+</para>
+
+@GST_PLUGIN_ERROR_MODULE: The plugin could not be loaded
+@GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies
+@GST_PLUGIN_ERROR_NAME_MISMATCH: 
+
+<!-- ##### ENUM GstQueryType ##### -->
+<para>
+Standard predefined Query types
+</para>
+
+@GST_QUERY_NONE: invalid query type
+@GST_QUERY_TOTAL: total length of stream
+@GST_QUERY_POSITION: current position in stream
+@GST_QUERY_LATENCY: latency of stream
+@GST_QUERY_JITTER: current jitter of stream
+@GST_QUERY_START: start of configured segment
+@GST_QUERY_SEGMENT_END: end of configured segment
+@GST_QUERY_RATE: current rate of the stream
+
+<!-- ##### ENUM GstRank ##### -->
+<para>
+Element priority ranks. Defines the order in which the autoplugger (or similar
+rank-picking mechanisms) will choose this element over an alternative one
+with the same function.
+The rank is a unsigned integer ranging from 0 (GST_RANK_NONE) to 256 (GST_RANK_PRIMARY).
+These constants serve as a rough guidiance for defining the rank of a #GstPlugin using
+gst_plugin_feature_set_rank().
+</para>
+
+@GST_RANK_NONE: will be chosen last or not at all
+@GST_RANK_MARGINAL: unlikly to be chosen
+@GST_RANK_SECONDARY: likely to be chosen
+@GST_RANK_PRIMARY: will be chosen first
+
+<!-- ##### ENUM GstRegistryFlags ##### -->
+<para>
+Flags for the registry
+</para>
+
+@GST_REGISTRY_READABLE: The registry can be read
+@GST_REGISTRY_WRITABLE: The registry can be written to
+@GST_REGISTRY_EXISTS: The registry exists
+@GST_REGISTRY_REMOTE: The registry is remote and might be slower
+@GST_REGISTRY_DELAYED_LOADING: The registry will be loaded on demand.
+
+<!-- ##### ENUM GstRegistryReturn ##### -->
+<para>
+The return value of registry operations
+</para>
+
+@GST_REGISTRY_OK: The registry reported no error.
+@GST_REGISTRY_LOAD_ERROR: There was a load error
+@GST_REGISTRY_SAVE_ERROR: There was an error saving the registry
+@GST_REGISTRY_PLUGIN_LOAD_ERROR: There was an error loading a plugin
+@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR: There was an error saving a plugin
+
+<!-- ##### ENUM GstSchedulerFlags ##### -->
+<para>
+Flags for the scheduler
+</para>
+
+@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
+@GST_SCHEDULER_FLAG_NEW_API: 
+@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
+                          from here.
+
+<!-- ##### ENUM GstSchedulerState ##### -->
+<para>
+The state of the scheduler
+</para>
+
+@GST_SCHEDULER_STATE_NONE: no state
+@GST_SCHEDULER_STATE_RUNNING: the scheduler is running
+@GST_SCHEDULER_STATE_STOPPED: the scheduler is stopped
+@GST_SCHEDULER_STATE_ERROR: the scheduler is in error
+
+<!-- ##### ENUM GstSeekAccuracy ##### -->
+<para>
+The seekaccuracy gives more information of how the seek was performed,
+if the seek was accurate or fuzzy.
+</para>
+
+@GST_SEEK_CERTAIN: The seek was exact
+@GST_SEEK_FUZZY: The seek was fuzzy, exact position can not be guaranteed
+
+<!-- ##### ENUM GstSeekType ##### -->
+<para>
+The different types of seek events. When constructing a seek event a format,
+a seek method and optional flags are OR-ed together. The seek event is then
+inserted into the graph with #gst_pad_send_event() or #gst_element_send_event().
+
+Following example illustrates how to insert a seek event (1 second in the stream)
+in a pipeline.
+<example>
+<title>Insertion of a seek event into a pipeline</title>
+  <programlisting>
+  gboolean res;
+  GstEvent *event;
+
+  event = gst_event_new_seek (
+            GST_FORMAT_TIME |          /* seek on time */
+           GST_SEEK_METHOD_SET |       /* set the absolute position */
+           GST_SEEK_FLAG_FLUSH,        /* flush any pending data */
+           1 * GST_SECOND);            /* the seek offset (1 second) */
+
+  res = gst_element_send_event (GST_ELEMENT (osssink), event);
+  if (!res) {
+    g_warning ("seek failed");
+  }
+  </programlisting>
+</example>
+</para>
+
+@GST_SEEK_METHOD_CUR: Seek to an relative position
+@GST_SEEK_METHOD_SET: Seek to an absolute position
+@GST_SEEK_METHOD_END: Seek relative to the end of the stream
+@GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking
+@GST_SEEK_FLAG_ACCURATE: Seek as accurately as possible
+@GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit
+@GST_SEEK_FLAG_SEGMENT_LOOP: Loop between start and stop in a segmented seek
+
+<!-- ##### ENUM GstThreadState ##### -->
+<para>
+Thread flags:
+</para>
+
+@GST_THREAD_STATE_SPINNING: The thread is runnning
+@GST_THREAD_STATE_REAPING: The thread is ending.
+@GST_THREAD_STATE_WAITING: 
+@GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
+
index 9fa9b39..661024e 100644 (file)
@@ -16,7 +16,7 @@ Categorized error messages
 
 <!-- ##### ENUM GstCoreError ##### -->
 <para>
-Core errors are anything that can go wrong in or using the core GStreamer library
+
 </para>
 
 @GST_CORE_ERROR_FAILED: 
@@ -35,7 +35,7 @@ Core errors are anything that can go wrong in or using the core GStreamer librar
 
 <!-- ##### ENUM GstLibraryError ##### -->
 <para>
-Library errors are for errors from the library being used by elements initializing, closing, ...
+
 </para>
 
 @GST_LIBRARY_ERROR_FAILED: 
@@ -48,9 +48,7 @@ Library errors are for errors from the library being used by elements initializi
 
 <!-- ##### ENUM GstResourceError ##### -->
 <para>
-Resource errors are for anything external used by an element:
-memory, files, network connections, process space, ...
-They're typically used by source and sink elements
+
 </para>
 
 @GST_RESOURCE_ERROR_FAILED: 
@@ -70,9 +68,7 @@ They're typically used by source and sink elements
 
 <!-- ##### ENUM GstStreamError ##### -->
 <para>
-Stream errors are for anything related to the stream being processed:
-format errors, media type errors, ...
-They're typically used by decoders, demuxers, converters, ...
+
 </para>
 
 @GST_STREAM_ERROR_FAILED: 
@@ -88,21 +84,21 @@ They're typically used by decoders, demuxers, converters, ...
 @GST_STREAM_ERROR_FORMAT: 
 @GST_STREAM_ERROR_NUM_ERRORS: 
 
-<!-- ##### MACRO GST_LIBRARY_ERROR ##### -->
+<!-- ##### MACRO GST_CORE_ERROR ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### MACRO GST_RESOURCE_ERROR ##### -->
+<!-- ##### MACRO GST_LIBRARY_ERROR ##### -->
 <para>
 
 </para>
 
 
 
-<!-- ##### MACRO GST_CORE_ERROR ##### -->
+<!-- ##### MACRO GST_RESOURCE_ERROR ##### -->
 <para>
 
 </para>
index 953aaa6..ccf8369 100644 (file)
@@ -204,8 +204,8 @@ in a pipeline.
 
 <!-- ##### ENUM GstSeekAccuracy ##### -->
 <para>
-The seekaccuracy gives more information of how the seek was performed,
-if the seek was accurate or fuzzy.
+The accuracy about a seek operation gives more information of how the seek was
+performed, namly if the seek was accurate or fuzzy.
 </para>
 
 @GST_SEEK_CERTAIN: The seek was exact
index c386b91..27c4b69 100644 (file)
@@ -69,18 +69,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
 </para>
 
 
-<!-- ##### ENUM GstPadLinkReturn ##### -->
-<para>
-The result of a pad link.
-</para>
-
-@GST_PAD_LINK_REFUSED: the link was refused.
-@GST_PAD_LINK_DELAYED: the link was delayed, probably because the
-                       element needs more specific pad capabilitiess.
-@GST_PAD_LINK_OK:      the link succeeded.
-@GST_PAD_LINK_DONE:    the link succeeded, 
-                       any more attempts are not needed.
-
 <!-- ##### MACRO GST_PAD_LINK_FAILED ##### -->
 <para>
 Macro to test if the given #GstPadLinkReturn value indicates a
@@ -295,13 +283,35 @@ The direction of a pad.
 
 <!-- ##### ENUM GstPadFlags ##### -->
 <para>
-Flags for the pad.
+
 </para>
 
-@GST_PAD_DISABLED: the pad is disabled.
+@GST_PAD_DISABLED: 
 @GST_PAD_NEGOTIATING: 
 @GST_PAD_DISPATCHING: 
-@GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags.
+@GST_PAD_FLAG_LAST: 
+
+<!-- ##### ENUM GstPadLinkReturn ##### -->
+<para>
+The result of a pad link.
+</para>
+
+@GST_PAD_LINK_REFUSED: the link was refused.
+@GST_PAD_LINK_DELAYED: the link was delayed, probably because the
+                       element needs more specific pad capabilitiess.
+@GST_PAD_LINK_OK:      the link succeeded.
+@GST_PAD_LINK_DONE:    the link succeeded, 
+                       any more attempts are not needed.
+
+<!-- ##### ENUM GstPadPresence ##### -->
+<para>
+Indicates when this pad will become available.
+</para>
+
+@GST_PAD_ALWAYS: the pad is always available
+@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
+@GST_PAD_REQUEST: the pad is only available on request with 
+gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
 
 <!-- ##### MACRO GST_PAD_NAME ##### -->
 <para>
@@ -441,16 +451,6 @@ Checks if the pad is a sink pad.
 @pad: a #GstPad to check.
 
 
-<!-- ##### ENUM GstPadPresence ##### -->
-<para>
-Indicates when this pad will become available.
-</para>
-
-@GST_PAD_ALWAYS: the pad is always available
-@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
-@GST_PAD_REQUEST: th pad is only available on request with 
-gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
-
 <!-- ##### FUNCTION gst_pad_new ##### -->
 <para>
 
index ce843c0..61056c3 100644 (file)
@@ -159,7 +159,7 @@ Check if the properties of the padtemplate are fixed
 Flags for the padtemplate
 </para>
 
-@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
+@GST_PAD_TEMPLATE_FIXED: the padtemplate has no variable properties
 @GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
 
 <!-- ##### FUNCTION gst_pad_template_new ##### -->
index b4f1918..dccf545 100644 (file)
@@ -44,12 +44,12 @@ The thread priority
 
 <!-- ##### ENUM GstThreadState ##### -->
 <para>
-Thread flags:
+Flags about the current thread state
 </para>
 
 @GST_THREAD_STATE_SPINNING: The thread is runnning
-@GST_THREAD_STATE_REAPING: The thread is ending.
-@GST_THREAD_STATE_WAITING: 
+@GST_THREAD_STATE_REAPING: The thread is ending
+@GST_THREAD_STATE_WAITING:
 @GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
 
 <!-- ##### FUNCTION gst_thread_new ##### -->