mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-06-06 07:28:53 +00:00
Typo fixes; minor docs addition.
Original commit message from CVS: * docs/design/part-events.txt: * docs/design/part-overview.txt: * gst/gstevent.c: * gst/gsturi.c: * gst/gsturi.h: * libs/gst/base/gstbasesink.c: Typo fixes; minor docs addition.
This commit is contained in:
parent
003aaeaef3
commit
06f054445b
7 changed files with 25 additions and 13 deletions
10
ChangeLog
10
ChangeLog
|
@ -1,3 +1,13 @@
|
||||||
|
2007-04-28 Tim-Philipp Müller <tim at centricular dot net>
|
||||||
|
|
||||||
|
* docs/design/part-events.txt:
|
||||||
|
* docs/design/part-overview.txt:
|
||||||
|
* gst/gstevent.c:
|
||||||
|
* gst/gsturi.c:
|
||||||
|
* gst/gsturi.h:
|
||||||
|
* libs/gst/base/gstbasesink.c:
|
||||||
|
Typo fixes; minor docs addition.
|
||||||
|
|
||||||
2007-04-27 Sebastian Dröge <slomo@circular-chaos.org>
|
2007-04-27 Sebastian Dröge <slomo@circular-chaos.org>
|
||||||
|
|
||||||
* docs/gst/gstreamer-sections.txt:
|
* docs/gst/gstreamer-sections.txt:
|
||||||
|
|
|
@ -217,7 +217,7 @@ The general flow of executing the seek with FLUSH is as follows:
|
||||||
4) send a FLUSH_STOP event to all peer elements to allow streaming again.
|
4) send a FLUSH_STOP event to all peer elements to allow streaming again.
|
||||||
|
|
||||||
5) create a NEWSEGMENT event to signal the new buffer timestamp base time.
|
5) create a NEWSEGMENT event to signal the new buffer timestamp base time.
|
||||||
This event must be queued to be send by the streaming thread.
|
This event must be queued to be sent by the streaming thread.
|
||||||
|
|
||||||
6) start stopped tasks and unlock the STREAM_LOCK, dataflow will continue
|
6) start stopped tasks and unlock the STREAM_LOCK, dataflow will continue
|
||||||
now from the new position.
|
now from the new position.
|
||||||
|
|
|
@ -216,8 +216,8 @@ Dataflow and buffers
|
||||||
automatically and will call the gst_pad_set_caps() function of the element before
|
automatically and will call the gst_pad_set_caps() function of the element before
|
||||||
sending the buffer to the element.
|
sending the buffer to the element.
|
||||||
|
|
||||||
Both gst_pad_push() and gst_pad_pull_range() have a return value indicating wether
|
Both gst_pad_push() and gst_pad_pull_range() have a return value indicating whether
|
||||||
the operation succeeded. An error code means that no more data should be send
|
the operation succeeded. An error code means that no more data should be sent
|
||||||
to that pad. A source element that initiates the data flow in a thread typically
|
to that pad. A source element that initiates the data flow in a thread typically
|
||||||
pauses the producing thread when this happens.
|
pauses the producing thread when this happens.
|
||||||
|
|
||||||
|
|
|
@ -351,14 +351,14 @@ gst_event_get_structure (GstEvent * event)
|
||||||
/**
|
/**
|
||||||
* gst_event_new_flush_start:
|
* gst_event_new_flush_start:
|
||||||
*
|
*
|
||||||
* Allocate a new flush start event. The flush start event can be send
|
* Allocate a new flush start event. The flush start event can be sent
|
||||||
* upstream and downstream and travels out-of-bounds with the dataflow.
|
* upstream and downstream and travels out-of-bounds with the dataflow.
|
||||||
*
|
*
|
||||||
* It marks pads as being flushing and will make them return
|
* It marks pads as being flushing and will make them return
|
||||||
* #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
|
* #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
|
||||||
* gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
|
* gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
|
||||||
* gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
|
* gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
|
||||||
* on a flushing pad will return %FALSE immediatly.
|
* on a flushing pad will return %FALSE immediately.
|
||||||
*
|
*
|
||||||
* Elements should unlock any blocking functions and exit their streaming
|
* Elements should unlock any blocking functions and exit their streaming
|
||||||
* functions as fast as possible when this event is received.
|
* functions as fast as possible when this event is received.
|
||||||
|
@ -377,9 +377,9 @@ gst_event_new_flush_start (void)
|
||||||
/**
|
/**
|
||||||
* gst_event_new_flush_stop:
|
* gst_event_new_flush_stop:
|
||||||
*
|
*
|
||||||
* Allocate a new flush stop event. The flush start event can be send
|
* Allocate a new flush stop event. The flush stop event can be sent
|
||||||
* upstream and downstream and travels out-of-bounds with the dataflow.
|
* upstream and downstream and travels out-of-bounds with the dataflow.
|
||||||
* It is typically send after sending a FLUSH_START event to make the
|
* It is typically sent after sending a FLUSH_START event to make the
|
||||||
* pads accept data again.
|
* pads accept data again.
|
||||||
*
|
*
|
||||||
* Elements can process this event synchronized with the dataflow since
|
* Elements can process this event synchronized with the dataflow since
|
||||||
|
|
10
gst/gsturi.c
10
gst/gsturi.c
|
@ -521,10 +521,12 @@ get_element_factories_from_uri_protocol (const GstURIType type,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gst_uri_protocol_is_supported:
|
* gst_uri_protocol_is_supported:
|
||||||
* @type: Wether to check for a source or a sink
|
* @type: Whether to check for a source or a sink
|
||||||
* @protocol: Protocol that should be checkd for.
|
* @protocol: Protocol that should be checked for (e.g. "http" or "smb")
|
||||||
*
|
*
|
||||||
* Checks if an element exists that supports the given URI protocol.
|
* Checks if an element exists that supports the given URI protocol. Note
|
||||||
|
* that a positive return value does not imply that a subsequent call to
|
||||||
|
* gst_element_make_from_uri() is guaranteed to work.
|
||||||
*
|
*
|
||||||
* Returns: TRUE
|
* Returns: TRUE
|
||||||
*
|
*
|
||||||
|
@ -548,7 +550,7 @@ gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gst_element_make_from_uri:
|
* gst_element_make_from_uri:
|
||||||
* @type: Wether to create a source or a sink
|
* @type: Whether to create a source or a sink
|
||||||
* @uri: URI to create an element for
|
* @uri: URI to create an element for
|
||||||
* @elementname: Name of created element, can be NULL.
|
* @elementname: Name of created element, can be NULL.
|
||||||
*
|
*
|
||||||
|
|
|
@ -71,7 +71,7 @@ typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
|
||||||
/**
|
/**
|
||||||
* GstURIHandlerInterface:
|
* GstURIHandlerInterface:
|
||||||
* @parent: The parent interface type
|
* @parent: The parent interface type
|
||||||
* @get_type: Method to tell wether the element handles source or sink URI.
|
* @get_type: Method to tell whether 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.
|
||||||
* @set_uri: Method to set a new URI.
|
* @set_uri: Method to set a new URI.
|
||||||
|
|
|
@ -126,7 +126,7 @@
|
||||||
* The qos property will enable the quality-of-service features of the basesink
|
* The qos property will enable the quality-of-service features of the basesink
|
||||||
* which gather statistics about the real-time performance of the clock
|
* which gather statistics about the real-time performance of the clock
|
||||||
* synchronisation. For each buffer received in the sink, statistics are
|
* synchronisation. For each buffer received in the sink, statistics are
|
||||||
* gathered and a QOS event is send upstream with these numbers. This
|
* gathered and a QOS event is sent upstream with these numbers. This
|
||||||
* information can then be used by upstream elements to reduce their processing
|
* information can then be used by upstream elements to reduce their processing
|
||||||
* rate, for example.
|
* rate, for example.
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in a new issue