mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-04-26 04:36:20 +00:00
gst/: Fix docs.
Original commit message from CVS: * gst/gstevent.h: * gst/gsturi.h: Fix docs.
This commit is contained in:
parent
16731bd8c1
commit
27daf02ce6
3 changed files with 25 additions and 7 deletions
|
@ -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>
|
2005-11-09 Wim Taymans <wim@fluendo.com>
|
||||||
|
|
||||||
* docs/gst/gstreamer-sections.txt:
|
* docs/gst/gstreamer-sections.txt:
|
||||||
|
|
|
@ -100,12 +100,12 @@ G_BEGIN_DECLS
|
||||||
* In-band when travelling downstream.
|
* In-band when travelling downstream.
|
||||||
* @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.
|
* @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
|
* The custom event types can be used for private messages between elements
|
||||||
* that can't be expressed using normal
|
* that can't be expressed using normal
|
||||||
* GStreamer buffer passing semantics. Custom events carry an arbitrary
|
* GStreamer buffer passing semantics. Custom events carry an arbitrary
|
||||||
* GstStructure.
|
* #GstStructure.
|
||||||
* Specific custom events are distinguished by the name of the structure.
|
* Specific custom events are distinguished by the name of the structure.
|
||||||
*/
|
*/
|
||||||
/* NOTE: keep in sync with quark registration in gstevent.c */
|
/* NOTE: keep in sync with quark registration in gstevent.c */
|
||||||
|
@ -171,7 +171,8 @@ typedef struct _GstEventClass GstEventClass;
|
||||||
* GST_EVENT_TIMESTAMP:
|
* GST_EVENT_TIMESTAMP:
|
||||||
* @event: the event to query
|
* @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)
|
#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,
|
* 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
|
* 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
|
* inserted into the graph with gst_pad_send_event() or
|
||||||
* #gst_element_send_event().
|
* gst_element_send_event().
|
||||||
*/
|
*/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
/* one of these */
|
/* one of these */
|
||||||
|
@ -235,7 +236,7 @@ typedef enum {
|
||||||
* faster but less accurate.
|
* faster but less accurate.
|
||||||
* @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
|
* @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
|
* A non flushing seek might take some time to perform as the currently
|
||||||
* playing data in the pipeline will not be cleared.
|
* playing data in the pipeline will not be cleared.
|
||||||
|
@ -258,6 +259,17 @@ typedef enum {
|
||||||
GST_SEEK_FLAG_SEGMENT = (1 << 3)
|
GST_SEEK_FLAG_SEGMENT = (1 << 3)
|
||||||
} GstSeekFlags;
|
} 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 {
|
struct _GstEvent {
|
||||||
GstMiniObject mini_object;
|
GstMiniObject mini_object;
|
||||||
|
|
||||||
|
|
|
@ -65,6 +65,7 @@ typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstURIHandlerInterface:
|
* GstURIHandlerInterface:
|
||||||
|
* @parent: The parent interface type
|
||||||
* @get_type: Method to tell wether the element handles source or sink URI.
|
* @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_protocols: Method to return the list of protocols handled by the element.
|
||||||
* @get_uri: Method to return the URI currently 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.
|
* #GstElements using this interface should implement these methods.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GstURIHandlerInterface {
|
struct _GstURIHandlerInterface {
|
||||||
GTypeInterface parent;
|
GTypeInterface parent;
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue