mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-03-30 12:49:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

gst/: Fix docs.

Browse source 
Original commit message from CVS:
* gst/gstevent.h:
* gst/gsturi.h:
Fix docs.
This commit is contained in:
Wim Taymans 2005-11-09 16:16:41 +00:00
parent 16731bd8c1
commit 27daf02ce6
3 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2005-11-09 Wim Taymans <wim@fluendo.com>
* gst/gstevent.h:
* gst/gsturi.h:
Fix docs.
2005-11-09 Wim Taymans <wim@fluendo.com>
* docs/gst/gstreamer-sections.txt:

24
gst/gstevent.h
View file

@ -100,12 +100,12 @@ G_BEGIN_DECLS
* 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 @@ typedef struct _GstEventClass GstEventClass;
* 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 @@ typedef struct _GstEventClass GstEventClass;
*
* 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 @@ typedef enum {
* 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 @@ typedef enum {
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;

2
gst/gsturi.h
View file

@ -65,6 +65,7 @@ typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
/**
* 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 @@ typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
*
* #GstElements using this interface should implement these methods.
*/
struct _GstURIHandlerInterface {
GTypeInterface parent;