diff options
Diffstat (limited to 'doc/man')
32 files changed, 362 insertions, 96 deletions
diff --git a/doc/man/en/man3/Makefile.am b/doc/man/en/man3/Makefile.am index 36ce3bf4b..b896db733 100644 --- a/doc/man/en/man3/Makefile.am +++ b/doc/man/en/man3/Makefile.am @@ -1,11 +1,11 @@ -man_MANS = ao_functions_t.3 demux_strategy.3 video_cap.3 vo_overlay_t.3 \ - autoplay_group.3 event_group.3 video_group.3 xine.h.3 \ - browse_group.3 loadplugins_group.3 video_prop.3 xine_api.3 \ - build_info.3 mrl_t.3 video_ratio.3 xine_init.3 \ - cfg_data_t.3 mrl_types.3 visual_types.3 xine_management.3 \ - config_group.3 status_group.3 vo_driver_s.3 xine_t.3 \ - config_values_s.3 ui_callbacks.3 vo_driver_t.3 xine_version.3 \ - config_values_t.3 version_group.3 vo_frame_t.3 +man_MANS = \ + ao_driver_t.3 config_values_s.3 status_group.3 visual_types.3 xine_init.3 \ + ao_functions_t.3 config_values_t.3 ui_callbacks.3 vo_driver_s.3 xine_management.3 \ + autoplay_group.3 demux_strategy.3 version_group.3 vo_driver_t.3 xine_t.3 \ + browse_group.3 event_group.3 video_cap.3 vo_frame_t.3 xine_version.3 \ + build_info.3 loadplugins_group.3 video_group.3 vo_overlay_t.3 \ + cfg_data_t.3 mrl_t.3 video_prop.3 xine.h.3 \ + config_group.3 mrl_types.3 video_ratio.3 xine_api.3 EXTRA_DIST = $(man_MANS) diff --git a/doc/man/en/man3/ao_driver_t.3 b/doc/man/en/man3/ao_driver_t.3 new file mode 100644 index 000000000..f7095d252 --- /dev/null +++ b/doc/man/en/man3/ao_driver_t.3 @@ -0,0 +1,19 @@ +.TH "ao_driver_t" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ao_driver_t \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SH "DETAILED DESCRIPTION" +.PP +Opaque data type. +.PP + + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for XINE, A Free Video Player Project - API reference from the source code.
\ No newline at end of file diff --git a/doc/man/en/man3/autoplay_group.3 b/doc/man/en/man3/autoplay_group.3 index 8bbd0928b..8bb024057 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Autoplay support" 3 "17 Sep 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 f298ad931..6a1c5c5c3 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Browsing support" 3 "17 Sep 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 832472bb8..c771f8b2e 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Build informations" 3 "17 Sep 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.5 i686'" +.RI "#define \fBXINE_BUILD_OS\fP 'Linux 2.4.8 i686'" .br .ti -1c -.RI "#define \fBXINE_BUILD_DATE\fP 'Thu 26 Jul 2001 09:17:10'" +.RI "#define \fBXINE_BUILD_DATE\fP 'Mon 17 Sep 2001 00:59:15'" .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 'Thu 26 Jul 2001 09:17:10'" +.SS "#define XINE_BUILD_DATE 'Mon 17 Sep 2001 00:59:15'" .PP Build time -.SS "#define XINE_BUILD_OS 'Linux 2.4.5 i686'" +.SS "#define XINE_BUILD_OS 'Linux 2.4.8 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 5f0c8d1bd..5c1d916f2 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "cfg_data_t" 3 "17 Sep 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 e5758dd4a..1c8cbc551 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Configuration structure type." 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME @@ -7,7 +7,7 @@ Configuration structure type. \- .in +1c .ti -1c -.RI "struct \fBao_functions_t\fP" +.RI "struct \fBao_driver_t\fP" .br .ti -1c .RI "struct \fBcfg_data_t\fP" @@ -33,7 +33,7 @@ Configuration structure type. \- .RI "typedef void \fBxine_t\fP" .br .ti -1c -.RI "typedef void \fBao_functions_t\fP" +.RI "typedef void \fBao_driver_t\fP" .br .ti -1c .RI "typedef void \fBcfg_data_t\fP" diff --git a/doc/man/en/man3/config_values_s.3 b/doc/man/en/man3/config_values_s.3 index 4827ca6a2..9cfa54912 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "config_values_s" 3 "17 Sep 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 407bbf4ad..9eb6f79c2 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "config_values_t" 3 "17 Sep 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 05c31b2ae..b0cc0fe02 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Possible demuxer guessing strategy." 3 "17 Sep 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 618fda4e6..c7950fc15 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Sending events" 3 "17 Sep 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 2ecb90d0d..62367dac3 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Loading plugins" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME @@ -33,7 +33,7 @@ Loading plugins \- .br .RI "\fIgenerate a list of all available audio output plugins.\fP" .ti -1c -.RI "\fBao_functions_t\fP* \fBxine_load_audio_output_plugin\fP (\fBconfig_values_t\fP *config, char *id)" +.RI "\fBao_driver_t\fP* \fBxine_load_audio_output_plugin\fP (\fBconfig_values_t\fP *config, char *id)" .br .RI "\fIload a specific audio output plugin.\fP" .in -1c @@ -77,7 +77,7 @@ Valid visual types .TP \fB\fIvisual_type\fP\fP -.SS "\fBao_functions_t\fP * xine_load_audio_output_plugin (\fBconfig_values_t\fP * config, char * id)" +.SS "\fBao_driver_t\fP * xine_load_audio_output_plugin (\fBconfig_values_t\fP * config, char * id)" .PP load a specific audio output plugin. .PP @@ -92,7 +92,7 @@ driver name. .PP \fBSee also: \fP .in +1c -\fBao_functions_t\fP +\fBao_driver_t\fP .PP \fBParameters: \fP .in +1c diff --git a/doc/man/en/man3/mrl_t.3 b/doc/man/en/man3/mrl_t.3 index 9707972b8..15f6116db 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "mrl_t" 3 "17 Sep 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 ffb74ecea..11fca13e8 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Types of available mrls" 3 "17 Sep 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 0f2fd2aeb..3e72f8455 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Player status constants" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME @@ -13,21 +13,11 @@ Player status constants \- .RI "#define \fBXINE_PLAY\fP 1" .br .ti -1c -.RI "#define \fBXINE_PAUSE\fP 2" -.br -.ti -1c -.RI "#define \fBXINE_QUIT\fP 3" +.RI "#define \fBXINE_QUIT\fP 2" .br .in -1c .SH "DEFINE DOCUMENTATION" .PP -.SS "#define XINE_PAUSE 2" -.PP -Pause status. -.PP -\fBSee also: \fP -.in +1c -\fBxine_get_status\fP() .SS "#define XINE_PLAY 1" .PP Play status. @@ -35,7 +25,7 @@ Play status. \fBSee also: \fP .in +1c \fBxine_get_status\fP() -.SS "#define XINE_QUIT 3" +.SS "#define XINE_QUIT 2" .PP Quit status. .PP diff --git a/doc/man/en/man3/ui_callbacks.3 b/doc/man/en/man3/ui_callbacks.3 index 821783948..fb2e980aa 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "UI communication callbacks." 3 "17 Sep 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 021ffb1f7..e778dacb1 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Version constants" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME @@ -10,10 +10,10 @@ Version constants \- .RI "#define \fBXINE_MAJOR_VERSION\fP 0" .br .ti -1c -.RI "#define \fBXINE_MINOR_VERSION\fP 5" +.RI "#define \fBXINE_MINOR_VERSION\fP 9" .br .ti -1c -.RI "#define \fBXINE_SUB_VERSION\fP 0" +.RI "#define \fBXINE_SUB_VERSION\fP 1" .br .in -1c .SH "DEFINE DOCUMENTATION" @@ -21,9 +21,9 @@ Version constants \- .SS "#define XINE_MAJOR_VERSION 0" .PP Major version constant. -.SS "#define XINE_MINOR_VERSION 5" +.SS "#define XINE_MINOR_VERSION 9" .PP Minor version constant. -.SS "#define XINE_SUB_VERSION 0" +.SS "#define XINE_SUB_VERSION 1" .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 22348a7e6..e1efb4632 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "video driver capabilities" 3 "17 Sep 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 5e676d934..a963991a8 100644 --- a/doc/man/en/man3/video_group.3 +++ b/doc/man/en/man3/video_group.3 @@ -1,4 +1,4 @@ -.TH "Video." 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Video." 3 "17 Sep 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 f4964e411..9f2e65ada 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Constants for the get/set properties functions." 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME @@ -28,12 +28,15 @@ Constants for the get/set properties functions. \- .RI "#define \fBVO_PROP_COLORKEY\fP 6" .br .ti -1c -.RI "#define \fBVO_NUM_PROPERTIES\fP 7" +.RI "#define \fBVO_PROP_SOFT_DEINTERLACE\fP 7" +.br +.ti -1c +.RI "#define \fBVO_NUM_PROPERTIES\fP 8" .br .in -1c .SH "DEFINE DOCUMENTATION" .PP -.SS "#define VO_NUM_PROPERTIES 7" +.SS "#define VO_NUM_PROPERTIES 8" .PP Number of available properties property. .PP @@ -88,4 +91,11 @@ Saturation property. .PP \fBSee also: \fP .in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_SOFT_DEINTERLACE 7" +.PP +Software deinterlacing (BOB) property. +.PP +\fBSee also: \fP +.in +1c \fBvo_driver_t\fP
\ No newline at end of file diff --git a/doc/man/en/man3/video_ratio.3 b/doc/man/en/man3/video_ratio.3 index 96993b9ea..6eb5bf05f 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Possible ratios for the VO_PROP_ASPECT_RATIO call" 3 "17 Sep 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 cb34ce52e..5b25e3400 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Valid visual types" 3 "17 Sep 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 da2c2ed78..5fbe486e3 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "vo_driver_s" 3 "17 Sep 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 686a5da8c..0226a1521 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "vo_driver_t" 3 "17 Sep 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 b330f8693..d6cd13292 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "vo_frame_t" 3 "17 Sep 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 7fa6822ca..5878848c9 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "vo_overlay_t" 3 "17 Sep 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 36f7fd604..5d01ab22b 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "xine.h" 3 "17 Sep 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.5 i686'" +.RI "#define \fBXINE_BUILD_OS\fP 'Linux 2.4.8 i686'" .br .ti -1c -.RI "#define \fBXINE_BUILD_DATE\fP 'Thu 26 Jul 2001 09:17:10'" +.RI "#define \fBXINE_BUILD_DATE\fP 'Mon 17 Sep 2001 00:59:15'" .br .ti -1c .RI "#define \fBXINE_STOP\fP 0" @@ -41,19 +41,16 @@ xine.h \- .RI "#define \fBXINE_PLAY\fP 1" .br .ti -1c -.RI "#define \fBXINE_PAUSE\fP 2" -.br -.ti -1c -.RI "#define \fBXINE_QUIT\fP 3" +.RI "#define \fBXINE_QUIT\fP 2" .br .ti -1c .RI "#define \fBXINE_MAJOR_VERSION\fP 0" .br .ti -1c -.RI "#define \fBXINE_MINOR_VERSION\fP 5" +.RI "#define \fBXINE_MINOR_VERSION\fP 9" .br .ti -1c -.RI "#define \fBXINE_SUB_VERSION\fP 0" +.RI "#define \fBXINE_SUB_VERSION\fP 1" .br .ti -1c .RI "#define \fBVO_CAP_HUE\fP 0x00000010" @@ -92,7 +89,10 @@ xine.h \- .RI "#define \fBVO_PROP_COLORKEY\fP 6" .br .ti -1c -.RI "#define \fBVO_NUM_PROPERTIES\fP 7" +.RI "#define \fBVO_PROP_SOFT_DEINTERLACE\fP 7" +.br +.ti -1c +.RI "#define \fBVO_NUM_PROPERTIES\fP 8" .br .ti -1c .RI "#define \fBASPECT_AUTO\fP 0" @@ -119,6 +119,24 @@ xine.h \- .RI "#define \fBDEMUX_EXTENSION_STRATEGY\fP 3" .br .ti -1c +.RI "#define \fBSPEED_PAUSE\fP 0" +.br +.ti -1c +.RI "#define \fBSPEED_SLOW_4\fP 1" +.br +.ti -1c +.RI "#define \fBSPEED_SLOW_2\fP 2" +.br +.ti -1c +.RI "#define \fBSPEED_NORMAL\fP 4" +.br +.ti -1c +.RI "#define \fBSPEED_FAST_2\fP 8" +.br +.ti -1c +.RI "#define \fBSPEED_FAST_4\fP 16" +.br +.ti -1c .RI "#define \fBmrl_unknown\fP (0 << 0)" .br .ti -1c @@ -210,7 +228,7 @@ xine.h \- .RI "typedef void \fBxine_t\fP" .br .ti -1c -.RI "typedef void \fBao_functions_t\fP" +.RI "typedef void \fBao_driver_t\fP" .br .ti -1c .RI "typedef void \fBcfg_data_t\fP" @@ -262,7 +280,7 @@ xine.h \- .br .RI "\fIConfiguration file initialisation.\fP" .ti -1c -.RI "\fBxine_t\fP* \fBxine_init\fP (\fBvo_driver_t\fP *vo, \fBao_functions_t\fP *ao, \fBconfig_values_t\fP *config, \fBgui_stream_end_cb_t\fP stream_end_cb, \fBgui_get_next_mrl_cb_t\fP get_next_mrl_cb, \fBgui_branched_cb_t\fP branched_cb)" +.RI "\fBxine_t\fP* \fBxine_init\fP (\fBvo_driver_t\fP *vo, \fBao_driver_t\fP *ao, \fBconfig_values_t\fP *config, \fBgui_stream_end_cb_t\fP stream_end_cb, \fBgui_get_next_mrl_cb_t\fP get_next_mrl_cb, \fBgui_branched_cb_t\fP branched_cb)" .br .RI "\fIInitialisation of xine.\fP" .ti -1c @@ -270,13 +288,25 @@ xine.h \- .br .RI "\fIDe-initialisation of xine.\fP" .ti -1c -.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int pos)" +.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int start_pos, int start_time)" .br .RI "\fIStart to play a stream.\fP" .ti -1c -.RI "void \fBxine_pause\fP (\fBxine_t\fP *self)" +.RI "void \fBxine_set_speed\fP (\fBxine_t\fP *self, int speed)" +.br +.RI "\fISet playback speed.\fP" +.ti -1c +.RI "int \fBxine_get_speed\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet the playback speed.\fP" +.ti -1c +.RI "void \fBxine_set_av_offset\fP (\fBxine_t\fP *self, int offset_pts)" .br -.RI "\fIPause toggle.\fP" +.RI "\fISet audio/video sync.\fP" +.ti -1c +.RI "int \fBxine_get_av_offset\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet audio/video sync.\fP" .ti -1c .RI "void \fBxine_stop\fP (\fBxine_t\fP *self)" .br @@ -294,6 +324,14 @@ xine.h \- .br .RI "\fIGet current position.\fP" .ti -1c +.RI "int \fBxine_get_current_time\fP (\fBxine_t\fP *self)" +.br +.RI "\fIget current pos in seconds.\fP" +.ti -1c +.RI "int \fBxine_get_stream_length\fP (\fBxine_t\fP *self)" +.br +.RI "\fIestimate length of input stream in seconds.\fP" +.ti -1c .RI "int \fBxine_get_audio_channel\fP (\fBxine_t\fP *self)" .br .RI "\fIGet current audio channel.\fP" @@ -338,7 +376,7 @@ xine.h \- .br .RI "\fIgenerate a list of all available audio output plugins.\fP" .ti -1c -.RI "\fBao_functions_t\fP* \fBxine_load_audio_output_plugin\fP (\fBconfig_values_t\fP *config, char *id)" +.RI "\fBao_driver_t\fP* \fBxine_load_audio_output_plugin\fP (\fBconfig_values_t\fP *config, char *id)" .br .RI "\fIload a specific audio output plugin.\fP" .ti -1c @@ -363,7 +401,7 @@ Guenter Bartsch <guenter@users.sourceforge.net> , Siegfried Langauf <siggi@users .PP \fBDate: \fP .in +1c -25/07/2001 +16/09/2001 .PP API of XINE library. .PP diff --git a/doc/man/en/man3/xine_api.3 b/doc/man/en/man3/xine_api.3 index 805534f9b..c4d834465 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "API functions" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/doc/man/en/man3/xine_init.3 b/doc/man/en/man3/xine_init.3 index 5e7aa8a80..509db7c88 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Init functions" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME @@ -24,7 +24,7 @@ Init functions \- .br .RI "\fIConfiguration file initialisation.\fP" .ti -1c -.RI "\fBxine_t\fP* \fBxine_init\fP (\fBvo_driver_t\fP *vo, \fBao_functions_t\fP *ao, \fBconfig_values_t\fP *config, \fBgui_stream_end_cb_t\fP stream_end_cb, \fBgui_get_next_mrl_cb_t\fP get_next_mrl_cb, \fBgui_branched_cb_t\fP branched_cb)" +.RI "\fBxine_t\fP* \fBxine_init\fP (\fBvo_driver_t\fP *vo, \fBao_driver_t\fP *ao, \fBconfig_values_t\fP *config, \fBgui_stream_end_cb_t\fP stream_end_cb, \fBgui_get_next_mrl_cb_t\fP get_next_mrl_cb, \fBgui_branched_cb_t\fP branched_cb)" .br .RI "\fIInitialisation of xine.\fP" .ti -1c @@ -88,7 +88,7 @@ De-init xine engine. .TP \fB\fIself\fP\fP -.SS "\fBxine_t\fP * xine_init (\fBvo_driver_t\fP * vo, \fBao_functions_t\fP * ao, \fBconfig_values_t\fP * config, \fBgui_stream_end_cb_t\fP stream_end_cb, \fBgui_get_next_mrl_cb_t\fP get_next_mrl_cb, \fBgui_branched_cb_t\fP branched_cb)" +.SS "\fBxine_t\fP * xine_init (\fBvo_driver_t\fP * vo, \fBao_driver_t\fP * ao, \fBconfig_values_t\fP * config, \fBgui_stream_end_cb_t\fP stream_end_cb, \fBgui_get_next_mrl_cb_t\fP get_next_mrl_cb, \fBgui_branched_cb_t\fP branched_cb)" .PP Initialisation of xine. .PP @@ -119,7 +119,7 @@ Current xine engine configuration .PP \fBSee also: \fP .in +1c -\fBvo_driver_t\fP, \fBao_functions_t\fP, \fBconfig_values_t\fP, \fBgui_stream_end_cb_t\fP, \fBgui_get_next_mrl_cb_t\fP, \fBgui_branched_cb_t\fP +\fBvo_driver_t\fP, \fBao_driver_t\fP, \fBconfig_values_t\fP, \fBgui_stream_end_cb_t\fP, \fBgui_get_next_mrl_cb_t\fP, \fBgui_branched_cb_t\fP .PP \fBWarning: \fP .in +1c diff --git a/doc/man/en/man3/xine_management.3 b/doc/man/en/man3/xine_management.3 index 874c926e1..d8d68a3da 100644 --- a/doc/man/en/man3/xine_management.3 +++ b/doc/man/en/man3/xine_management.3 @@ -1,19 +1,53 @@ -.TH "Engine management" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Engine management" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME Engine management \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBSPEED_PAUSE\fP 0" +.br +.ti -1c +.RI "#define \fBSPEED_SLOW_4\fP 1" +.br +.ti -1c +.RI "#define \fBSPEED_SLOW_2\fP 2" +.br +.ti -1c +.RI "#define \fBSPEED_NORMAL\fP 4" +.br +.ti -1c +.RI "#define \fBSPEED_FAST_2\fP 8" +.br +.ti -1c +.RI "#define \fBSPEED_FAST_4\fP 16" +.br +.in -1c .SS "Functions" .in +1c .ti -1c -.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int pos)" +.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int start_pos, int start_time)" .br .RI "\fIStart to play a stream.\fP" .ti -1c -.RI "void \fBxine_pause\fP (\fBxine_t\fP *self)" +.RI "void \fBxine_set_speed\fP (\fBxine_t\fP *self, int speed)" +.br +.RI "\fISet playback speed.\fP" +.ti -1c +.RI "int \fBxine_get_speed\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet the playback speed.\fP" +.ti -1c +.RI "void \fBxine_set_av_offset\fP (\fBxine_t\fP *self, int offset_pts)" +.br +.RI "\fISet audio/video sync.\fP" +.ti -1c +.RI "int \fBxine_get_av_offset\fP (\fBxine_t\fP *self)" .br -.RI "\fIPause toggle.\fP" +.RI "\fIGet audio/video sync.\fP" .ti -1c .RI "void \fBxine_stop\fP (\fBxine_t\fP *self)" .br @@ -31,6 +65,14 @@ Engine management \- .br .RI "\fIGet current position.\fP" .ti -1c +.RI "int \fBxine_get_current_time\fP (\fBxine_t\fP *self)" +.br +.RI "\fIget current pos in seconds.\fP" +.ti -1c +.RI "int \fBxine_get_stream_length\fP (\fBxine_t\fP *self)" +.br +.RI "\fIestimate length of input stream in seconds.\fP" +.ti -1c .RI "int \fBxine_get_audio_channel\fP (\fBxine_t\fP *self)" .br .RI "\fIGet current audio channel.\fP" @@ -47,6 +89,50 @@ Engine management \- .br .RI "\fISet sub-title channel.\fP" .in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define SPEED_FAST_2 8" +.PP +Playback at 200% speed. +.PP +\fBSee also: \fP +.in +1c +\fBxine_set_speed\fP(), \fBxine_get_speed\fP() +.SS "#define SPEED_FAST_4 16" +.PP +Playback at 400% speed. +.PP +\fBSee also: \fP +.in +1c +\fBxine_set_speed\fP(), \fBxine_get_speed\fP() +.SS "#define SPEED_NORMAL 4" +.PP +Playback at 100% speed. +.PP +\fBSee also: \fP +.in +1c +\fBxine_set_speed\fP(), \fBxine_get_speed\fP() +.SS "#define SPEED_PAUSE 0" +.PP +Playback pause. +.PP +\fBSee also: \fP +.in +1c +\fBxine_set_speed\fP(), \fBxine_get_speed\fP() +.SS "#define SPEED_SLOW_2 2" +.PP +Playback at 50% speed. +.PP +\fBSee also: \fP +.in +1c +\fBxine_set_speed\fP(), \fBxine_get_speed\fP() +.SS "#define SPEED_SLOW_4 1" +.PP +Playback at 25% speed. +.PP +\fBSee also: \fP +.in +1c +\fBxine_set_speed\fP(), \fBxine_get_speed\fP() .SH "FUNCTION DOCUMENTATION" .PP .SS "int xine_eject (\fBxine_t\fP * self)" @@ -91,6 +177,27 @@ Get current audio channel. .TP \fB\fIself\fP\fP +.SS "int xine_get_av_offset (\fBxine_t\fP * self)" +.PP +Get audio/video sync. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Current audio/video offset. +.PP +Return the current audio/video sync offset ( see \fBxine_set_av_offset\fP() ). +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + .SS "int xine_get_current_position (\fBxine_t\fP * self)" .PP Get current position. @@ -112,6 +219,48 @@ Get current position in stream. .TP \fB\fIself\fP\fP +.SS "int xine_get_current_time (\fBxine_t\fP * self)" +.PP +get current pos in seconds. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +current position measured in seconds from the beginning of the stream +.PP +get current position measured in seconds from the beginning of the stream +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "int xine_get_speed (\fBxine_t\fP * self)" +.PP +Get the playback speed. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +speed value ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 ) +.PP +Get the current speed playback. Possible values are SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + .SS "int xine_get_spu_channel (\fBxine_t\fP * self)" .PP Get current sub-title channel. @@ -154,9 +303,9 @@ Return the current state of xine engine. .TP \fB\fIself\fP\fP -.SS "void xine_pause (\fBxine_t\fP * self)" +.SS "int xine_get_stream_length (\fBxine_t\fP * self)" .PP -Pause toggle. +estimate length of input stream in seconds. .PP \fBParameters: \fP .in +1c @@ -166,16 +315,16 @@ Current xine engine configuration ( see \fBxine_init\fP() ) .PP \fBReturns: \fP .in +1c -Nothing +length of input stream in seconds or 0 if stream is not seekable .PP -Toggle pause mode. +estimate length of input stream in seconds .PP \fBParameters: \fP .in +1c .TP \fB\fIself\fP\fP -.SS "void xine_play (\fBxine_t\fP * self, char * MRL, int pos)" +.SS "void xine_play (\fBxine_t\fP * self, char * MRL, int start_pos, int start_time)" .PP Start to play a stream. .PP @@ -188,14 +337,17 @@ Current xine engine configuration ( see \fBxine_init\fP() ) \fB\fIMRL\fP\fP Media Resource Location to open .TP -\fB\fIpos\fP\fP -Start from position (0..65535) +\fB\fIstart_pos\fP\fP +position in input source (0..65535) +.TP +\fB\fIstart_time\fP\fP +position measured in seconds from stream start .PP \fBReturns: \fP .in +1c Nothing .PP -Open a stream and play it +Open a stream and play it. If both start position parameters are !=0 start_pos will be used for non-seekable streams both values will be ignored .PP \fBParameters: \fP .in +1c @@ -206,7 +358,10 @@ Open a stream and play it \fB\fIMRL\fP\fP .TP -\fB\fIpos\fP\fP +\fB\fIstart_pos\fP\fP + +.TP +\fB\fIstart_time\fP\fP .SS "void xine_select_audio_channel (\fBxine_t\fP * self, int channel)" .PP @@ -256,6 +411,60 @@ Set desired sub-title channel. .TP \fB\fIchannel\fP\fP +.SS "void xine_set_av_offset (\fBxine_t\fP * self, int offset_pts)" +.PP +Set audio/video sync. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIoffset_pts\fP\fP +New pts. +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Set audio/video sync offset, according to offset_pts value ( see \fBxine_get_av_offset\fP() ). +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIoffset_pts\fP\fP + +.SS "void xine_set_speed (\fBxine_t\fP * self, int speed)" +.PP +Set playback speed. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIspeed\fP\fP +Desired playback speed ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 ) +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Set the playback speed to desired speed, according of SPEED_x constant. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIspeed\fP\fP + .SS "void xine_stop (\fBxine_t\fP * self)" .PP Stop playing. diff --git a/doc/man/en/man3/xine_t.3 b/doc/man/en/man3/xine_t.3 index 1501ba3e7..d1ec407ab 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "xine_t" 3 "17 Sep 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 6256448a0..6036ddc55 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 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.TH "Version functions" 3 "17 Sep 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- .ad l .nh .SH NAME |