diff options
| author | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2010-06-17 09:33:43 +0100 |
|---|---|---|
| committer | Tim-Philipp Müller <tim.muller@collabora.co.uk> | 2010-06-17 09:33:43 +0100 |
| commit | 8bfc2cc0c89bad38baed0278994e94d4cf5b2553 (patch) | |
| tree | 1f200cb309fb598f28a34cc2054cfcaf09b46e08 /docs/manual | |
| parent | 80ece8a4be59e1551f6b899e6b1f4fc5668dd546 (diff) | |
manual: fix another typo and some inaccuracies
Fix a wrong statement and flesh out section on messages and queries
a bit.
Diffstat (limited to 'docs/manual')
| -rw-r--r-- | docs/manual/intro-basics.xml | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/docs/manual/intro-basics.xml b/docs/manual/intro-basics.xml index 8214e2ff3..82ce35a93 100644 --- a/docs/manual/intro-basics.xml +++ b/docs/manual/intro-basics.xml @@ -108,32 +108,38 @@ <itemizedlist> <listitem> <para> - <emphasis>buffers</emphasis>: are objects for passing streaming data + <emphasis>buffers</emphasis> are objects for passing streaming data between elements in the pipeline. Buffers always travel from sources to sinks (downstream). </para> </listitem> <listitem> <para> - <emphasis>events</emphasis>: are objects send between elements or from + <emphasis>events</emphasis> are objects sent between elements or from the application to elements. Events can travel upstream and downstream. Downstream events can be synchronised to the data flow. </para> </listitem> <listitem> <para> - <emphasis>messages</emphasis>: are objects send from elements over the - bus to the application. Messages can be received synchronously, but - then from the streaming thread context of the sender or asynchronously - marshalled to the main thread of the application. + <emphasis>messages</emphasis> are objects posted by elements on + the pipeline's message bus, where they will be held for collection + by the application. Messages can be intercepted synchronously from + the streaming thread context of the element posting the message, but + are usually handled asynchronously by the application from the + application's main thread. Messages are used to transmit information + such as errors, tags, state changes, buffering state, redirects etc. + from elements to the application in a thread-safe way. </para> </listitem> <listitem> <para> - <emphasis>queries</emphasis>: allow application to request information - from the pipeline. Queries are answered synchronously. Also elements - can use queries. They can be used both ways, but most common are - downstream queries. + <emphasis>queries</emphasis> allow applications to request information + such as duration or current playback position from the pipeline. + Queries are always answered synchronously. Elements can also use + queries to request information from their peer elements (such as the + file size or duration). They can be used both ways within a pipeline, + but upstream queries are more common. </para> </listitem> </itemizedlist> |