design: Also mention that the order of the filter caps is important

This commit is contained in:
Sebastian Dröge 2012-06-06 09:59:55 +02:00
parent 15d85b9edb
commit 27e4faa147

View file

@ -34,7 +34,9 @@ appropriate GstCaps for the data transfer.
The CAPS query works recursively, elements should take their peers into
consideration when constructing the possible caps. Because the result caps
can be very large, the filter can be used to restrict the caps. Only the
caps that match the filter will be returned as the result caps.
caps that match the filter will be returned as the result caps. The
order of the filter caps gives the order of preference of the caller and
should be taken into account for the returned caps.
(in) "filter", GST_TYPE_CAPS (default NULL)
- a GstCaps to filter the results against