docs: Fix line numbers in tutorials 1 and 2

It seems that the lines for the C code for tutorials 1 and 2 are all
off.

The remaining tutorials seem uneffected.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5387>
This commit is contained in:
Leif Andersen 2023-09-24 23:21:56 -04:00 committed by GStreamer Marge Bot
parent 049859c2cb
commit d1aaf8ba0d
2 changed files with 22 additions and 22 deletions

View file

@ -76,7 +76,7 @@ We will skip GStreamer initialization, since it is the same as the
previous tutorial: previous tutorial:
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-2.c[13:16] }} {{ tutorials/basic-tutorial-2.c[17:20] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -97,7 +97,7 @@ more meaningful debug output). If you pass [NULL] for the name, however,
GStreamer will provide a unique name for you. GStreamer will provide a unique name for you.
For this tutorial we create two elements: a [videotestsrc] and For this tutorial we create two elements: a [videotestsrc] and
an [autovideosink]. There are no filter elements. Hence, the pipeline would an [autovideosink]. There are no filter elements. Hence, the pipeline would
look like the following: look like the following:
![](images/basic-concepts-pipeline.png) ![](images/basic-concepts-pipeline.png)
@ -118,7 +118,7 @@ platform-independent.
### Pipeline creation ### Pipeline creation
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-2.c[17:19] }} {{ tutorials/basic-tutorial-2.c[21:23] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -130,7 +130,7 @@ before they can be used, because it takes care of some clocking and
messaging functions. We create the pipeline with [gst_pipeline_new]\(). messaging functions. We create the pipeline with [gst_pipeline_new]\().
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-2.c[25:32] }} {{ tutorials/basic-tutorial-2.c[29:36] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -184,28 +184,28 @@ properties) or inquired to find out about the element's internal state
let us assume we have a Gst Element `source` with a property `pattern` let us assume we have a Gst Element `source` with a property `pattern`
The current state of a property can be fetched by either: The current state of a property can be fetched by either:
1. Accessing the property as an attribute of the `props` attribute of an 1. Accessing the property as an attribute of the `props` attribute of an
element. Ex: `_ = source.props.pattern` to print it on the screen element. Ex: `_ = source.props.pattern` to print it on the screen
2. Using the `get_property` method of the element. 2. Using the `get_property` method of the element.
Ex: `_ = source.get_property("pattern")` Ex: `_ = source.get_property("pattern")`
And properties can be set by one of three methods: And properties can be set by one of three methods:
1. Setting the property as an attribute of the `props` attribute. 1. Setting the property as an attribute of the `props` attribute.
Ex: `source.props.pattern = 1` or equivalently `source.props.pattern="snow"` Ex: `source.props.pattern = 1` or equivalently `source.props.pattern="snow"`
2. Using the `set_property` method of the element. 2. Using the `set_property` method of the element.
Ex: `source.set_property("pattern", 1)` or equivalently `source.set_property("pattern", "snow")` Ex: `source.set_property("pattern", 1)` or equivalently `source.set_property("pattern", "snow")`
3. Using the `Gst.util_set_object_arg()` method. This mode also allows you to 3. Using the `Gst.util_set_object_arg()` method. This mode also allows you to
pass Gst Caps and other structures. Ex: `Gst.util_set_object_arg(source, "pattern", "snow")`, pass Gst Caps and other structures. Ex: `Gst.util_set_object_arg(source, "pattern", "snow")`,
or equivalently, `Gst.util_set_object_arg(source, "pattern", 1)` or equivalently, `Gst.util_set_object_arg(source, "pattern", 1)`
Note: In all three methods of setting a property, if a string is passed as Note: In all three methods of setting a property, if a string is passed as
the value to set, it has to be the serialized version of a flag or value the value to set, it has to be the serialized version of a flag or value
(using [gst_value_serialize]\()) (using [gst_value_serialize]\())
{{ END_LANG.md }} {{ END_LANG.md }}
Coming back to what's in the example above, Coming back to what's in the example above,
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-2.c[33:35] }} {{ tutorials/basic-tutorial-2.c[37:39] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -229,7 +229,7 @@ of the tutorial is very similar to the previous one, but we are going to
add more error checking: add more error checking:
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-2.c[36:43] }} {{ tutorials/basic-tutorial-2.c[40:47] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -242,7 +242,7 @@ details are given in [Basic tutorial 3: Dynamic
pipelines]. pipelines].
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-2.c[44:75] }} {{ tutorials/basic-tutorial-2.c[48:79] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -354,4 +354,4 @@ It has been a pleasure having you here, and see you soon!
[GError]: GError [GError]: GError
[vertigotv]: vertigotv [vertigotv]: vertigotv
[videoconvert]: videoconvert [videoconvert]: videoconvert
[gst_pipeline_new]: gst_pipeline_new [gst_pipeline_new]: gst_pipeline_new

View file

@ -75,7 +75,7 @@ See how [Basic tutorial 12: Streaming] solves this issue.
Let's review these lines of code and see what they do: Let's review these lines of code and see what they do:
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-1.c[9:11] }} {{ tutorials/basic-tutorial-1.c[13:15] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -98,7 +98,7 @@ benefit from the GStreamer standard command-line options (more on this
in [Basic tutorial 10: GStreamer tools]) in [Basic tutorial 10: GStreamer tools])
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-1.c[13:17] }} {{ tutorials/basic-tutorial-1.c[16:21] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -155,7 +155,7 @@ only thing we are doing in this example is exiting on error, so do not
expect much feedback. expect much feedback.
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-1.c[18:20] }} {{ tutorials/basic-tutorial-1.c[22:24] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -172,7 +172,7 @@ In this line, [gst_element_set_state]\() is setting `pipeline` (our only
element, remember) to the `PLAYING` state, thus initiating playback. element, remember) to the `PLAYING` state, thus initiating playback.
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-1.c[21:26] }} {{ tutorials/basic-tutorial-1.c[25:30] }}
{{ END_LANG.md }} {{ END_LANG.md }}
{{ PY.md }} {{ PY.md }}
@ -198,7 +198,7 @@ Before terminating the application, though, there is a couple of things
we need to do to tidy up correctly after ourselves. we need to do to tidy up correctly after ourselves.
{{ C+JS_FALLBACK.md }} {{ C+JS_FALLBACK.md }}
{{ tutorials/basic-tutorial-1.c[27:33] }} {{ tutorials/basic-tutorial-1.c[37:43] }}
Always read the documentation of the functions you use, to know if you Always read the documentation of the functions you use, to know if you
should free the objects they return after using them. should free the objects they return after using them.
@ -268,4 +268,4 @@ It has been a pleasure having you here, and see you soon!
[gst_parse_launch]: gst_parse_launch [gst_parse_launch]: gst_parse_launch
[playbin]: playbin [playbin]: playbin
[gst-launch-1.0]: tools/gst-launch.md [gst-launch-1.0]: tools/gst-launch.md
[GST_STATE_NULL]: GST_STATE_NULL [GST_STATE_NULL]: GST_STATE_NULL