AW: forwarded screen stutters every several seconds

[Thornton, Keith]

Hi Graham
If you read the documentation which can be found using a google search i.e. the Users manual, you can read that the parameters can be found using gst-inspect-1.0
The parameters are then relevant to the version you have installed.
I have lost a lot of time over the years due to google searches revealing documentation which is out of date or not consistent with the version I am using.

-----Ursprüngliche Nachricht-----
Von: gstreamer-devel [mailto:gstreamer-devel-bounces at lists.freedesktop.org] Im Auftrag von Graham Leggett
Gesendet: Montag, 18. Januar 2016 09:50
An: Nicolas Dufresne; Discussion of the development of and with GStreamer
Betreff: Re: forwarded screen stutters every several seconds

On 17 Jan 2016, at 11:57 PM, Nicolas Dufresne <nicolas.dufresne at collabora.com> wrote:

> The documentation for element properties is obtained with gst-inspect- 
> 1.0. As you can see by inspecting udpsrc, you'll read:
> 
>   "buffer-size         : Size of the kernel receive buffer in bytes"
> 
> So this one is properly documented. If though you come a cross a 
> property with non-obvious or undocumented units, you should consider 
> proposing a patch (or at least filing a bug so someone can fix it).

Keep in mind that the use of a special program to generate developer documentation is non-obvious to people coming from the outside, what people are really expecting is documentation that can be found at a URL.

That’s not to say that generating the docs from the code is a bad idea, the key thing is that this needs to interface somehow with the way ordinary end users expect to find documentation, ie at the end of a google search.

Regards,
Graham
—

_______________________________________________
gstreamer-devel mailing list
gstreamer-devel at lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel