summaryrefslogtreecommitdiff
path: root/doc/man/en
diff options
context:
space:
mode:
authorDaniel Caujolle-Bert <f1rmb@users.sourceforge.net>2001-10-14 23:19:59 +0000
committerDaniel Caujolle-Bert <f1rmb@users.sourceforge.net>2001-10-14 23:19:59 +0000
commit15d50842081823d2a124f0939cb8595c379c746f (patch)
tree845e27d65c4571468a9f6d65db4d8a4d47ab61fd /doc/man/en
parent482d6973c539f1c571e3bfc8334cccacf7c9678a (diff)
downloadxine-lib-15d50842081823d2a124f0939cb8595c379c746f.tar.gz
xine-lib-15d50842081823d2a124f0939cb8595c379c746f.tar.bz2
Update xine.h doxygen comments. Use constants for aspect ratio in
vo drivers. CVS patchset: 812 CVS date: 2001/10/14 23:19:59
Diffstat (limited to 'doc/man/en')
-rw-r--r--doc/man/en/man3/ao_driver_t.32
-rw-r--r--doc/man/en/man3/audio_cap.32
-rw-r--r--doc/man/en/man3/audio_group.32
-rw-r--r--doc/man/en/man3/audio_prop.32
-rw-r--r--doc/man/en/man3/autoplay_group.32
-rw-r--r--doc/man/en/man3/browse_group.32
-rw-r--r--doc/man/en/man3/build_info.310
-rw-r--r--doc/man/en/man3/cfg_data_t.32
-rw-r--r--doc/man/en/man3/config_group.32
-rw-r--r--doc/man/en/man3/config_values_s.32
-rw-r--r--doc/man/en/man3/config_values_t.32
-rw-r--r--doc/man/en/man3/demux_strategy.32
-rw-r--r--doc/man/en/man3/event_group.32
-rw-r--r--doc/man/en/man3/loadplugins_group.32
-rw-r--r--doc/man/en/man3/mrl_t.32
-rw-r--r--doc/man/en/man3/mrl_types.32
-rw-r--r--doc/man/en/man3/status_group.32
-rw-r--r--doc/man/en/man3/ui_callbacks.32
-rw-r--r--doc/man/en/man3/version_group.36
-rw-r--r--doc/man/en/man3/video_cap.32
-rw-r--r--doc/man/en/man3/video_group.32
-rw-r--r--doc/man/en/man3/video_prop.32
-rw-r--r--doc/man/en/man3/video_ratio.32
-rw-r--r--doc/man/en/man3/visual_types.32
-rw-r--r--doc/man/en/man3/vo_driver_s.32
-rw-r--r--doc/man/en/man3/vo_driver_t.32
-rw-r--r--doc/man/en/man3/vo_frame_t.32
-rw-r--r--doc/man/en/man3/vo_overlay_t.32
-rw-r--r--doc/man/en/man3/xine.h.333
-rw-r--r--doc/man/en/man3/xine_api.3151
-rw-r--r--doc/man/en/man3/xine_init.32
-rw-r--r--doc/man/en/man3/xine_management.32
-rw-r--r--doc/man/en/man3/xine_t.32
-rw-r--r--doc/man/en/man3/xine_version.32
34 files changed, 216 insertions, 44 deletions
diff --git a/doc/man/en/man3/ao_driver_t.3 b/doc/man/en/man3/ao_driver_t.3
index d24cff9ab..bb58cb105 100644
--- a/doc/man/en/man3/ao_driver_t.3
+++ b/doc/man/en/man3/ao_driver_t.3
@@ -1,4 +1,4 @@
-.TH "ao_driver_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "ao_driver_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/audio_cap.3 b/doc/man/en/man3/audio_cap.3
index 9c09a8369..92fa9fc90 100644
--- a/doc/man/en/man3/audio_cap.3
+++ b/doc/man/en/man3/audio_cap.3
@@ -1,4 +1,4 @@
-.TH "audio driver capabilities" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "audio driver capabilities" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/audio_group.3 b/doc/man/en/man3/audio_group.3
index 1d06aa62d..20e328fae 100644
--- a/doc/man/en/man3/audio_group.3
+++ b/doc/man/en/man3/audio_group.3
@@ -1,4 +1,4 @@
-.TH "Audio." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Audio." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/audio_prop.3 b/doc/man/en/man3/audio_prop.3
index 3216fc780..cd9fb5e65 100644
--- a/doc/man/en/man3/audio_prop.3
+++ b/doc/man/en/man3/audio_prop.3
@@ -1,4 +1,4 @@
-.TH "Constants for the get/set properties functions." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Constants for the get/set properties functions." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/autoplay_group.3 b/doc/man/en/man3/autoplay_group.3
index 21c4a0d04..c0ba2d407 100644
--- a/doc/man/en/man3/autoplay_group.3
+++ b/doc/man/en/man3/autoplay_group.3
@@ -1,4 +1,4 @@
-.TH "Autoplay support" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Autoplay support" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/browse_group.3 b/doc/man/en/man3/browse_group.3
index 788828bbf..0903319e6 100644
--- a/doc/man/en/man3/browse_group.3
+++ b/doc/man/en/man3/browse_group.3
@@ -1,4 +1,4 @@
-.TH "Browsing support" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Browsing support" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/build_info.3 b/doc/man/en/man3/build_info.3
index 12c3af512..12fa7048c 100644
--- a/doc/man/en/man3/build_info.3
+++ b/doc/man/en/man3/build_info.3
@@ -1,4 +1,4 @@
-.TH "Build informations" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Build informations" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -10,10 +10,10 @@ Build informations \-
.RI "#define \fBXINE_BUILD_CC\fP 'gcc version 2.95.3 20010315 (release)'"
.br
.ti -1c
-.RI "#define \fBXINE_BUILD_OS\fP 'Linux 2.4.9-ac7 i686'"
+.RI "#define \fBXINE_BUILD_OS\fP 'Linux 2.4.9 i686'"
.br
.ti -1c
-.RI "#define \fBXINE_BUILD_DATE\fP 'Fri 05 Oct 2001 14:06:23'"
+.RI "#define \fBXINE_BUILD_DATE\fP 'Mon 15 Oct 2001 00:22:19'"
.br
.in -1c
.SH "DEFINE DOCUMENTATION"
@@ -21,9 +21,9 @@ Build informations \-
.SS "#define XINE_BUILD_CC 'gcc version 2.95.3 20010315 (release)'"
.PP
Compiler used to build xine-lib
-.SS "#define XINE_BUILD_DATE 'Fri 05 Oct 2001 14:06:23'"
+.SS "#define XINE_BUILD_DATE 'Mon 15 Oct 2001 00:22:19'"
.PP
Build time
-.SS "#define XINE_BUILD_OS 'Linux 2.4.9-ac7 i686'"
+.SS "#define XINE_BUILD_OS 'Linux 2.4.9 i686'"
.PP
OS used to build xine-lib \ No newline at end of file
diff --git a/doc/man/en/man3/cfg_data_t.3 b/doc/man/en/man3/cfg_data_t.3
index 64c8ddb86..5af58da46 100644
--- a/doc/man/en/man3/cfg_data_t.3
+++ b/doc/man/en/man3/cfg_data_t.3
@@ -1,4 +1,4 @@
-.TH "cfg_data_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "cfg_data_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/config_group.3 b/doc/man/en/man3/config_group.3
index 3f00294b9..5ca7af99f 100644
--- a/doc/man/en/man3/config_group.3
+++ b/doc/man/en/man3/config_group.3
@@ -1,4 +1,4 @@
-.TH "Configuration structure type." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Configuration structure type." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/config_values_s.3 b/doc/man/en/man3/config_values_s.3
index 56fe33f22..0536f8ef6 100644
--- a/doc/man/en/man3/config_values_s.3
+++ b/doc/man/en/man3/config_values_s.3
@@ -1,4 +1,4 @@
-.TH "config_values_s" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "config_values_s" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/config_values_t.3 b/doc/man/en/man3/config_values_t.3
index a7fbc8b2b..55d6685dd 100644
--- a/doc/man/en/man3/config_values_t.3
+++ b/doc/man/en/man3/config_values_t.3
@@ -1,4 +1,4 @@
-.TH "config_values_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "config_values_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/demux_strategy.3 b/doc/man/en/man3/demux_strategy.3
index 4c3c95b0e..95870f2c5 100644
--- a/doc/man/en/man3/demux_strategy.3
+++ b/doc/man/en/man3/demux_strategy.3
@@ -1,4 +1,4 @@
-.TH "Possible demuxer guessing strategy." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Possible demuxer guessing strategy." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/event_group.3 b/doc/man/en/man3/event_group.3
index b3e2afcba..f517de476 100644
--- a/doc/man/en/man3/event_group.3
+++ b/doc/man/en/man3/event_group.3
@@ -1,4 +1,4 @@
-.TH "Sending events" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Sending events" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/loadplugins_group.3 b/doc/man/en/man3/loadplugins_group.3
index 76e1e1fb9..d77f0af37 100644
--- a/doc/man/en/man3/loadplugins_group.3
+++ b/doc/man/en/man3/loadplugins_group.3
@@ -1,4 +1,4 @@
-.TH "Loading plugins" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Loading plugins" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/mrl_t.3 b/doc/man/en/man3/mrl_t.3
index 3732875ee..e26f68844 100644
--- a/doc/man/en/man3/mrl_t.3
+++ b/doc/man/en/man3/mrl_t.3
@@ -1,4 +1,4 @@
-.TH "mrl_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "mrl_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/mrl_types.3 b/doc/man/en/man3/mrl_types.3
index a577859ee..3dfcc9557 100644
--- a/doc/man/en/man3/mrl_types.3
+++ b/doc/man/en/man3/mrl_types.3
@@ -1,4 +1,4 @@
-.TH "Types of available mrls" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Types of available mrls" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/status_group.3 b/doc/man/en/man3/status_group.3
index 10fbee519..94637586a 100644
--- a/doc/man/en/man3/status_group.3
+++ b/doc/man/en/man3/status_group.3
@@ -1,4 +1,4 @@
-.TH "Player status constants" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Player status constants" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/ui_callbacks.3 b/doc/man/en/man3/ui_callbacks.3
index 6708a2327..225cdf677 100644
--- a/doc/man/en/man3/ui_callbacks.3
+++ b/doc/man/en/man3/ui_callbacks.3
@@ -1,4 +1,4 @@
-.TH "UI communication callbacks." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "UI communication callbacks." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/version_group.3 b/doc/man/en/man3/version_group.3
index 6c8d026d4..208ed26df 100644
--- a/doc/man/en/man3/version_group.3
+++ b/doc/man/en/man3/version_group.3
@@ -1,4 +1,4 @@
-.TH "Version constants" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Version constants" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -13,7 +13,7 @@ Version constants \-
.RI "#define \fBXINE_MINOR_VERSION\fP 9"
.br
.ti -1c
-.RI "#define \fBXINE_SUB_VERSION\fP 1"
+.RI "#define \fBXINE_SUB_VERSION\fP 2"
.br
.in -1c
.SH "DEFINE DOCUMENTATION"
@@ -24,6 +24,6 @@ Major version constant.
.SS "#define XINE_MINOR_VERSION 9"
.PP
Minor version constant.
-.SS "#define XINE_SUB_VERSION 1"
+.SS "#define XINE_SUB_VERSION 2"
.PP
Sub version constant. \ No newline at end of file
diff --git a/doc/man/en/man3/video_cap.3 b/doc/man/en/man3/video_cap.3
index c719b94ae..c7b3db7ae 100644
--- a/doc/man/en/man3/video_cap.3
+++ b/doc/man/en/man3/video_cap.3
@@ -1,4 +1,4 @@
-.TH "video driver capabilities" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "video driver capabilities" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/video_group.3 b/doc/man/en/man3/video_group.3
index 35a51d52f..0bf7110c1 100644
--- a/doc/man/en/man3/video_group.3
+++ b/doc/man/en/man3/video_group.3
@@ -1,4 +1,4 @@
-.TH "Video." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Video." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/video_prop.3 b/doc/man/en/man3/video_prop.3
index 58343967d..4767c2e8d 100644
--- a/doc/man/en/man3/video_prop.3
+++ b/doc/man/en/man3/video_prop.3
@@ -1,4 +1,4 @@
-.TH "Constants for the get/set properties functions." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Constants for the get/set properties functions." 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/video_ratio.3 b/doc/man/en/man3/video_ratio.3
index 2d29aaf7a..3923b6f4c 100644
--- a/doc/man/en/man3/video_ratio.3
+++ b/doc/man/en/man3/video_ratio.3
@@ -1,4 +1,4 @@
-.TH "Possible ratios for the VO_PROP_ASPECT_RATIO call" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Possible ratios for the VO_PROP_ASPECT_RATIO call" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/visual_types.3 b/doc/man/en/man3/visual_types.3
index b4ca315e7..703116784 100644
--- a/doc/man/en/man3/visual_types.3
+++ b/doc/man/en/man3/visual_types.3
@@ -1,4 +1,4 @@
-.TH "Valid visual types" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Valid visual types" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/vo_driver_s.3 b/doc/man/en/man3/vo_driver_s.3
index dcdc5d55b..59bd7969f 100644
--- a/doc/man/en/man3/vo_driver_s.3
+++ b/doc/man/en/man3/vo_driver_s.3
@@ -1,4 +1,4 @@
-.TH "vo_driver_s" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "vo_driver_s" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/vo_driver_t.3 b/doc/man/en/man3/vo_driver_t.3
index 258c3c2be..03e756a63 100644
--- a/doc/man/en/man3/vo_driver_t.3
+++ b/doc/man/en/man3/vo_driver_t.3
@@ -1,4 +1,4 @@
-.TH "vo_driver_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "vo_driver_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/vo_frame_t.3 b/doc/man/en/man3/vo_frame_t.3
index 23f53535a..1ed324d0d 100644
--- a/doc/man/en/man3/vo_frame_t.3
+++ b/doc/man/en/man3/vo_frame_t.3
@@ -1,4 +1,4 @@
-.TH "vo_frame_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "vo_frame_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/vo_overlay_t.3 b/doc/man/en/man3/vo_overlay_t.3
index d0cb6c40a..4ad8cf39f 100644
--- a/doc/man/en/man3/vo_overlay_t.3
+++ b/doc/man/en/man3/vo_overlay_t.3
@@ -1,4 +1,4 @@
-.TH "vo_overlay_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "vo_overlay_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/xine.h.3 b/doc/man/en/man3/xine.h.3
index ebe738f2e..8ccf4642a 100644
--- a/doc/man/en/man3/xine.h.3
+++ b/doc/man/en/man3/xine.h.3
@@ -1,4 +1,4 @@
-.TH "xine.h" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "xine.h" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -29,10 +29,10 @@ xine.h \-
.RI "#define \fBXINE_BUILD_CC\fP 'gcc version 2.95.3 20010315 (release)'"
.br
.ti -1c
-.RI "#define \fBXINE_BUILD_OS\fP 'Linux 2.4.9-ac7 i686'"
+.RI "#define \fBXINE_BUILD_OS\fP 'Linux 2.4.9 i686'"
.br
.ti -1c
-.RI "#define \fBXINE_BUILD_DATE\fP 'Fri 05 Oct 2001 14:06:23'"
+.RI "#define \fBXINE_BUILD_DATE\fP 'Mon 15 Oct 2001 00:22:19'"
.br
.ti -1c
.RI "#define \fBXINE_STOP\fP 0"
@@ -50,7 +50,7 @@ xine.h \-
.RI "#define \fBXINE_MINOR_VERSION\fP 9"
.br
.ti -1c
-.RI "#define \fBXINE_SUB_VERSION\fP 1"
+.RI "#define \fBXINE_SUB_VERSION\fP 2"
.br
.ti -1c
.RI "#define \fBVO_CAP_HUE\fP 0x00000010"
@@ -259,6 +259,27 @@ xine.h \-
.ti -1c
.RI "#define \fBVISUAL_TYPE_GTK\fP 4"
.br
+.ti -1c
+.RI "#define \fBXINE_IMGFMT_YV12\fP 0x32315659"
+.br
+.ti -1c
+.RI "#define \fBXINE_IMGFMT_YUY2\fP (('2'<<24)|('Y'<<16)|('U'<<8)|'Y')"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_SQUARE\fP 1"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_4_3\fP 2"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_ANAMORPHIC\fP 3"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_211_1\fP 4"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_DONT_TOUCH\fP 42"
+.br
.in -1c
.SS "Typedefs"
@@ -451,6 +472,10 @@ xine.h \-
.RI "void \fBxine_send_event\fP (\fBxine_t\fP *self, \fBevent_t\fP *event, void *data)"
.br
.RI "\fIsends an event to all listeners.\fP"
+.ti -1c
+.RI "int \fBxine_get_current_frame\fP (\fBxine_t\fP *self, int *width, int *height, int *ratio_code, int *format, uint8_t **y, uint8_t **u, uint8_t **v)"
+.br
+.RI "\fISnapshot function.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
diff --git a/doc/man/en/man3/xine_api.3 b/doc/man/en/man3/xine_api.3
index 1702f7f6b..7aaf7523e 100644
--- a/doc/man/en/man3/xine_api.3
+++ b/doc/man/en/man3/xine_api.3
@@ -1,4 +1,4 @@
-.TH "API functions" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "API functions" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -39,4 +39,151 @@ API functions \-
.ti -1c
.RI "\fBPlayer status constants\fP"
.br
-.in -1c \ No newline at end of file
+.in -1c
+.SS "Defines"
+
+.in +1c
+.ti -1c
+.RI "#define \fBXINE_IMGFMT_YV12\fP 0x32315659"
+.br
+.ti -1c
+.RI "#define \fBXINE_IMGFMT_YUY2\fP (('2'<<24)|('Y'<<16)|('U'<<8)|'Y')"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_SQUARE\fP 1"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_4_3\fP 2"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_ANAMORPHIC\fP 3"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_211_1\fP 4"
+.br
+.ti -1c
+.RI "#define \fBXINE_ASPECT_RATIO_DONT_TOUCH\fP 42"
+.br
+.in -1c
+.SS "Functions"
+
+.in +1c
+.ti -1c
+.RI "int \fBxine_get_current_frame\fP (\fBxine_t\fP *self, int *width, int *height, int *ratio_code, int *format, uint8_t **y, uint8_t **u, uint8_t **v)"
+.br
+.RI "\fISnapshot function.\fP"
+.in -1c
+.SH "DEFINE DOCUMENTATION"
+.PP
+.SS "#define XINE_ASPECT_RATIO_211_1 4"
+.PP
+aspect ratio.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SS "#define XINE_ASPECT_RATIO_4_3 2"
+.PP
+aspect ratio.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SS "#define XINE_ASPECT_RATIO_ANAMORPHIC 3"
+.PP
+aspect ratio.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SS "#define XINE_ASPECT_RATIO_DONT_TOUCH 42"
+.PP
+aspect ratio.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SS "#define XINE_ASPECT_RATIO_SQUARE 1"
+.PP
+aspect ratio.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SS "#define XINE_IMGFMT_YUY2 (('2'<<24)|('Y'<<16)|('U'<<8)|'Y')"
+.PP
+image format.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SS "#define XINE_IMGFMT_YV12 0x32315659"
+.PP
+image format.
+.PP
+\fBSee also: \fP
+.in +1c
+\fBxine_get_current_frame\fP
+.SH "FUNCTION DOCUMENTATION"
+.PP
+.SS "int xine_get_current_frame (\fBxine_t\fP * self, int * width, int * height, int * ratio_code, int * format, uint8_t ** y, uint8_t ** u, uint8_t ** v)"
+.PP
+Snapshot function.
+.PP
+\fBParameters: \fP
+.in +1c
+.TP
+\fB\fIself\fP\fP
+Current xine engine configuration ( see \fBxine_init\fP() )
+.TP
+\fB\fIwidth\fP\fP
+Width of image (be aware that u,v may be subsampled)
+.TP
+\fB\fIheight\fP\fP
+Height of image (be aware that u,v may be subsampled)
+.TP
+\fB\fIratio_code\fP\fP
+Aspect ratio of the frame
+.TP
+\fB\fIformat\fP\fP
+Subsampling format YUV 4:2:0 or 4:2:2
+.TP
+\fB\fIy\fP\fP
+Lumiance information
+.TP
+\fB\fIu\fP\fP
+Subsample color information
+.TP
+\fB\fIv\fP\fP
+Subsample color information
+.PP
+\fBReturns: \fP
+.in +1c
+1 on success, 0 failure.
+.PP
+\fBParameters: \fP
+.in +1c
+.TP
+\fB\fIself\fP\fP
+
+.TP
+\fB\fIwidth\fP\fP
+
+.TP
+\fB\fIheight\fP\fP
+
+.TP
+\fB\fIratio_code\fP\fP
+
+.TP
+\fB\fIformat\fP\fP
+
+.TP
+\fB\fIy\fP\fP
+
+.TP
+\fB\fIu\fP\fP
+
+.TP
+\fB\fIv\fP\fP
+ \ No newline at end of file
diff --git a/doc/man/en/man3/xine_init.3 b/doc/man/en/man3/xine_init.3
index 2eacbb51b..ff0925724 100644
--- a/doc/man/en/man3/xine_init.3
+++ b/doc/man/en/man3/xine_init.3
@@ -1,4 +1,4 @@
-.TH "Init functions" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Init functions" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/xine_management.3 b/doc/man/en/man3/xine_management.3
index d3baddb42..5c29bf1b6 100644
--- a/doc/man/en/man3/xine_management.3
+++ b/doc/man/en/man3/xine_management.3
@@ -1,4 +1,4 @@
-.TH "Engine management" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Engine management" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/xine_t.3 b/doc/man/en/man3/xine_t.3
index 5b5a8c258..c6a17edb8 100644
--- a/doc/man/en/man3/xine_t.3
+++ b/doc/man/en/man3/xine_t.3
@@ -1,4 +1,4 @@
-.TH "xine_t" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "xine_t" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
diff --git a/doc/man/en/man3/xine_version.3 b/doc/man/en/man3/xine_version.3
index 9d860d1a4..3612f4a18 100644
--- a/doc/man/en/man3/xine_version.3
+++ b/doc/man/en/man3/xine_version.3
@@ -1,4 +1,4 @@
-.TH "Version functions" 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
+.TH "Version functions" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME