GNOME Bugzilla – Bug 734190
check: Adding documentation to GstCheck gst_check_setup_sink function
Last modified: 2014-09-12 11:15:05 UTC
Created attachment 282358 [details] [review] Patch that adds documentation to GstCheck Going on with the work described on #734142. I think the general description of the GstCheck module also needs some love, really wanting to go to heaven ;-).
No love for documentation ? :-(
Review of attachment 282358 [details] [review]: ::: libs/gst/check/gstcheck.c @@ +424,3 @@ * + * Creates a new sink pad (based on the given @tmpl) and links it to the given @element src pad (the pad that matches the given @name). + * This sink pad can be used to check the output of @element (see #gst_pad_add_probe on more details about how you inspect data on a #GstPad). Usually the tests are setting chain/event/query functions on these pads instead
Sebastian, I understand, i could add that they can also be used for these too. But i used to inspect the output of the element. The only other functions that i found on GstCheck that can check the output of the element for me required me to pass the name of the element, the input and the expected output. I cant cover the case where i want to configure the properties of my element before injecting the input. So i used the sinkpad to check the data that my element was producing. For the use case that i described, is there a better function on GstCheck that i missed ?
You can set event/chain/query functions on the pads created by this GstCheck API. And that's what most of the tests are doing
Oh sorry. Now i feel silly :P. I focused on the query/event and didn't noticed the *chain*. Of course, if i set the chain function i can get the produced data. I looked at some tests (like the volume element) and didn't found out these kind of thing. But it really seems to be a good idea. I'm going to fix the documentation now. Thanks Sebastian
Created attachment 285517 [details] [review] Improved documentation to the gst_check_setup_sink_pad function Pretty much the same, just documenting that is better to use the chain/query/event functions instead of probing.
commit 076b83208af17b10d9e0aa6cecc42ad998427e07 Author: Tiago <tiagokatcipis@gmail.com> Date: Fri Sep 5 18:36:02 2014 +0000 check: Adding documentation to the gst_check_setup_sink_pad_by_name function https://bugzilla.gnome.org/show_bug.cgi?id=734190