mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

design: messages: add missing markup and fix grammar issues

Browse source
This commit is contained in:
Reynaldo H. Verdejo Pinochet 2016-12-27 12:28:30 -08:00
parent ef2e599250
commit 3b3837aa33
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
markdown/design/messages.md
View file

@ -3,13 +3,13 @@
Messages are refcounted lightweight objects to signal the application of Messages are refcounted lightweight objects to signal the application of
pipeline events. pipeline events.
Messages are implemented as a subclass of GstMiniObject with a generic Messages are implemented as a subclass of `GstMiniObject` with a generic
GstStructure as the content. This allows for writing custom messages `GstStructure` as the content. This allows for writing custom messages
without requiring an API change while allowing a wide range of different without requiring an API change while allowing a wide range of different
types of messages. types of messages.
Messages are posted by objects in the pipeline and are passed to the Messages are posted by objects in the pipeline and are passed to the
application using the GstBus (See also [gstbus](design/gstbus.md) application using the `GstBus` (See also [gstbus](design/gstbus.md)
and [gstpipeline](design/gstpipeline.md)). and [gstpipeline](design/gstpipeline.md)).
## Message types ## Message types
@ -29,7 +29,7 @@ some other non fatal event. The pipeline continues streaming after a warning.
**`GST_MESSAGE_INFO`**: An element produced an informational message. **`GST_MESSAGE_INFO`**: An element produced an informational message.
**`GST_MESSAGE_TAG`**: An element decoded metadata about the stream. The **`GST_MESSAGE_TAG`**: An element decoded metadata about the stream. The
message carries a GstTagList with the tag information. message carries a `GstTagList` with the tag information.
**`GST_MESSAGE_BUFFERING`**: An element is buffering data and that could **`GST_MESSAGE_BUFFERING`**: An element is buffering data and that could
potentially take some time. This message is typically emitted by elements that potentially take some time. This message is typically emitted by elements that
@ -74,7 +74,7 @@ element's documentation
**`GST_MESSAGE_SEGMENT_START`**: An element started playback of a new **`GST_MESSAGE_SEGMENT_START`**: An element started playback of a new
segment. This message is not forwarded to applications but is used internally segment. This message is not forwarded to applications but is used internally
to schedule SEGMENT_DONE messages. to schedule `SEGMENT_DONE` messages.
**`GST_MESSAGE_SEGMENT_DONE`**: An element or bin completed playback of **`GST_MESSAGE_SEGMENT_DONE`**: An element or bin completed playback of
a segment. This message is only posted on the bus if a SEGMENT seek is a segment. This message is only posted on the bus if a SEGMENT seek is
@ -98,7 +98,7 @@ the state of the pipeline they are in. A typical use case would be an audio
sink that requests the pipeline to pause in order to play a higher priority sink that requests the pipeline to pause in order to play a higher priority
stream. stream.
**`GST_MESSAGE_STEP_START`**: A Stepping operation has started. **`GST_MESSAGE_STEP_START`**: A stepping operation has started.
**`GST_MESSAGE_QOS`**: A buffer was dropped or an element changed its **`GST_MESSAGE_QOS`**: A buffer was dropped or an element changed its
processing strategy for Quality of Service reasons. processing strategy for Quality of Service reasons.