Commit c73b0324 authored by Stefan Kost's avatar Stefan Kost

docs/design/part-messages.txt: update info

Original commit message from CVS:
* docs/design/part-messages.txt:
update info
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* gst/gstbus.c:
* gst/gstcaps.c:
* gst/gstcaps.h:
* gst/gstclock.c:
* gst/gstclock.h:
* gst/gstmessage.c:
added descriptions for bus and message
inline caps and clock docs
parent 6aa69df2
2005-08-27 Stefan Kost <ensonic@users.sf.net>
* docs/design/part-messages.txt:
update info
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* gst/gstbus.c:
* gst/gstcaps.c:
* gst/gstcaps.h:
* gst/gstclock.c:
* gst/gstclock.h:
* gst/gstmessage.c:
added descriptions for bus and message
inline caps and clock docs
2005-08-27 Stefan Kost <ensonic@users.sf.net>
* gst/gstmessage.c:
......
......@@ -4,7 +4,7 @@ Messages
Messages are refcounted lightweight objects to signal the application
of pipeline events.
Messages are implemented as a subclass of GstData with a generic
Messages are implemented as a subclass of GstMiniObject with a generic
GstStructure as the content. This allows for writing custom messages without
requiring an API change while allowing a wide range of different types
of messages.
......
......@@ -8,7 +8,9 @@ gstbasetransform.sgml
gstbin.sgml
gstbuffer.sgml
gstbus.sgml
gstcaps.sgml
gstcheck.sgml
gstclock.sgml
gstcollectpads.sgml
gstevent.sgml
gstfakesrc.sgml
......
<!-- ##### SECTION Title ##### -->
GstCaps
<!-- ##### SECTION Short_Description ##### -->
Structure describing sets of media formats
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstCaps ##### -->
<para>
</para>
@type:
@refcount:
@flags:
@structs:
<!-- ##### STRUCT GstStaticCaps ##### -->
<para>
</para>
@caps:
@string:
<!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
<para>
Flags that this caps has no specific content, but can contain anything.
</para>
<!-- ##### MACRO GST_CAPS_ANY ##### -->
<para>
Means that the element/pad can output 'anything'. Useful for elements
that output unknown media, such as filesrc.
</para>
<!-- ##### MACRO GST_CAPS_NONE ##### -->
<para>
The opposite of GST_CAPS_ANY: it means that the pad/element outputs an
undefined media type that can not be detected.
</para>
<!-- ##### MACRO GST_CAPS_REFCOUNT ##### -->
<para>
</para>
@caps:
<!-- ##### MACRO GST_CAPS_REFCOUNT_VALUE ##### -->
<para>
</para>
@caps:
<!-- ##### MACRO GST_STATIC_CAPS_ANY ##### -->
<para>
Creates a static caps that matches anything. This can be used in pad
templates.
</para>
@Returns: a new #GstCaps instance
<!-- ##### MACRO GST_STATIC_CAPS_NONE ##### -->
<para>
Creates a static caps that matches nothing. This can be used in pad
templates.
</para>
@Returns: a new #GstCaps instance
<!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
<para>
Convinience macro that checks if the number of structures in the gives caps is
exactly one.
</para>
@caps: the #GstCaps instance to check
<!-- ##### MACRO GST_DEBUG_CAPS ##### -->
<para>
Convinience macro for prining out the contents of caps with GST_DEBUG().
</para>
@string: a string the should be prepend to the caps data.
@caps: the caps to print
<!-- ##### MACRO GST_STATIC_CAPS ##### -->
<para>
Creates a static caps from an input string. This can be used in pad
templates.
</para>
@string: the string describing the caps.
@Returns: a new #GstCaps instance
<!-- ##### FUNCTION gst_caps_new_empty ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_caps_new_any ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_caps_new_simple ##### -->
<para>
</para>
@media_type:
@fieldname:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_caps_new_full ##### -->
<para>
</para>
@struct1:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_caps_new_full_valist ##### -->
<para>
</para>
@structure:
@var_args:
@Returns:
<!-- ##### FUNCTION gst_caps_copy ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_copy_nth ##### -->
<para>
</para>
@caps:
@nth:
@Returns:
<!-- ##### FUNCTION gst_static_caps_get ##### -->
<para>
</para>
@static_caps:
@Returns:
<!-- # Unused Parameters # -->
@caps:
<!-- ##### FUNCTION gst_caps_append ##### -->
<para>
</para>
@caps1:
@caps2:
<!-- ##### FUNCTION gst_caps_append_structure ##### -->
<para>
</para>
@caps:
@structure:
<!-- # Unused Parameters # -->
@caps1:
<!-- ##### FUNCTION gst_caps_get_size ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_get_structure ##### -->
<para>
</para>
@caps:
@index:
@Returns:
<!-- ##### FUNCTION gst_caps_set_simple ##### -->
<para>
</para>
@caps:
@field:
@Varargs:
<!-- ##### FUNCTION gst_caps_set_simple_valist ##### -->
<para>
</para>
@caps:
@field:
@varargs:
<!-- ##### FUNCTION gst_caps_is_any ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_is_empty ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_is_fixed ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_is_equal ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_is_equal_fixed ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_is_subset ##### -->
<para>
</para>
@subset:
@superset:
@Returns:
<!-- ##### FUNCTION gst_caps_intersect ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_union ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_normalize ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_do_simplify ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
<para>
</para>
@caps:
@parent:
@Returns:
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_caps_replace ##### -->
<para>
</para>
@caps:
@newcaps:
<!-- ##### FUNCTION gst_caps_to_string ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_from_string ##### -->
<para>
</para>
@string:
@Returns:
<!-- ##### FUNCTION gst_caps_subtract ##### -->
<para>
</para>
@minuend:
@subtrahend:
@Returns:
<!-- ##### FUNCTION gst_caps_make_writable ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_ref ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_boolean ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns:
<!-- ##### FUNCTION gst_caps_truncate ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_unref ##### -->
<para>
</para>
@caps:
<!-- ##### SECTION Title ##### -->
GstClock
<!-- ##### SECTION Short_Description ##### -->
Abstract class for global clocks
<!-- ##### SECTION Long_Description ##### -->
<para>
GStreamer uses a global clock to synchronise the plugins in a pipeline.
Different clock implementations are possible by implementing this abstract
base class.
</para>
<para>
The clock time is always measured in nanoseconds and always increases. The
pipeline uses the clock to calculate the stream time.
Usually all renderers sync to the global clock so that the clock is always
a good measure of the current playback time in the pipeline.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstSystemClock
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstClock ##### -->
<para>
</para>
@flags:
<!-- ##### ARG GstClock:stats ##### -->
<para>
Boolean property to activate stat generation on the clock.
</para>
<!-- ##### TYPEDEF GstClockTime ##### -->
<para>
A datatype to hold a time, measured in nanoseconds.
</para>
<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
<para>
A datatype to hold a timedifference, measured in nanoseconds.
</para>
<!-- ##### TYPEDEF GstClockID ##### -->
<para>
A detatype to hold the handle to an outstanding async clock callback
</para>
<!-- ##### MACRO GST_CLOCK_TIME_NONE ##### -->
<para>
Constant to define an undefined clock time
</para>
<!-- ##### MACRO GST_CLOCK_TIME_IS_VALID ##### -->
<para>
</para>
@time:
<!-- ##### MACRO GST_SECOND ##### -->
<para>
Constant that defines one GStreamer second
</para>
<!-- ##### MACRO GST_MSECOND ##### -->
<para>
Constant that defines one GStreamer millisecond
</para>
<!-- ##### MACRO GST_USECOND ##### -->
<para>
Constant that defines one GStreamer microsecond
</para>
<!-- ##### MACRO GST_NSECOND ##### -->
<para>
Constant that defines one GStreamer nanosecond
</para>
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
<para>
Calculate a difference between to clock times.
</para>
@s: the first time
@e: the second time
<!-- ##### MACRO GST_TIMEVAL_TO_TIME ##### -->
<para>
Convert a GTimeVal to a GstClockTime
</para>
@tv: the timeval to convert
<!-- ##### MACRO GST_TIME_TO_TIMEVAL ##### -->
<para>
Convert a GstClockTime to a GTimeVal
</para>
@t: The GstClockTime to convert
@tv: The target timeval
<!-- ##### MACRO GST_TIMESPEC_TO_TIME ##### -->
<para>
</para>
@ts:
<!-- ##### MACRO GST_TIME_TO_TIMESPEC ##### -->
<para>
</para>
@t:
@ts:
<!-- ##### MACRO GST_CLOCK_ENTRY_TRACE_NAME ##### -->
<para>
The name used for tracing clock entry allocations.
</para>
<!-- ##### STRUCT GstClockEntry ##### -->
<para>
All pending timeouts or periodic notifies are converted into
an entry.