From: <wt...@fr...> - 2005-11-09 16:16:57
|
CVS Root: /cvs/gstreamer Module: gstreamer Changes by: wtay Date: Wed Nov 09 2005 08:16:53 PST Log message: * gst/gstevent.h: * gst/gsturi.h: Fix docs. Modified files: . : ChangeLog gst : gstevent.h gsturi.h Links: http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/ChangeLog.diff?r1=1.1852&r2=1.1853 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gstevent.h.diff?r1=1.83&r2=1.84 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gsturi.h.diff?r1=1.13&r2=1.14 ====Begin Diffs==== Index: ChangeLog =================================================================== RCS file: /cvs/gstreamer/gstreamer/ChangeLog,v retrieving revision 1.1852 retrieving revision 1.1853 diff -u -d -r1.1852 -r1.1853 --- ChangeLog 9 Nov 2005 16:00:04 -0000 1.1852 +++ ChangeLog 9 Nov 2005 16:16:41 -0000 1.1853 @@ -1,5 +1,11 @@ 2005-11-09 Wim Taymans <wi...@fl...> + * gst/gstevent.h: + * gst/gsturi.h: + Fix docs. + +2005-11-09 Wim Taymans <wi...@fl...> * docs/gst/gstreamer-sections.txt: Moved the message async delivery private lock and cond to the private section. Index: gstevent.h RCS file: /cvs/gstreamer/gstreamer/gst/gstevent.h,v retrieving revision 1.83 retrieving revision 1.84 diff -u -d -r1.83 -r1.84 --- gstevent.h 8 Nov 2005 11:13:06 -0000 1.83 +++ gstevent.h 9 Nov 2005 16:16:41 -0000 1.84 @@ -100,12 +100,12 @@ * In-band when travelling downstream. * @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event. * - * GstEventType lists the standard event types that can be sent in a pipeline. + * #GstEventType lists the standard event types that can be sent in a pipeline. * The custom event types can be used for private messages between elements * that can't be expressed using normal * GStreamer buffer passing semantics. Custom events carry an arbitrary - * GstStructure. + * #GstStructure. * Specific custom events are distinguished by the name of the structure. */ /* NOTE: keep in sync with quark registration in gstevent.c */ @@ -171,7 +171,8 @@ * GST_EVENT_TIMESTAMP: * @event: the event to query - * Get the #GstClockTime timestamp of the event. + * Get the #GstClockTime timestamp of the event. This is the time when the event + * was created. #define GST_EVENT_TIMESTAMP(event) (GST_EVENT_CAST(event)->timestamp) @@ -214,8 +215,8 @@ * The different types of seek events. When constructing a seek event, a format, * a seek method and optional flags are to be provided. The seek event is then - * inserted into the graph with #gst_pad_send_event() or - * #gst_element_send_event(). + * inserted into the graph with gst_pad_send_event() or + * gst_element_send_event(). typedef enum { /* one of these */ @@ -235,7 +236,7 @@ * faster but less accurate. * @GST_SEEK_FLAG_SEGMENT: perform a segment seek. - * Flags to be used with #gst_element_seek() or #gst_event_new_seek() + * Flags to be used with gst_element_seek() or gst_event_new_seek() * A non flushing seek might take some time to perform as the currently * playing data in the pipeline will not be cleared. @@ -258,6 +259,17 @@ GST_SEEK_FLAG_SEGMENT = (1 << 3) } GstSeekFlags; +/** + * GstEvent: + * @mini_object: the parent structure + * @type: the #GstEventType of the event + * @timestamp: the timestamp of the event + * @src: the src of the event + * @structure: the #GstStructure containing the event info. + * + * A #GstEvent. + */ struct _GstEvent { GstMiniObject mini_object; Index: gsturi.h RCS file: /cvs/gstreamer/gstreamer/gst/gsturi.h,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- gsturi.h 9 Nov 2005 15:34:46 -0000 1.13 +++ gsturi.h 9 Nov 2005 16:16:41 -0000 1.14 @@ -65,6 +65,7 @@ /** * GstURIHandlerInterface: + * @parent: The parent interface type * @get_type: Method to tell wether the element handles source or sink URI. * @get_protocols: Method to return the list of protocols handled by the element. * @get_uri: Method to return the URI currently handled by the element. @@ -72,7 +73,6 @@ * #GstElements using this interface should implement these methods. - struct _GstURIHandlerInterface { GTypeInterface parent; |