Thibault Saunier
a87b4551a6
Port gtk-doc comments to their equivalent markdown syntax
...
Modernizing our documentation and preparing a possible move to hotdoc.
This commits also adds missing @title metadatas to all SECTIONs
2017-01-27 16:36:38 -03:00
Stefan Sauer
b23cb42ae9
docs: xref the free function and expand allocation query docs
...
Add xrefs for how to parse pool details from an allocation query.
2016-05-30 02:04:18 -07:00
Tim-Philipp Müller
c7bb52934e
query: fix compiler warning
...
C4146: unary minus operator applied to unsigned type, result still unsigned
2016-05-02 10:53:04 +01:00
Evan Nemerson
d11e657412
docs: annotate C examples as such
...
https://bugzilla.gnome.org/show_bug.cgi?id=731292
2016-02-15 17:45:15 +00:00
Wim Taymans
87ab2603da
query: fix docs
...
The allocation query has parameters with the meta API, not flags.
2015-12-04 11:57:45 +01:00
Nicolas Dufresne
7f6b11a5b2
allocation: Allow allocation pool without size
...
This allow proposing a number of buffers required even if the size
of buffer is unfixed. This is often the case for encoded formats.
2015-03-14 12:00:53 +00:00
Sebastian Dröge
4a5ce862a2
Improve and fix LATENCY query handling
...
This now follows the design docs everywhere.
https://bugzilla.gnome.org/show_bug.cgi?id=744106
2015-02-11 17:53:04 +02:00
Ognyan Tonchev
3f19a75d63
query: Add annotations to gst_query_add_allocation_pool()
...
https://bugzilla.gnome.org/show_bug.cgi?id=736736
2014-09-16 14:44:12 +03:00
Ognyan Tonchev
475f8e8cfb
query: add annotations to gst_query_set_nth_allocation_pool()
...
https://bugzilla.gnome.org//show_bug.cgi?id=736424
2014-09-12 10:15:46 +01:00
Evan Nemerson
5abc82e9f3
introspection: Assorted minor introspection and documentation fixes
...
https://bugzilla.gnome.org/show_bug.cgi?id=732534
2014-07-01 09:03:41 +02:00
Sebastian Dröge
db1e4422b6
gst: Store more basic type GTypes in variables
...
Micro optimization to change a function call to a variable access
for all our basic types.
2014-06-19 08:06:55 +02:00
Evan Nemerson
e10266e3f3
docs: convert NULL, TRUE, and FALSE to %NULL, %TRUE, and %FALSE
...
This should help improve documentation generated for
languages other than C.
https://bugzilla.gnome.org/show_bug.cgi?id=730961
2014-05-30 00:20:27 +01:00
Sebastian Dröge
3b331155e1
query: Add boolean to URI query to specify if a redirect is permanent or not
2014-04-28 10:03:15 +02:00
Tim-Philipp Müller
6eb6d9ec38
docs: remove outdated and pointless 'Last reviewed' lines from docs
...
They are very confusing for people, and more often than not
also just not very accurate. Seeing 'last reviewed: 2005' in
your docs is not very confidence-inspiring. Let's just remove
those comments.
2014-04-26 21:21:51 +01:00
Stefan Sauer
c068b225fe
docs: convert the examples to use gtk-doc markup, instead of docbook
...
The gtk-doc markup is less intrusive and better handled when creating docs for
language bindings. The titles (where used) where not adding much.
2014-02-27 18:11:35 +01:00
Sebastian Rasmussen
53ae1b2c9c
docs: Fix typos in function/object descriptions
...
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=720029
2013-12-07 17:11:12 +00:00
Olivier Crête
2a720d2e55
query: Fix gi annotations of gst_structure_new_custom()
2013-11-25 19:07:15 -05:00
Sebastian Dröge
921ab73340
context: Fix unit test for GstContext changes
2013-09-18 21:42:42 +02:00
Sebastian Dröge
51982d158a
message/query: Simplify CONTEXT messages/queries to only contain a single type
2013-09-17 13:50:08 +02:00
Arnaud Vrac
9819e48b92
query: return NULL when parsing uri redirection that was not set
...
https://bugzilla.gnome.org/show_bug.cgi?id=706160
2013-08-19 10:11:24 +02:00
Tim-Philipp Müller
104db59706
query: add Since markers for new API and add to exports file
2013-08-13 12:11:19 +01:00
Andoni Morales Alastruey
0d82493894
query: fix annotation for gst_query_parse_uri
2013-08-12 16:34:54 +02:00
Andoni Morales Alastruey
a70b5fc16a
query: add new redirection uri the URI query
2013-08-12 16:34:54 +02:00
Thiago Santos
210aaabb60
query: add some missing 'transfer none' gi annotations
...
The current documentation is controverse, while it states that the
returned value is valid only while the query is is valid, which presumes
a 'transfer none' policy. But the tooltip for the 'out' annotation
states the default is 'transfer-full'.
Add the missing 'transfer none' annotations to fix this.
2013-08-12 09:41:10 -03:00
Sjoerd Simons
cf3cbe76af
query: Clarify the estimated-total documentation
...
Tweak the documentation slightly to clarify that the estimated-total in
a a Buffering query the total remaining time of a download, not the
total time for the complete download. Also indicate the unit used.
https://bugzilla.gnome.org/show_bug.cgi?id=704934
2013-07-29 15:08:18 +02:00
Sebastian Dröge
3821cee574
query: Don't assert if no context is set in the query
2013-07-16 17:35:50 +02:00
Tim-Philipp Müller
472a64418a
query: sprinkle some Since 1.2 markers in docs
2013-07-16 14:48:19 +01:00
Sebastian Dröge
356ef049d3
query: Add gst_query_has_context_type()
2013-07-16 15:16:16 +02:00
Sebastian Dröge
b909061031
gst: Add new GstContext miniobject for sharing contexts in a pipeline
2013-03-29 16:40:21 +01:00
Sebastian Dröge
0936b506ab
query: gst_query_get_n_allocation_params() returns a new ref to the allocator
2013-03-07 11:47:04 +01:00
Sebastian Dröge
008b35f6ae
query: Add new API to remove allocation params and pools from the allocation query
2013-02-25 13:57:43 +01:00
Sebastian Dröge
e460be622d
query: Document that the first allocator in the allocation query should allow mapping to system memory
2013-02-25 13:24:33 +01:00
Tim-Philipp Müller
666c8c11c6
Fix FSF address
...
https://bugzilla.gnome.org/show_bug.cgi?id=687520
2012-11-03 20:44:48 +00:00
Wim Taymans
67a575ba08
query: buffering time left is in milliseconds
2012-10-11 17:09:29 +02:00
Mark Nauwelaerts
4af5e05309
query: adjust test logic for scheduling mode with flagS
2012-09-11 17:27:03 +02:00
Mark Nauwelaerts
d1567a82ac
query: add convenience API to query for scheduling mode and flags
2012-09-11 17:00:09 +02:00
Tim-Philipp Müller
a85991eeb8
baseparse, typefind: only activate in pull mode if upstream is seekable
...
Upstream might support pull mode, but only sequential pulls,
which isn't gonna do much for us.
https://bugzilla.gnome.org/show_bug.cgi?id=634927
2012-09-11 01:40:53 +01:00
Tim-Philipp Müller
8e946d5d16
query: fix gst_query_parse_nth_allocation_pool() annotation
...
It returns a ref to the pool.
2012-07-18 12:30:59 +01:00
Edward Hervey
d3ffa82639
Remove 0.10-related documentation and "Since" markers
2012-07-10 12:03:27 +02:00
Wim Taymans
82eb275ef9
query: copy structure in _add_allocation_meta()
...
Make gst_query_add_allocation_meta() take a copy of the passed caps instead of
taking ownership. This makes it easier for the caller in most cases because it
doesn't have to make a copy and deal with NULL values.
2012-07-10 10:31:00 +02:00
Wim Taymans
f362f643ac
memory: Make GstAllocator a GstObject
...
Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool.
Make a new gstallocator.c file. Make a GstAllocator subclass for the default
allocator.
2012-07-09 16:28:22 +02:00
Wim Taymans
3f80cb272e
query: use more generic structure for meta params
2012-07-06 11:49:47 +02:00
Wim Taymans
8bca7537e6
query: make find_allocation_meta method
...
Make gst_query_find_allocation_meta() that also return the index of the metadata
and replaces gst_query_has_allocation_meta().
2012-07-06 11:22:43 +02:00
Wim Taymans
8173622844
query: add flags to allocation query
...
Make it possible to add API specific flags to the ALLOCATION query. This makes
it possible to also check what kinds of subfeatures of the metadata API are
supported.
2012-07-06 11:00:38 +02:00
Sebastian Dröge
1b75a55b19
query: Remove the TOC query, it's not very useful now that we have sticky events
2012-07-05 12:34:41 +02:00
Wim Taymans
3b16efa1d1
miniobject: add lock functionality to GstMiniObject
...
Move the locking methods from GstMemory to GstMiniObject.
Add a miniobject flag to enable LOCKABLE objects. LOCKABLE objects can
use the lock/unlock API to control the access to the object.
Add a minobject flag that allows you to lock an object in readonly mode.
Modify the _is_writable() method to check the shared counter for LOCKABLE
objects. This allows us to control writability separately from the refcount for
LOCKABLE objects.
2012-07-05 11:19:16 +02:00
Tim-Philipp Müller
2c532aa821
toc: put toc directly into event/message/query structure
...
Now that TOCs are refcounted and have a GType, we can just
stuff a ref of the TOC directly into the various toc
event/message/query structures and get rid of lots of
cracktastic GstStructure <-> GstToc serialisation and
deserialisation code. We lose some TOC sanity checking
in the process, but that should really be done when
it's being created anyway.
2012-06-26 20:43:50 +01:00
Tim-Philipp Müller
1be934f0dd
miniobjects: pass copy, dispose and free function to gst_mini_object_init()
...
So mini objects don't have to poke into the GstMiniObject part
of the structure. Saves lines of code, and seems slightly cleaner.
We don't have proper OO hierarchies or methods here after all.
2012-06-23 20:02:02 +01:00
Wim Taymans
2cab15c9f6
docs: improve API docs
2012-06-15 12:57:24 +02:00
Tim-Philipp Müller
16e5684486
query: no need to store the size of the structure inside the structure
2012-06-15 10:26:57 +01:00