diff options
| author | Thijs Vermeir <thijsvermeir@gmail.com> | 2009-01-23 21:46:13 +0100 |
|---|---|---|
| committer | Thijs Vermeir <thijsvermeir@gmail.com> | 2009-01-24 14:21:56 +0100 |
| commit | 56b3efb077bba2189f5e128782683b75055360d5 (patch) | |
| tree | 9ed7b183fbbfb0c80eb6906fc7e27ef30aacab70 /gst/videocrop/gstaspectratiocrop.c | |
| parent | 0d34f33ac448d266fb1cdb322d7fedc516a74444 (diff) | |
Add documentation for aspectratiocrop
Diffstat (limited to 'gst/videocrop/gstaspectratiocrop.c')
| -rw-r--r-- | gst/videocrop/gstaspectratiocrop.c | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/gst/videocrop/gstaspectratiocrop.c b/gst/videocrop/gstaspectratiocrop.c index 2c0407b8..2cdd51ca 100644 --- a/gst/videocrop/gstaspectratiocrop.c +++ b/gst/videocrop/gstaspectratiocrop.c @@ -17,6 +17,21 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-aspectratiocrop + * @see_also: #GstVideoCrop + * + * This element crops video frames to a specified aspect-ratio. + * + * If the aspect-ratio is already correct, the element will operate in pass-through mode. + * + * <refsect2> + * <title>Example launch line</title> + * |[gst-launch -v videotestsrc ! video/x-raw-rgb,height=640,width=480 ! aspectratiocrop aspect-ratio=16/9 ! ximagesink]| + * This pipeline generates a videostream in 4/3 and crops it to 16/9. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |