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

docs: Minor updates to Plugin Writer's Guide

Browse source 
boiler.md:
    Update meson command to avoid warning.

states.md:
    Clarify that a sink element accepting only one buffer only happens when paused.
    Link text duplicated normal text.

args.md:
    A valid range is between values, not between ranges.  Reword for clarity.

testapp.md:
    Clarify linking refers to the pipeline, not build time compilation and linking.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5939>
This commit is contained in:
Paul Fee 2024-01-19 11:29:17 +00:00 committed by GStreamer Marge Bot
parent f50b43c83b
commit 30d34a99f1
4 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
subprojects/gst-docs/markdown/plugin-development/basics/args.md
View file

@ -96,8 +96,8 @@ applications will use these properties and will display a
user-controllable widget with which these properties can be changed. user-controllable widget with which these properties can be changed.
This means that - for the property to be as user-friendly as possible - This means that - for the property to be as user-friendly as possible -
you should be as exact as possible in the definition of the property. you should be as exact as possible in the definition of the property.
Not only in defining ranges in between which valid properties can be Not only in defining ranges of valid property values (for integers,
located (for integers, floats, etc.), but also in using very descriptive floats, etc.), but also in using very descriptive
(better yet: internationalized) strings in the definition of the (better yet: internationalized) strings in the definition of the
property, and if possible using enums and flags instead of integers. The property, and if possible using enums and flags instead of integers. The
GObject documentation describes these in a very complete way, but below, GObject documentation describes these in a very complete way, but below,

2
subprojects/gst-docs/markdown/plugin-development/basics/boiler.md
View file

@ -96,7 +96,7 @@ The last command creates two files: `gstmyfilter.c` and `gstmyfilter.h`.
> It is recommended that you create a copy of the `gst-plugin` directory > It is recommended that you create a copy of the `gst-plugin` directory
> before continuing. > before continuing.
Now one needs to run `meson build` from the parent directory to bootstrap the Now one needs to run `meson setup build` from the parent directory to bootstrap the
build environment. After that, the project can be built and installed using the build environment. After that, the project can be built and installed using the
well known `ninja -C build` commands. well known `ninja -C build` commands.

10
subprojects/gst-docs/markdown/plugin-development/basics/states.md
View file

@ -38,8 +38,8 @@ should *not* be allocated in this state.
`GST_STATE_PAUSED` is the state in which an element is ready to accept `GST_STATE_PAUSED` is the state in which an element is ready to accept
and handle data. For most elements this state is the same as PLAYING. and handle data. For most elements this state is the same as PLAYING.
The only exception to this rule are sink elements. Sink elements only The only exception to this rule are sink elements. Paused sink elements
accept one single buffer of data and then block. At this point the only accept one buffer of data and then block. At this point the
pipeline is 'prerolled' and ready to render data immediately. pipeline is 'prerolled' and ready to render data immediately.
`GST_STATE_PLAYING` is the highest state that an element can be in. For `GST_STATE_PLAYING` is the highest state that an element can be in. For
@ -51,9 +51,9 @@ card or render video pictures to an image sink.
## Managing filter state ## Managing filter state
If at all possible, your element should derive from one of the new base If at all possible, your element should derive from one of the
classes ([Pre-made base classes](plugin-development/element-types/base-classes.md)). There are [pre-made base classes](plugin-development/element-types/base-classes.md).
ready-made general purpose base classes for different types of sources, These are ready-made general purpose base classes for different types of sources,
sinks and filter/transformation elements. In addition to those, sinks and filter/transformation elements. In addition to those,
specialised base classes exist for audio and video elements and others. specialised base classes exist for audio and video elements and others.

6
subprojects/gst-docs/markdown/plugin-development/basics/testapp.md
View file

@ -4,8 +4,8 @@ title: Building a Test Application
# Building a Test Application # Building a Test Application
Often, you will want to test your newly written plugin in an as small Often, you will want to test your newly written plugin in as small
setting as possible. Usually, `gst-launch-1.0` is a good first step at a setting as possible. Usually, `gst-launch-1.0` is a good first step at
testing a plugin. If you have not installed your plugin in a directory testing a plugin. If you have not installed your plugin in a directory
that GStreamer searches, then you will need to set the plugin path. that GStreamer searches, then you will need to set the plugin path.
Either set GST\_PLUGIN\_PATH to the directory containing your plugin, or Either set GST\_PLUGIN\_PATH to the directory containing your plugin, or
@ -38,7 +38,7 @@ a `fakesink` element at the end of the pipeline to dump your data to the
stdout (in order to do this, set the `dump` property to TRUE). Lastly, stdout (in order to do this, set the `dump` property to TRUE). Lastly,
you can use valgrind to check for memory errors. you can use valgrind to check for memory errors.
During linking, your test application can use filtered caps as a way to During pipeline linking, your test application can use filtered caps as a way to
drive a specific type of data to or from your element. This is a very drive a specific type of data to or from your element. This is a very
simple and effective way of checking multiple types of input and output simple and effective way of checking multiple types of input and output
in your element. in your element.