From 884c87d01fb5f79f4769c7d0fc0e45ba51cc79b7 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Fri, 22 Sep 2006 09:52:21 +0000 Subject: [PATCH] update docs Original commit message from CVS: update docs --- gst/videorate/gstvideorate.c | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/gst/videorate/gstvideorate.c b/gst/videorate/gstvideorate.c index e10a6c0..d4a9e36 100644 --- a/gst/videorate/gstvideorate.c +++ b/gst/videorate/gstvideorate.c @@ -19,21 +19,28 @@ /** * SECTION:element-videorate - * @short_description: adjusts the framerate of video + * @short_description: retimestamps and drops/duplicates video frames to + * match the source pad's framerate and create a perfect stream * * * - * This element converts video from one framerate to another. This operation - * is performed by dropping and duplicating frames, no fancy algorithm is - * used to interpolate frames (yet). + * This element takes an incoming stream of timestamped video frames. + * It will produce a perfect stream that matches the source pad's framerate. + * + * The correction is performed by dropping and duplicating frames, no fancy + * algorithm is used to interpolate frames (yet). * * * By default the element will simply negotiate the same framerate on its - * source and sink pad and will adjust timestamps/insert/drop frames in case - * the input stream is not respecting that framerate. + * source and sink pad. + * + * + * This operation is useful to link to elements that require a perfect stream. + * Typical examples are formats that do not store timestamps for video frames, + * but only store a framerate, like Ogg and AVI. * * - * A conversion to another framerate can be forced by using filtered caps on + * A conversion to a specific framerate can be forced by using filtered caps on * the source pad. * * @@ -59,9 +66,16 @@ * Decode an Ogg/Theora file and adjust the framerate to 15 fps before playing. * To create the test Ogg/Theora file refer to the documentation of theoraenc. * - * + * + * + * gst-launch -v v4lsrc ! videorate ! video/x-raw-yuv,framerate=25/2 ! theoraenc ! oggmux ! filesink location=v4l.ogg + * + * Capture video from a V4L device, and adjust the stream to 12.5 fps before + * encoding to Ogg/Theora. + * + * * - * Last reviewed on 2006-03-02 (0.10.4) + * Last reviewed on 2006-09-02 (0.10.11) */ #ifdef HAVE_CONFIG_H -- 2.7.4