Tim-Philipp Müller
caa608e5c0
docs: random: clean up outdated documents
...
Most of these are only of historical interest, and for that it's
fine if they're maintained in the git history. They're confusing
for anyone stumbling across them expecting documentation relating
to current versions of GStreamer.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/824 >
2021-05-16 12:28:53 +01:00
Seungha Yang
69e6cd773a
clocksync: Add a new property "sync-to-first" for automatic ts-offset setup
...
Add a new property so that clocksync can setup "ts-offset" value
based on the first buffer and pipeline's running time when the
first arrived. Newly update "ts-offset" in this case would be
a value that allows outputting the first buffer without clock waiting.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/702 >
2021-03-18 14:22:44 +00:00
Philippe Normand
e02902a783
concat: Fix active-pad property doc typo
...
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/727 >
2021-01-07 11:57:51 +00:00
Olivier Crête
3d5c849a6c
identity: Add a stats property
...
This is inspired by the stats on rtpjitterbuffer, it's useful
to be able to get some simple stats out of the pipeline without having
to write yet another pad probe.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/615 >
2020-10-16 15:43:56 +00:00
Sebastian Dröge
00fd649640
valve: Add modes to forward sticky events when dropping and to convert buffers into gap events
...
Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer/-/issues/587
Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer/-/issues/84
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/594 >
2020-09-09 06:16:51 +00:00
Seungha Yang
6ca939506b
docs: Specify UTF-8 encoding everywhere
...
Otherwise some non-English character might be broken depending on
OS and/or locale.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/545 >
2020-06-25 17:25:37 +00:00
Mathieu Duponchelle
996743ed39
gst-hotdoc-plugins-scanner: serialize interfaces
2020-06-23 11:58:56 -04:00
Mathieu Duponchelle
8c753a30e5
gst-hotdoc-plugins-scanner: don't instantiate base classes
2020-06-23 11:58:56 -04:00
Mathieu Duponchelle
ef86d00ba9
gst-hotdoc-plugins-scanner: serialize parents in hierarchy when needed
2020-06-23 11:58:56 -04:00
Thibault Saunier
1152fb33a4
docs: Document signals and properties only for current type
2020-06-23 11:58:55 -04:00
Thibault Saunier
c1c035bd65
doc: Stop documenting properties from parents
2020-06-23 11:58:55 -04:00
Thibault Saunier
1fbfb4291f
doc: Stop recording if building from source/release in plugin cache
...
Closes: https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/537
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/537 >
2020-06-19 19:13:13 +01:00
Thibault Saunier
f63b5cbade
docs: Update plugins cache
2020-06-10 13:37:08 +00:00
Thibault Saunier
34db244d46
docs: Fix the way we mark properties mutability
...
When nothing is specified, we should default to NULL, not PLAYING
2020-06-10 13:37:08 +00:00
Thibault Saunier
3db985548c
docs: Update plugins cache
2020-06-09 11:45:07 -04:00
Seungha Yang
c092dd40ca
doc: Add GstObject specific GParamFlags
...
Document "controllable", "mutable-{ready, paused, playing}" and
"conditonally-available" GParamFlags
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/283 >
2020-06-08 14:18:09 +00:00
Sebastian Dröge
5e8e847687
docs: Prevent potential NULL pointer dereference when serializing plugin object types
...
CID 1464007
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/516 >
2020-06-06 08:14:39 +00:00
Mathieu Duponchelle
169abc86e9
padtemplate: expose getters and setters "documentation caps"
...
This can be used in elements where the caps of pad templates
are dynamically generated and dependent on the environment.
An example is x265enc.
2020-06-06 00:38:29 +02:00
Mathieu Duponchelle
0c1ce6e8c4
utils: expose GstPluginAPIFlags
...
These can be passed to gst_type_mark_as_plugin_api, to inform
plugin cache generation.
For now a single flag is specified, "IGNORE_ENUM_MEMBERS", it
can be used for dynamically generated enums to avoid documenting
environment-specific enumeration members. An example is
GstX265EncTune.
2020-06-06 00:38:29 +02:00
Thibault Saunier
31e68eb26a
doc: Require hotdoc >= 0.11.0
2020-06-04 15:49:24 -04:00
Sebastian Dröge
6e50c6c6fb
docs: Don't include GObject and GstPipeline signals
...
They're already documented from elsewhere.
2020-06-04 15:49:24 -04:00
Sebastian Dröge
3e37b0ab82
docs: Update gst_plugins_cache.json
2020-06-04 15:49:24 -04:00
Sebastian Dröge
65e266fe6e
docs: Store all non-element types in a separate other-types array
...
And also make sure to not duplicate them.
2020-06-04 15:49:24 -04:00
Sebastian Dröge
994d74faf4
docs: Use gst_type_is_plugin_api() for deciding whether a type should be included in the docs
2020-06-04 15:49:24 -04:00
Sebastian Dröge
b705ab4de6
docs: Don't try to print pad templates of non-GstElement types
2020-06-04 15:49:23 -04:00
Sebastian Dröge
8e28799303
docs: Print object/flag/enum type information in a more structured way and in more places
...
Custom types are printed now for signal parameters/return value and properties, and more consistently.
Fixes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/issues/59
2020-06-04 15:49:23 -04:00
Sebastian Dröge
d0e430a690
docs: Add boolean field for readability of properties
...
Some properties are write-only.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/496 >
2020-05-20 12:02:08 +00:00
Stéphane Cerveau
618c37fca4
docs: update moving-plugins to use gitlab and meson
...
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/493 >
2020-05-19 10:21:28 +00:00
Sebastian Dröge
a3562b0d2a
docs: Add list of interfaces implemented by elements to the docs
...
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/486 >
2020-05-15 11:46:28 +00:00
Sebastian Dröge
70469b4a4c
docs: Update gst_plugins_cache.json
...
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/474 >
2020-05-10 11:37:45 +03:00
Sebastian Dröge
0eefad2967
docs: Output JSON files with UTF-8 encoding
...
Otherwise non-ASCII characters are encoded as \uXXXX.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/474 >
2020-05-10 11:35:53 +03:00
Thibault Saunier
416d4a13e0
doc: Add signal flags information in the plugin cache
...
Updating the plugin cache file
Same behavior as g-ir as the signal flags don't have a GType associated.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/463 >
2020-05-05 13:40:50 -04:00
Sebastian Dröge
ed1022fa81
Use gst_object_unref() / gst_object_clear() instead of the GObject ones
...
To allow the refcounting tracer to work better. In childproxy/iterator
these might be plain GObjects but gst_object_unref() also works on them.
In other places where it is never GstObject, g_object_unref() is kept.
2020-04-20 16:28:52 +00:00
Matthew Waters
f27987a415
docs/running: be consistent with ordering of full-stops inside ``
...
Everywhere else places the period outside.
2020-03-24 15:00:03 +11:00
Jan Schmidt
81d55fb479
clocksync: Add new clocksync element
...
The clocksync element is a generic element that can be
placed in a pipeline to synchronise passing buffers to the
clock at that point. This is similar to 'identity sync=true',
but because it isn't GstBaseTransform-based, it can process
GstBufferLists without breaking them into separate GstBuffers
2020-02-26 16:36:29 +00:00
Seungha Yang
66819febd9
docs: Fix bold markdown syntax for GST_DEBUG_NO_COLOR
...
Fixing markdown syntax
2020-02-13 15:43:45 +09:00
Seungha Yang
52706146f5
pluginfeature: Allow updating initial rank of plugin feature
...
Introducing "GST_PLUGIN_FEATURE_RANK" environment variable in order for users
to adjust rank of plugin(s) via environment.
A "feature" and "rank" key-value pair should be separable by ":",
and each key-value pair is recognized per "," delimiters. The rank
can be a numerical value or one of pre-defined rank values
such as "NONE", "MARGINAL", "SECONDARY", and "PRIMARY" in case-insensitive manner.
In addition to pre-defined { NONE, MARGINAL, SECONDARY, PRIMARY },
"MAX" can be passed to key value used to ensure having a higher rank
than other plugin features.
Example)
- GST_PLUGIN_FEATURE_RANK=qtdemux:256,h264parse:NONE
Set rank of qtdemux plugin to 256 (primary) and 0 (none) for h264parse.
2019-12-26 19:49:00 +00:00
Thibault Saunier
06e54399ba
hotdoc: Add missing json escaping
...
Fixes https://gitlab.freedesktop.org/gstreamer/gst-docs/issues/50
2019-11-13 11:37:22 +00:00
Tim-Philipp Müller
10d9e18f02
Remove autotools build system
2019-10-13 16:10:42 +01:00
Aaron Boxer
509f6201e1
documentation: fix a number of typos
2019-10-06 11:12:11 -04:00
Thibault Saunier
7a2d32abda
multiqueue: Fix possible NULL pointer dereferencing
...
In the hotdoc inspector for example, pads are instantiated with
g_object_new, other code paths to get/set properties already make
that check.
And update doc cache
2019-07-02 17:27:32 -04:00
Mathieu Duponchelle
b22a0c3873
docs: unprefix subproject paths
2019-06-01 02:37:26 +02:00
Thibault Saunier
f040102d45
docs: Add tracers support
2019-05-31 18:53:43 -04:00
Thibault Saunier
3635a6a98b
docs: Document pad types
...
And update the plugins doc cache
2019-05-25 10:56:50 -04:00
Matthew Waters
29557fe623
docs: add coretracers to the list of plugins
2019-05-18 02:41:43 +00:00
Thibault Saunier
0faab7d9b8
docs: Stop building the doc cache by default
...
Fixes https://gitlab.freedesktop.org/gstreamer/gst-docs/issues/36
2019-05-16 18:22:20 +00:00
Thibault Saunier
042f6d5def
docs: Update diplayed plugins filename something stable
2019-05-16 18:22:20 +00:00
Thibault Saunier
6009b82d65
hotdoc: Let the the registry inspect in forks
...
So that the whole process doesn't segfault if something bad happens while inspecting
2019-05-16 18:22:20 +00:00
Thibault Saunier
816710d17c
docs: Use the MESON_BUILD_ROOT env variable in the plugins cache generator
2019-05-16 18:22:20 +00:00
Thibault Saunier
56d01406bc
docs: Do not pass the json through stdout
...
Unicode encoding breaks on windows when doing so
2019-05-16 18:22:20 +00:00