diff options
Diffstat (limited to 'doc')
84 files changed, 8530 insertions, 404 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 1485a27ff..3ae53dceb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,5 @@ -SUBDIRS = man +SUBDIRS = man xine-lib-API EXTRA_DIST = $(docs_DOCS) FAQ FAQ_es MRL.txt README.solaris dataflow.dia\ xine-lib-API.cfg README.xinerc README.dxr3 @@ -7,6 +7,18 @@ EXTRA_DIST = $(docs_DOCS) FAQ FAQ_es MRL.txt README.solaris dataflow.dia\ docdir = $(prefix)/share/doc/xine docs_DOCS = +docs: + @if test x"$$DOXYGEN" != "xno"; then \ + echo -n " + Creating docs: "; \ + if test ! -d xine-lib-API/html; \ + then mkdir -p xine-lib-API/html; \ + fi; \ + cp ../misc/xine_logo.png ./xine-lib-API/html; \ + echo -e "<HTML>\n<HEAD>\n<TITLE>\$$projectname</TITLE>\n<IMG SRC=\"xine_logo.png\" alt=\"xine logo\" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0>\n</HEAD>\n<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin=\"0\" topmargin=\"0\" marginwidth=\"0\" marginheight=\"0\">\n" > ./xine-lib-API/xine_header.html; \ + $(DOXYGEN) xine-lib-API.cfg; \ + echo "done.";\ + fi + install-data-local: @documentations='$(docs_DOCS)'; \ @@ -19,7 +31,6 @@ install-data-local: echo "installing $$doc as $$dir/$$name"; \ done - uninstall-local: @documentations='$(docs_DOCS)'; \ for doc in $$documentations; do \ @@ -30,30 +41,13 @@ uninstall-local: echo "removing $$dir/$$name" ; \ done - -docs: - @if test x"$$DOXYGEN" != "xno"; then \ - echo -n " + Creating docs: "; \ - if test ! -d xine-lib-API; then mkdir xine-lib-API; fi; \ - cp ../misc/xine_logo.png ./xine-lib-API; \ - echo -e "<HTML>\n<HEAD>\n<TITLE>\$$projectname</TITLE>\n<IMG SRC=\"../xine_logo.png\" alt=\"xine logo\" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0>\n</HEAD>\n<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin=\"0\" topmargin=\"0\" marginwidth=\"0\" marginheight=\"0\">\n" > ./xine-lib-API/xine_header.html; \ - $(DOXYGEN) xine-lib-API.cfg; \ - echo "done.";\ - fi - - -erase-docs: - @rm -rf xine-lib-API/html - @rm -f xine-lib-API/xine_header.html xine-lib-API/xine_logo.png - - debug: install-debug: mostlyclean-generic: -rm -f *~ \#* .*~ .\#* -maintainer-clean-generic: erase-docs +maintainer-clean-generic: -@echo "This command is intended for maintainers to use;" -@echo "it deletes files that may require special tools to rebuild." -rm -f Makefile.in diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index de46beca4..27993c425 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = fr en +SUBDIRS = en mostlyclean-generic: -rm -f *~ \#* .*~ .\#* diff --git a/doc/man/en/Makefile.am b/doc/man/en/Makefile.am index 10c1637dc..78665fc0e 100644 --- a/doc/man/en/Makefile.am +++ b/doc/man/en/Makefile.am @@ -1,11 +1,19 @@ +SUBDIRS = man3 + man_MANS = xine-lib.3 EXTRA_DIST = $(man_MANS) xine-lib.3.in +##xine-lib-man: +## cat xine-lib.3.in > xine-lib.3 && \ +## (for f in `ls man3/*.3`; do \ +## (echo -e ".B $$f\n" | sed -e 's/man3\///g' -e 's/\.3//g'); \ +## done) >> xine-lib.3 + mostlyclean-generic: -rm -f *~ \#* .*~ .\#* maintainer-clean-generic: -@echo "This command is intended for maintainers to use;" -@echo "it deletes files that may require special tools to rebuild." - -rm -f Makefile.in xine-lib.3 + -rm -f Makefile.in diff --git a/doc/man/en/man3/Makefile.am b/doc/man/en/man3/Makefile.am new file mode 100644 index 000000000..36ce3bf4b --- /dev/null +++ b/doc/man/en/man3/Makefile.am @@ -0,0 +1,18 @@ +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 + +EXTRA_DIST = $(man_MANS) + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in xine-lib.3 diff --git a/doc/man/en/man3/ao_functions_t.3 b/doc/man/en/man3/ao_functions_t.3 new file mode 100644 index 000000000..9e5c3c9d3 --- /dev/null +++ b/doc/man/en/man3/ao_functions_t.3 @@ -0,0 +1,19 @@ +.TH "ao_functions_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ao_functions_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 new file mode 100644 index 000000000..8bbd0928b --- /dev/null +++ b/doc/man/en/man3/autoplay_group.3 @@ -0,0 +1,73 @@ +.TH "Autoplay support" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Autoplay support \- +.SS "Functions" + +.in +1c +.ti -1c +.RI "char** \fBxine_get_autoplay_input_plugin_ids\fP (\fBxine_t\fP *self)" +.br +.RI "\fIRequest playlist from plugin.\fP" +.ti -1c +.RI "char** \fBxine_get_autoplay_mrls\fP (\fBxine_t\fP *self, char *plugin_id, int *num_mrls)" +.br +.RI "\fIRequest MRL list from plugin.\fP" +.in -1c +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "char ** xine_get_autoplay_input_plugin_ids (\fBxine_t\fP * self)" +.PP +Request playlist from plugin. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Playlist. +.PP +Some input plugins can generate autoplay lists returns a list of ids of these plugins. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "char ** xine_get_autoplay_mrls (\fBxine_t\fP * self, char * plugin_id, int * num_mrls)" +.PP +Request MRL list from plugin. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIplugin_id\fP\fP +Plugin name ( see \fBxine_get_autoplay_input_plugin_ids\fP() ) +.TP +\fB\fInum_mrls\fP\fP +Entries in return array. +.PP +\fBReturns: \fP +.in +1c +MRL list. +.PP +Get autoplay MRL list for input plugin named <plugin_id>. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIplugin_id\fP\fP + +.TP +\fB\fInum_mrls\fP\fP +
\ No newline at end of file diff --git a/doc/man/en/man3/browse_group.3 b/doc/man/en/man3/browse_group.3 new file mode 100644 index 000000000..f298ad931 --- /dev/null +++ b/doc/man/en/man3/browse_group.3 @@ -0,0 +1,169 @@ +.TH "Browsing support" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Browsing support \- +.SS "Modules" + +.in +1c +.ti -1c +.RI "\fBTypes of available mrls\fP" +.br +.in -1c +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBmrl_t\fP" +.br +.ti -1c +.RI "struct \fBmrl_t\fP" +.br +.in -1c +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBMRL_ZERO\fP(m)" +.br +.ti -1c +.RI "#define \fBMRL_DUPLICATE\fP(s, d)" +.br +.ti -1c +.RI "#define \fBMRLS_DUPLICATE\fP(s, d)" +.br +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "char** \fBxine_get_browsable_input_plugin_ids\fP (\fBxine_t\fP *self)" +.br +.RI "\fIRequest list of browsable featured plugins.\fP" +.ti -1c +.RI "\fBmrl_t\fP** \fBxine_get_browse_mrls\fP (\fBxine_t\fP *self, char *plugin_id, char *start_mrl, int *num_mrls)" +.br +.RI "\fIRequest available MRLs from plugins.\fP" +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define MRLS_DUPLICATE(s, d)" +.PP +\fBValue:\fP +.PP +.nf + { \ + int i = 0; \ + \ + assert((s) != NULL); \ + assert((d) != NULL); \ + \ + while((s) != NULL) { \ + d[i] = (mrl_t *) malloc(sizeof(mrl_t)); \ + MRL_DUPLICATE(s[i], d[i]); \ + i++; \ + } \ +} +.fi +Duplicate two arrays of mrls (s = source, d = destination). +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP, \fBxine_get_browse_mrls\fP() +.SS "#define MRL_DUPLICATE(s, d)" +.PP +Duplicate two mrls entries (s = source, d = destination). +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP, \fBxine_get_browse_mrls\fP() +.SS "#define MRL_ZERO(m)" +.PP +\fBValue:\fP +.PP +.nf + { \ + if((m)) { \ + if((m)->origin) \ + free((m)->origin); \ + if((m)->mrl) \ + free((m)->mrl); \ + if((m)->link) \ + free((m)->link); \ + (m)->origin = NULL; \ + (m)->mrl = NULL; \ + (m)->link = NULL; \ + (m)->type = 0; \ + (m)->size = (off_t) 0; \ + } \ +} +.fi +Freeing/zeroing all of entries of given mrl. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP, \fBxine_get_browse_mrls\fP() +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "char ** xine_get_browsable_input_plugin_ids (\fBxine_t\fP * self)" +.PP +Request list of browsable featured plugins. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +List of plugins +.PP +Some input plugins are browseable, get the list of ids of these plugins. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "\fBmrl_t\fP ** xine_get_browse_mrls (\fBxine_t\fP * self, char * plugin_id, char * start_mrl, int * num_mrls)" +.PP +Request available MRLs from plugins. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIplugin_id\fP\fP +Plugin name ( see \fBxine_get_browsable_input_plugin_ids\fP() ) +.TP +\fB\fIstart_mrl\fP\fP +MRL +.TP +\fB\fInum_mrl\fP\fP +how many mrls was found +.PP +\fBReturns: \fP +.in +1c +start_mrl on success, NULL on failure. +.PP +Asks input plugin named <plugin_id> to return a list of available MRLs in domain/directory <start_mrl>. +.PP +<start_mrl> may be NULL indicating the toplevel domain/dir returns <start_mrl> if <start_mrl> is a valid MRL, not a directory returns NULL if <start_mrl> is an invalid MRL, not even a directory. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIplugin_id\fP\fP + +.TP +\fB\fIstart_mrl\fP\fP + +.TP +\fB\fInum_mrls\fP\fP +
\ No newline at end of file diff --git a/doc/man/en/man3/build_info.3 b/doc/man/en/man3/build_info.3 new file mode 100644 index 000000000..832472bb8 --- /dev/null +++ b/doc/man/en/man3/build_info.3 @@ -0,0 +1,29 @@ +.TH "Build informations" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Build informations \- +.SS "Defines" + +.in +1c +.ti -1c +.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'" +.br +.ti -1c +.RI "#define \fBXINE_BUILD_DATE\fP 'Thu 26 Jul 2001 09:17:10'" +.br +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.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'" +.PP +Build time +.SS "#define XINE_BUILD_OS 'Linux 2.4.5 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 new file mode 100644 index 000000000..5f0c8d1bd --- /dev/null +++ b/doc/man/en/man3/cfg_data_t.3 @@ -0,0 +1,19 @@ +.TH "cfg_data_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +cfg_data_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/config_group.3 b/doc/man/en/man3/config_group.3 new file mode 100644 index 000000000..e5758dd4a --- /dev/null +++ b/doc/man/en/man3/config_group.3 @@ -0,0 +1,44 @@ +.TH "Configuration structure type." 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Configuration structure type. \- +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBao_functions_t\fP" +.br +.ti -1c +.RI "struct \fBcfg_data_t\fP" +.br +.ti -1c +.RI "struct \fBconfig_values_s\fP" +.br +.ti -1c +.RI "struct \fBconfig_values_s\fP" +.br +.ti -1c +.RI "struct \fBconfig_values_t\fP" +.br +.RI "\fIData type of structure \fBconfig_values_s\fP.\fP" +.ti -1c +.RI "struct \fBxine_t\fP" +.br +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void \fBxine_t\fP" +.br +.ti -1c +.RI "typedef void \fBao_functions_t\fP" +.br +.ti -1c +.RI "typedef void \fBcfg_data_t\fP" +.br +.ti -1c +.RI "typedef struct \fBconfig_values_s\fP \fBconfig_values_t\fP" +.br +.in -1c
\ No newline at end of file diff --git a/doc/man/en/man3/config_values_s.3 b/doc/man/en/man3/config_values_s.3 new file mode 100644 index 000000000..4827ca6a2 --- /dev/null +++ b/doc/man/en/man3/config_values_s.3 @@ -0,0 +1,70 @@ +.TH "config_values_s" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +config_values_s \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SS "Data Fields" + +.in +1c +.ti -1c +.RI "char* (* \fBlookup_str\fP )(\fBconfig_values_t\fP *self, char *key, char *str_default)" +.br +.ti -1c +.RI "int (* \fBlookup_int\fP )(\fBconfig_values_t\fP *self, char *key, int n_default)" +.br +.ti -1c +.RI "void (* \fBset_str\fP )(\fBconfig_values_t\fP *self, char *key, char *value)" +.br +.ti -1c +.RI "void (* \fBset_int\fP )(\fBconfig_values_t\fP *self, char *key, int value)" +.br +.ti -1c +.RI "void (* \fBsave\fP )(\fBconfig_values_t\fP *self)" +.br +.ti -1c +.RI "void (* \fBread\fP )(\fBconfig_values_t\fP *self, char *filename)" +.br +.ti -1c +.RI "\fBcfg_data_t\fP* \fBdata\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Configuration file manipulation. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_file_init\fP() +.PP +.SH "FIELD DOCUMENTATION" +.PP +.SS "\fBcfg_data_t\fP * config_values_s::data" +.PP +Contains private data of this configuration file. +.SS "int(* config_values_s::lookup_int)(\fBconfig_values_t\fP *self, char *key, int n_default)" +.PP +Lookup integer values in configuration file. +.SS "char *(* config_values_s::lookup_str)(\fBconfig_values_t\fP *self, char *key, char *str_default)" +.PP +Lookup string values in configuration file. +.SS "void(* config_values_s::read)(\fBconfig_values_t\fP *self, char *filename)" +.PP +Read configuration file from disk, overriding values in memory. If you also want to clear values that are not in the file, use \fBconfig_file_init\fP() instead! +.SS "void(* config_values_s::save)(\fBconfig_values_t\fP *self)" +.PP +Write configuration file to disk. +.SS "void(* config_values_s::set_int)(\fBconfig_values_t\fP *self, char *key, int value)" +.PP +Set integer values in configuration file. +.SS "void(* config_values_s::set_str)(\fBconfig_values_t\fP *self, char *key, char *value)" +.PP +Set string values in configuration file. + +.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/config_values_t.3 b/doc/man/en/man3/config_values_t.3 new file mode 100644 index 000000000..407bbf4ad --- /dev/null +++ b/doc/man/en/man3/config_values_t.3 @@ -0,0 +1,23 @@ +.TH "config_values_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +config_values_t \- Data type of structure \fBconfig_values_s\fP. +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SH "DETAILED DESCRIPTION" +.PP +Data type of structure \fBconfig_values_s\fP. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_s\fP. +.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/demux_strategy.3 b/doc/man/en/man3/demux_strategy.3 new file mode 100644 index 000000000..05c31b2ae --- /dev/null +++ b/doc/man/en/man3/demux_strategy.3 @@ -0,0 +1,58 @@ +.TH "Possible demuxer guessing strategy." 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Possible demuxer guessing strategy. \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBDEMUX_DEFAULT_STRATEGY\fP 0" +.br +.ti -1c +.RI "#define \fBDEMUX_REVERT_STRATEGY\fP 1" +.br +.ti -1c +.RI "#define \fBDEMUX_CONTENT_STRATEGY\fP 2" +.br +.ti -1c +.RI "#define \fBDEMUX_EXTENSION_STRATEGY\fP 3" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +'demux_strategy' should be set to one of these value in configuration file ( see Configuration structure type.) before \fBxine_init\fP() call. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_t\fP +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define DEMUX_CONTENT_STRATEGY 2" +.PP +Recognize by content only. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_t\fP +.SS "#define DEMUX_DEFAULT_STRATEGY 0" +.PP +Recognize by content then by extension. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_t\fP +.SS "#define DEMUX_EXTENSION_STRATEGY 3" +.PP +Recognize by extension only. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_t\fP +.SS "#define DEMUX_REVERT_STRATEGY 1" +.PP +Recognize by extension then by content. +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_t\fP
\ No newline at end of file diff --git a/doc/man/en/man3/event_group.3 b/doc/man/en/man3/event_group.3 new file mode 100644 index 000000000..618fda4e6 --- /dev/null +++ b/doc/man/en/man3/event_group.3 @@ -0,0 +1,141 @@ +.TH "Sending events" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Sending events \- +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void \fBevent_t\fP" +.br +.ti -1c +.RI "typedef void (* \fBevent_listener_t\fP )(\fBxine_t\fP *xine, \fBevent_t\fP *event, void *data)" +.br +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "int \fBxine_register_event_listener\fP (\fBxine_t\fP *self, \fBevent_listener_t\fP listener)" +.br +.RI "\fIregisters an event listener callback.\fP" +.ti -1c +.RI "int \fBxine_remove_event_listener\fP (\fBxine_t\fP *self, \fBevent_listener_t\fP listener)" +.br +.RI "\fIAttempts to remove a registered event listener.\fP" +.ti -1c +.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" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Event dispatcher mechanism +.SH "TYPEDEF DOCUMENTATION" +.PP +.SS "typedef void(* event_listener_t)(\fBxine_t\fP *xine, \fBevent_t\fP *event, void *data)" +.PP +Event listener callback. +.PP +\fBSee also: \fP +.in +1c +\fBxine_register_event_listener\fP, \fBxine_remove_event_listener\fP +.SS "typedef void event_t" +.PP +Opaque data type. +.PP +\fBSee also: \fP +.in +1c +\fBevent_listener_t\fP, \fBxine_send_event\fP +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "int xine_register_event_listener (\fBxine_t\fP * self, \fBevent_listener_t\fP listener)" +.PP +registers an event listener callback. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIlistener\fP\fP +callback function. +.PP +\fBReturns: \fP +.in +1c +0 if the listener was registerd, non-zero if it could not. +.PP +\fBSee also: \fP +.in +1c +\fBevent_listener_t\fP +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIlistener\fP\fP + +.SS "int xine_remove_event_listener (\fBxine_t\fP * self, \fBevent_listener_t\fP listener)" +.PP +Attempts to remove a registered event listener. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIlistener\fP\fP +callback function. +.PP +\fBReturns: \fP +.in +1c +0 if the listener was removes, non-zero if it wasn't (e.g. not found). +.PP +\fBSee also: \fP +.in +1c +\fBevent_listener_t\fP +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIlistener\fP\fP + +.SS "void xine_send_event (\fBxine_t\fP * self, \fBevent_t\fP * event, void * data)" +.PP +sends an event to all listeners. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIevent\fP\fP +FILLME +.TP +\fB\fIdata\fP\fP +FILLME. +.PP +\fBSee also: \fP +.in +1c +\fBevent_t\fP +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIevent\fP\fP + +.TP +\fB\fIdata\fP\fP +
\ No newline at end of file diff --git a/doc/man/en/man3/loadplugins_group.3 b/doc/man/en/man3/loadplugins_group.3 new file mode 100644 index 000000000..2ecb90d0d --- /dev/null +++ b/doc/man/en/man3/loadplugins_group.3 @@ -0,0 +1,141 @@ +.TH "Loading plugins" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Loading plugins \- +.SS "Modules" + +.in +1c +.ti -1c +.RI "\fBValid visual types\fP" +.br +.in -1c +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBXINE_PLUGINDIR\fP '/usr/local/lib/xine/plugins'" +.br +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "char** \fBxine_list_video_output_plugins\fP (int visual_type)" +.br +.RI "\fIlist available video output plugins.\fP" +.ti -1c +.RI "\fBvo_driver_t\fP* \fBxine_load_video_output_plugin\fP (\fBconfig_values_t\fP *config, char *id, int visual_type, void *visual)" +.br +.RI "\fIload a specific video output plugin.\fP" +.ti -1c +.RI "char** \fBxine_list_audio_output_plugins\fP (void)" +.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)" +.br +.RI "\fIload a specific audio output plugin.\fP" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +output plugin load support functions +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define XINE_PLUGINDIR '/usr/local/lib/xine/plugins'" +.PP +Plugin files location. +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "char ** xine_list_audio_output_plugins (void)" +.PP +generate a list of all available audio output plugins. +.PP +\fBReturns: \fP +.in +1c +a list of available audio output plugins the list returned is sorted by plugin priority +.SS "char ** xine_list_video_output_plugins (int visual_type)" +.PP +list available video output plugins. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIvisual_type\fP\fP +see Valid visual types +.PP +\fBReturns: \fP +.in +1c +a list of available video output plugins for the specified visual type - the list is sorted by plugin priority +.PP +\fBSee also: \fP +.in +1c +Valid visual types +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIvisual_type\fP\fP + +.SS "\fBao_functions_t\fP * xine_load_audio_output_plugin (\fBconfig_values_t\fP * config, char * id)" +.PP +load a specific audio output plugin. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIconfig\fP\fP +current configuration ( see \fBconfig_file_init\fP() ) +.TP +\fB\fIid\fP\fP +driver name. +.PP +\fBSee also: \fP +.in +1c +\fBao_functions_t\fP +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIconfig\fP\fP + +.TP +\fB\fIid\fP\fP + +.SS "\fBvo_driver_t\fP * xine_load_video_output_plugin (\fBconfig_values_t\fP * config, char * id, int visual_type, void * visual)" +.PP +load a specific video output plugin. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIconfig\fP\fP +current configuration ( see \fBconfig_file_init\fP() ) +.TP +\fB\fIid\fP\fP +driver name. +.TP +\fB\fIvisual_type\fP\fP +see Valid visual types +.TP +\fB\fIvisual\fP\fP +visual type dependant data pointer. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP, Valid visual types +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIconfig\fP\fP + +.TP +\fB\fIid\fP\fP + +.TP +\fB\fIvisual_type\fP\fP + +.TP +\fB\fIvisual\fP\fP +
\ No newline at end of file diff --git a/doc/man/en/man3/mrl_t.3 b/doc/man/en/man3/mrl_t.3 new file mode 100644 index 000000000..9707972b8 --- /dev/null +++ b/doc/man/en/man3/mrl_t.3 @@ -0,0 +1,58 @@ +.TH "mrl_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +mrl_t \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SS "Data Fields" + +.in +1c +.ti -1c +.RI "char* \fBorigin\fP" +.br +.ti -1c +.RI "char* \fBmrl\fP" +.br +.ti -1c +.RI "char* \fBlink\fP" +.br +.ti -1c +.RI "uint32_t \fBtype\fP" +.br +.ti -1c +.RI "off_t \fBsize\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_browse_mrls\fP(), \fBMRL_ZERO\fP, \fBMRL_DUPLICATE\fP, \fBMRLS_DUPLICATE\fP, Types of available mrls +.PP +.SH "FIELD DOCUMENTATION" +.PP +.SS "char * mrl_t::link" +.PP +name of link, if exist, otherwise NULL +.SS "char * mrl_t::mrl" +.PP +<type>://<location> +.SS "char * mrl_t::origin" +.PP +Origin of grabbed mrls (eg: path for file plugin +.SS "off_t mrl_t::size" +.PP +size of this source, may be 0 +.SS "uint32_t mrl_t::type" +.PP +match to mrl_type enum + +.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/mrl_types.3 b/doc/man/en/man3/mrl_types.3 new file mode 100644 index 000000000..ffb74ecea --- /dev/null +++ b/doc/man/en/man3/mrl_types.3 @@ -0,0 +1,188 @@ +.TH "Types of available mrls" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Types of available mrls \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBmrl_unknown\fP (0 << 0)" +.br +.ti -1c +.RI "#define \fBmrl_dvd\fP (1 << 0)" +.br +.ti -1c +.RI "#define \fBmrl_vcd\fP (1 << 1)" +.br +.ti -1c +.RI "#define \fBmrl_net\fP (1 << 2)" +.br +.ti -1c +.RI "#define \fBmrl_rtp\fP (1 << 3)" +.br +.ti -1c +.RI "#define \fBmrl_stdin\fP (1 << 4)" +.br +.ti -1c +.RI "#define \fBmrl_file\fP (1 << 5)" +.br +.ti -1c +.RI "#define \fBmrl_file_fifo\fP (1 << 6)" +.br +.ti -1c +.RI "#define \fBmrl_file_chardev\fP (1 << 7)" +.br +.ti -1c +.RI "#define \fBmrl_file_directory\fP (1 << 8)" +.br +.ti -1c +.RI "#define \fBmrl_file_blockdev\fP (1 << 9)" +.br +.ti -1c +.RI "#define \fBmrl_file_normal\fP (1 << 10)" +.br +.ti -1c +.RI "#define \fBmrl_file_symlink\fP (1 << 11)" +.br +.ti -1c +.RI "#define \fBmrl_file_sock\fP (1 << 12)" +.br +.ti -1c +.RI "#define \fBmrl_file_exec\fP (1 << 13)" +.br +.ti -1c +.RI "#define \fBmrl_file_backup\fP (1 << 14)" +.br +.ti -1c +.RI "#define \fBmrl_file_hidden\fP (1 << 15)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +These types are bit field, can be used ORed/ANDed. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define mrl_dvd (1 << 0)" +.PP +DVD mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file (1 << 5)" +.PP +File mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_backup (1 << 14)" +.PP +Backup file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_blockdev (1 << 9)" +.PP +Block device file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_chardev (1 << 7)" +.PP +Char device file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_directory (1 << 8)" +.PP +Directory file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_exec (1 << 13)" +.PP +Executable file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_fifo (1 << 6)" +.PP +Fifo file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_hidden (1 << 15)" +.PP +Hidden file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_normal (1 << 10)" +.PP +Normal file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_sock (1 << 12)" +.PP +Socket file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_file_symlink (1 << 11)" +.PP +Soft link file mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_net (1 << 2)" +.PP +Network mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_rtp (1 << 3)" +.PP +Multicast mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_stdin (1 << 4)" +.PP +Standart input mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_unknown (0 << 0)" +.PP +Unknow mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP +.SS "#define mrl_vcd (1 << 1)" +.PP +VCD mrl type. +.PP +\fBSee also: \fP +.in +1c +\fBmrl_t\fP
\ No newline at end of file diff --git a/doc/man/en/man3/status_group.3 b/doc/man/en/man3/status_group.3 new file mode 100644 index 000000000..0f2fd2aeb --- /dev/null +++ b/doc/man/en/man3/status_group.3 @@ -0,0 +1,51 @@ +.TH "Player status constants" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Player status constants \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBXINE_STOP\fP 0" +.br +.ti -1c +.RI "#define \fBXINE_PLAY\fP 1" +.br +.ti -1c +.RI "#define \fBXINE_PAUSE\fP 2" +.br +.ti -1c +.RI "#define \fBXINE_QUIT\fP 3" +.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. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_status\fP() +.SS "#define XINE_QUIT 3" +.PP +Quit status. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_status\fP() +.SS "#define XINE_STOP 0" +.PP +Stop status. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_status\fP()
\ No newline at end of file diff --git a/doc/man/en/man3/ui_callbacks.3 b/doc/man/en/man3/ui_callbacks.3 new file mode 100644 index 000000000..821783948 --- /dev/null +++ b/doc/man/en/man3/ui_callbacks.3 @@ -0,0 +1,41 @@ +.TH "UI communication callbacks." 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UI communication callbacks. \- +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void (* \fBgui_stream_end_cb_t\fP )(int nStatus)" +.br +.ti -1c +.RI "typedef char* (* \fBgui_get_next_mrl_cb_t\fP )(void)" +.br +.ti -1c +.RI "typedef void (* \fBgui_branched_cb_t\fP )(void)" +.br +.in -1c +.SH "TYPEDEF DOCUMENTATION" +.PP +.SS "typedef void(* gui_branched_cb_t)(void)" +.PP +Called when xine branched successfully to the next mrl. +.PP +\fBSee also: \fP +.in +1c +\fBxine_init\fP() +.SS "typedef char *(* gui_get_next_mrl_cb_t)(void)" +.PP +Called when xine tries to branch seamlessly to the next mrl. +.PP +\fBSee also: \fP +.in +1c +\fBxine_init\fP() +.SS "typedef void(* gui_stream_end_cb_t)(int nStatus)" +.PP +Notify UI when the stream is finished. +.PP +\fBSee also: \fP +.in +1c +\fBxine_init\fP()
\ No newline at end of file diff --git a/doc/man/en/man3/version_group.3 b/doc/man/en/man3/version_group.3 new file mode 100644 index 000000000..021ffb1f7 --- /dev/null +++ b/doc/man/en/man3/version_group.3 @@ -0,0 +1,29 @@ +.TH "Version constants" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Version constants \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBXINE_MAJOR_VERSION\fP 0" +.br +.ti -1c +.RI "#define \fBXINE_MINOR_VERSION\fP 5" +.br +.ti -1c +.RI "#define \fBXINE_SUB_VERSION\fP 0" +.br +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define XINE_MAJOR_VERSION 0" +.PP +Major version constant. +.SS "#define XINE_MINOR_VERSION 5" +.PP +Minor version constant. +.SS "#define XINE_SUB_VERSION 0" +.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 new file mode 100644 index 000000000..22348a7e6 --- /dev/null +++ b/doc/man/en/man3/video_cap.3 @@ -0,0 +1,41 @@ +.TH "video driver capabilities" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +video driver capabilities \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBVO_CAP_HUE\fP 0x00000010" +.br +.ti -1c +.RI "#define \fBVO_CAP_SATURATION\fP 0x00000020" +.br +.ti -1c +.RI "#define \fBVO_CAP_BRIGHTNESS\fP 0x00000040" +.br +.ti -1c +.RI "#define \fBVO_CAP_CONTRAST\fP 0x00000080" +.br +.ti -1c +.RI "#define \fBVO_CAP_COLORKEY\fP 0x00000100" +.br +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define VO_CAP_BRIGHTNESS 0x00000040" +.PP +Driver can set BRIGHTNESS value. +.SS "#define VO_CAP_COLORKEY 0x00000100" +.PP +Driver can set COLORKEY value. +.SS "#define VO_CAP_CONTRAST 0x00000080" +.PP +Driver can set CONTRAST value. +.SS "#define VO_CAP_HUE 0x00000010" +.PP +Driver can set HUE value. +.SS "#define VO_CAP_SATURATION 0x00000020" +.PP +Driver can set SATURATION value.
\ No newline at end of file diff --git a/doc/man/en/man3/video_group.3 b/doc/man/en/man3/video_group.3 new file mode 100644 index 000000000..5e676d934 --- /dev/null +++ b/doc/man/en/man3/video_group.3 @@ -0,0 +1,51 @@ +.TH "Video." 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Video. \- +.SS "Modules" + +.in +1c +.ti -1c +.RI "\fBPossible ratios for the VO_PROP_ASPECT_RATIO call\fP" +.br +.ti -1c +.RI "\fBConstants for the get/set properties functions.\fP" +.br +.ti -1c +.RI "\fBvideo driver capabilities\fP" +.br +.in -1c +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBvo_driver_s\fP" +.br +.ti -1c +.RI "struct \fBvo_driver_s\fP" +.br +.ti -1c +.RI "struct \fBvo_driver_t\fP" +.br +.RI "\fIData type of structure \fBvo_driver_s\fP.\fP" +.ti -1c +.RI "struct \fBvo_frame_t\fP" +.br +.ti -1c +.RI "struct \fBvo_overlay_t\fP" +.br +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void \fBvo_frame_t\fP" +.br +.ti -1c +.RI "typedef void \fBvo_overlay_t\fP" +.br +.ti -1c +.RI "typedef struct \fBvo_driver_s\fP \fBvo_driver_t\fP" +.br +.in -1c
\ No newline at end of file diff --git a/doc/man/en/man3/video_prop.3 b/doc/man/en/man3/video_prop.3 new file mode 100644 index 000000000..f4964e411 --- /dev/null +++ b/doc/man/en/man3/video_prop.3 @@ -0,0 +1,91 @@ +.TH "Constants for the get/set properties functions." 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Constants for the get/set properties functions. \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBVO_PROP_INTERLACED\fP 0" +.br +.ti -1c +.RI "#define \fBVO_PROP_ASPECT_RATIO\fP 1" +.br +.ti -1c +.RI "#define \fBVO_PROP_HUE\fP 2" +.br +.ti -1c +.RI "#define \fBVO_PROP_SATURATION\fP 3" +.br +.ti -1c +.RI "#define \fBVO_PROP_CONTRAST\fP 4" +.br +.ti -1c +.RI "#define \fBVO_PROP_BRIGHTNESS\fP 5" +.br +.ti -1c +.RI "#define \fBVO_PROP_COLORKEY\fP 6" +.br +.ti -1c +.RI "#define \fBVO_NUM_PROPERTIES\fP 7" +.br +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define VO_NUM_PROPERTIES 7" +.PP +Number of available properties property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_ASPECT_RATIO 1" +.PP +Aspect ratio property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP, Possible ratios for the VO_PROP_ASPECT_RATIO call +.SS "#define VO_PROP_BRIGHTNESS 5" +.PP +Brightness property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_COLORKEY 6" +.PP +Colorkey property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_CONTRAST 4" +.PP +Contrast property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_HUE 2" +.PP +Hue property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_INTERLACED 0" +.PP +Interleave property. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.SS "#define VO_PROP_SATURATION 3" +.PP +Saturation 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 new file mode 100644 index 000000000..96993b9ea --- /dev/null +++ b/doc/man/en/man3/video_ratio.3 @@ -0,0 +1,56 @@ +.TH "Possible ratios for the VO_PROP_ASPECT_RATIO call" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Possible ratios for the VO_PROP_ASPECT_RATIO call \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBASPECT_AUTO\fP 0" +.br +.ti -1c +.RI "#define \fBASPECT_ANAMORPHIC\fP 1" +.br +.ti -1c +.RI "#define \fBASPECT_FULL\fP 2" +.br +.ti -1c +.RI "#define \fBASPECT_DVB\fP 3" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +\fBSee also: \fP +.in +1c +\fBVO_PROP_ASPECT_RATIO\fP, \fBvo_driver_t\fP +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define ASPECT_ANAMORPHIC 1" +.PP +Set aspect ration to 16:9. +.PP +\fBSee also: \fP +.in +1c +\fBVO_PROP_ASPECT_RATIO\fP +.SS "#define ASPECT_AUTO 0" +.PP +Let video driver guessing aspect ratio. +.PP +\fBSee also: \fP +.in +1c +\fBVO_PROP_ASPECT_RATIO\fP +.SS "#define ASPECT_DVB 3" +.PP +Set aspect ration to 1:2. +.PP +\fBSee also: \fP +.in +1c +\fBVO_PROP_ASPECT_RATIO\fP +.SS "#define ASPECT_FULL 2" +.PP +Set aspect ration to 4:3. +.PP +\fBSee also: \fP +.in +1c +\fBVO_PROP_ASPECT_RATIO\fP
\ No newline at end of file diff --git a/doc/man/en/man3/visual_types.3 b/doc/man/en/man3/visual_types.3 new file mode 100644 index 000000000..cb34ce52e --- /dev/null +++ b/doc/man/en/man3/visual_types.3 @@ -0,0 +1,51 @@ +.TH "Valid visual types" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Valid visual types \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBVISUAL_TYPE_X11\fP 1" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_AA\fP 2" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_FB\fP 3" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_GTK\fP 4" +.br +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define VISUAL_TYPE_AA 2" +.PP +Asci Art visual type. +.PP +\fBSee also: \fP +.in +1c +\fBxine_list_video_output_plugins\fP, \fBxine_load_video_output_plugin\fP +.SS "#define VISUAL_TYPE_FB 3" +.PP +Framebuffer visual type +.PP +\fBSee also: \fP +.in +1c +\fBxine_list_video_output_plugins\fP, \fBxine_load_video_output_plugin\fP +.SS "#define VISUAL_TYPE_GTK 4" +.PP +GTK visual type +.PP +\fBSee also: \fP +.in +1c +\fBxine_list_video_output_plugins\fP, \fBxine_load_video_output_plugin\fP +.SS "#define VISUAL_TYPE_X11 1" +.PP +X11 visual type. +.PP +\fBSee also: \fP +.in +1c +\fBxine_list_video_output_plugins\fP, \fBxine_load_video_output_plugin\fP
\ No newline at end of file diff --git a/doc/man/en/man3/vo_driver_s.3 b/doc/man/en/man3/vo_driver_s.3 new file mode 100644 index 000000000..da2c2ed78 --- /dev/null +++ b/doc/man/en/man3/vo_driver_s.3 @@ -0,0 +1,102 @@ +.TH "vo_driver_s" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +vo_driver_s \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SS "Data Fields" + +.in +1c +.ti -1c +.RI "uint32_t (* \fBget_capabilities\fP )(\fBvo_driver_t\fP *self)" +.br +.ti -1c +.RI "\fBvo_frame_t\fP* (* \fBalloc_frame\fP )(\fBvo_driver_t\fP *self)" +.br +.ti -1c +.RI "void (* \fBupdate_frame_format\fP )(\fBvo_driver_t\fP *self, \fBvo_frame_t\fP *img, uint32_t width, uint32_t height, int ratio_code, int format)" +.br +.ti -1c +.RI "void (* \fBdisplay_frame\fP )(\fBvo_driver_t\fP *self, \fBvo_frame_t\fP *vo_img)" +.br +.ti -1c +.RI "void (* \fBoverlay_blend\fP )(\fBvo_driver_t\fP *self, \fBvo_frame_t\fP *vo_img, \fBvo_overlay_t\fP *overlay)" +.br +.ti -1c +.RI "int (* \fBget_property\fP )(\fBvo_driver_t\fP *self, int property)" +.br +.ti -1c +.RI "int (* \fBset_property\fP )(\fBvo_driver_t\fP *self, int property, int value)" +.br +.ti -1c +.RI "void (* \fBget_property_min_max\fP )(\fBvo_driver_t\fP *self, int property, int *min, int *max)" +.br +.ti -1c +.RI "int (* \fBgui_data_exchange\fP )(\fBvo_driver_t\fP *self, int data_type, void *data)" +.br +.ti -1c +.RI "void (* \fBexit\fP )(\fBvo_driver_t\fP *self)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Video driver fonctions. +.PP +.SH "FIELD DOCUMENTATION" +.PP +.SS "\fBvo_frame_t\fP *(* vo_driver_s::alloc_frame)(\fBvo_driver_t\fP *self)" +.PP +Allocate an \fBvo_frame_t\fP struct, the driver must supply the copy, field and dispose functions +.SS "void(* vo_driver_s::display_frame)(\fBvo_driver_t\fP *self, \fBvo_frame_t\fP *vo_img)" +.PP +Display a given frame +.SS "void(* vo_driver_s::exit)(\fBvo_driver_t\fP *self)" +.PP +Leaving video driver. +.SS "uint32_t(* vo_driver_s::get_capabilities)(\fBvo_driver_t\fP *self)" +.PP +Get capabilities of video driver. +.PP +\fBSee also: \fP +.in +1c +video driver capabilities +.SS "int(* vo_driver_s::get_property)(\fBvo_driver_t\fP *self, int property)" +.PP +Get value if property. +.PP +\fBSee also: \fP +.in +1c +Constants for the get/set properties functions. +.SS "void(* vo_driver_s::get_property_min_max)(\fBvo_driver_t\fP *self, int property, int *min, int *max)" +.PP +Get min/max values of property. +.PP +\fBSee also: \fP +.in +1c +Constants for the get/set properties functions. +.SS "int(* vo_driver_s::gui_data_exchange)(\fBvo_driver_t\fP *self, int data_type, void *data)" +.PP +General purpose communication channel between gui and driver +.PP +this should be used to propagate events, display data, window sizes etc. to the driver +.SS "void(* vo_driver_s::overlay_blend)(\fBvo_driver_t\fP *self, \fBvo_frame_t\fP *vo_img, \fBvo_overlay_t\fP *overlay)" +.PP +Overlay functions +.SS "int(* vo_driver_s::set_property)(\fBvo_driver_t\fP *self, int property, int value)" +.PP +Set value of property. +.PP +\fBSee also: \fP +.in +1c +Constants for the get/set properties functions. +.SS "void(* vo_driver_s::update_frame_format)(\fBvo_driver_t\fP *self, \fBvo_frame_t\fP *img, uint32_t width, uint32_t height, int ratio_code, int format)" +.PP +Check if the given image fullfills the format specified (re-)allocate memory if necessary + +.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/vo_driver_t.3 b/doc/man/en/man3/vo_driver_t.3 new file mode 100644 index 000000000..686a5da8c --- /dev/null +++ b/doc/man/en/man3/vo_driver_t.3 @@ -0,0 +1,23 @@ +.TH "vo_driver_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +vo_driver_t \- Data type of structure \fBvo_driver_s\fP. +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SH "DETAILED DESCRIPTION" +.PP +Data type of structure \fBvo_driver_s\fP. +.PP +\fBSee also: \fP +.in +1c +structure \fBvo_driver_s\fP. +.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/vo_frame_t.3 b/doc/man/en/man3/vo_frame_t.3 new file mode 100644 index 000000000..b330f8693 --- /dev/null +++ b/doc/man/en/man3/vo_frame_t.3 @@ -0,0 +1,23 @@ +.TH "vo_frame_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +vo_frame_t \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SH "DETAILED DESCRIPTION" +.PP +Opaque data type. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.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/vo_overlay_t.3 b/doc/man/en/man3/vo_overlay_t.3 new file mode 100644 index 000000000..7fa6822ca --- /dev/null +++ b/doc/man/en/man3/vo_overlay_t.3 @@ -0,0 +1,23 @@ +.TH "vo_overlay_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +vo_overlay_t \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SH "DETAILED DESCRIPTION" +.PP +Opaque data type. +.PP +\fBSee also: \fP +.in +1c +\fBvo_driver_t\fP +.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/xine.h.3 b/doc/man/en/man3/xine.h.3 new file mode 100644 index 000000000..36f7fd604 --- /dev/null +++ b/doc/man/en/man3/xine.h.3 @@ -0,0 +1,400 @@ +.TH "xine.h" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +xine.h \- +.SH SYNOPSIS +.br +.PP +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBconfig_values_s\fP" +.br +.ti -1c +.RI "struct \fBmrl_t\fP" +.br +.ti -1c +.RI "struct \fBvo_driver_s\fP" +.br +.in -1c +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBXINE_SKINDIR\fP '/usr/local/share/xine/skins'" +.br +.ti -1c +.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'" +.br +.ti -1c +.RI "#define \fBXINE_BUILD_DATE\fP 'Thu 26 Jul 2001 09:17:10'" +.br +.ti -1c +.RI "#define \fBXINE_STOP\fP 0" +.br +.ti -1c +.RI "#define \fBXINE_PLAY\fP 1" +.br +.ti -1c +.RI "#define \fBXINE_PAUSE\fP 2" +.br +.ti -1c +.RI "#define \fBXINE_QUIT\fP 3" +.br +.ti -1c +.RI "#define \fBXINE_MAJOR_VERSION\fP 0" +.br +.ti -1c +.RI "#define \fBXINE_MINOR_VERSION\fP 5" +.br +.ti -1c +.RI "#define \fBXINE_SUB_VERSION\fP 0" +.br +.ti -1c +.RI "#define \fBVO_CAP_HUE\fP 0x00000010" +.br +.ti -1c +.RI "#define \fBVO_CAP_SATURATION\fP 0x00000020" +.br +.ti -1c +.RI "#define \fBVO_CAP_BRIGHTNESS\fP 0x00000040" +.br +.ti -1c +.RI "#define \fBVO_CAP_CONTRAST\fP 0x00000080" +.br +.ti -1c +.RI "#define \fBVO_CAP_COLORKEY\fP 0x00000100" +.br +.ti -1c +.RI "#define \fBVO_PROP_INTERLACED\fP 0" +.br +.ti -1c +.RI "#define \fBVO_PROP_ASPECT_RATIO\fP 1" +.br +.ti -1c +.RI "#define \fBVO_PROP_HUE\fP 2" +.br +.ti -1c +.RI "#define \fBVO_PROP_SATURATION\fP 3" +.br +.ti -1c +.RI "#define \fBVO_PROP_CONTRAST\fP 4" +.br +.ti -1c +.RI "#define \fBVO_PROP_BRIGHTNESS\fP 5" +.br +.ti -1c +.RI "#define \fBVO_PROP_COLORKEY\fP 6" +.br +.ti -1c +.RI "#define \fBVO_NUM_PROPERTIES\fP 7" +.br +.ti -1c +.RI "#define \fBASPECT_AUTO\fP 0" +.br +.ti -1c +.RI "#define \fBASPECT_ANAMORPHIC\fP 1" +.br +.ti -1c +.RI "#define \fBASPECT_FULL\fP 2" +.br +.ti -1c +.RI "#define \fBASPECT_DVB\fP 3" +.br +.ti -1c +.RI "#define \fBDEMUX_DEFAULT_STRATEGY\fP 0" +.br +.ti -1c +.RI "#define \fBDEMUX_REVERT_STRATEGY\fP 1" +.br +.ti -1c +.RI "#define \fBDEMUX_CONTENT_STRATEGY\fP 2" +.br +.ti -1c +.RI "#define \fBDEMUX_EXTENSION_STRATEGY\fP 3" +.br +.ti -1c +.RI "#define \fBmrl_unknown\fP (0 << 0)" +.br +.ti -1c +.RI "#define \fBmrl_dvd\fP (1 << 0)" +.br +.ti -1c +.RI "#define \fBmrl_vcd\fP (1 << 1)" +.br +.ti -1c +.RI "#define \fBmrl_net\fP (1 << 2)" +.br +.ti -1c +.RI "#define \fBmrl_rtp\fP (1 << 3)" +.br +.ti -1c +.RI "#define \fBmrl_stdin\fP (1 << 4)" +.br +.ti -1c +.RI "#define \fBmrl_file\fP (1 << 5)" +.br +.ti -1c +.RI "#define \fBmrl_file_fifo\fP (1 << 6)" +.br +.ti -1c +.RI "#define \fBmrl_file_chardev\fP (1 << 7)" +.br +.ti -1c +.RI "#define \fBmrl_file_directory\fP (1 << 8)" +.br +.ti -1c +.RI "#define \fBmrl_file_blockdev\fP (1 << 9)" +.br +.ti -1c +.RI "#define \fBmrl_file_normal\fP (1 << 10)" +.br +.ti -1c +.RI "#define \fBmrl_file_symlink\fP (1 << 11)" +.br +.ti -1c +.RI "#define \fBmrl_file_sock\fP (1 << 12)" +.br +.ti -1c +.RI "#define \fBmrl_file_exec\fP (1 << 13)" +.br +.ti -1c +.RI "#define \fBmrl_file_backup\fP (1 << 14)" +.br +.ti -1c +.RI "#define \fBmrl_file_hidden\fP (1 << 15)" +.br +.ti -1c +.RI "#define \fBMRL_ZERO\fP(m)" +.br +.ti -1c +.RI "#define \fBMRL_DUPLICATE\fP(s, d)" +.br +.ti -1c +.RI "#define \fBMRLS_DUPLICATE\fP(s, d)" +.br +.ti -1c +.RI "#define \fBXINE_PLUGINDIR\fP '/usr/local/lib/xine/plugins'" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_X11\fP 1" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_AA\fP 2" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_FB\fP 3" +.br +.ti -1c +.RI "#define \fBVISUAL_TYPE_GTK\fP 4" +.br +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void \fBvo_frame_t\fP" +.br +.ti -1c +.RI "typedef void \fBvo_overlay_t\fP" +.br +.ti -1c +.RI "typedef struct \fBvo_driver_s\fP \fBvo_driver_t\fP" +.br +.ti -1c +.RI "typedef void \fBxine_t\fP" +.br +.ti -1c +.RI "typedef void \fBao_functions_t\fP" +.br +.ti -1c +.RI "typedef void \fBcfg_data_t\fP" +.br +.ti -1c +.RI "typedef struct \fBconfig_values_s\fP \fBconfig_values_t\fP" +.br +.ti -1c +.RI "typedef void (* \fBgui_stream_end_cb_t\fP )(int nStatus)" +.br +.ti -1c +.RI "typedef char* (* \fBgui_get_next_mrl_cb_t\fP )(void)" +.br +.ti -1c +.RI "typedef void (* \fBgui_branched_cb_t\fP )(void)" +.br +.ti -1c +.RI "typedef void \fBevent_t\fP" +.br +.ti -1c +.RI "typedef void (* \fBevent_listener_t\fP )(\fBxine_t\fP *xine, \fBevent_t\fP *event, void *data)" +.br +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "char* \fBxine_get_str_version\fP (void)" +.br +.RI "\fIreturn string version, like '0.5.0'.\fP" +.ti -1c +.RI "int \fBxine_get_major_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_get_minor_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_get_sub_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_check_version\fP (int major, int minor, int sub)" +.br +.RI "\fIcheck minimal version.\fP" +.ti -1c +.RI "\fBconfig_values_t\fP* \fBconfig_file_init\fP (char *filename)" +.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)" +.br +.RI "\fIInitialisation of xine.\fP" +.ti -1c +.RI "void \fBxine_exit\fP (\fBxine_t\fP *self)" +.br +.RI "\fIDe-initialisation of xine.\fP" +.ti -1c +.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int pos)" +.br +.RI "\fIStart to play a stream.\fP" +.ti -1c +.RI "void \fBxine_pause\fP (\fBxine_t\fP *self)" +.br +.RI "\fIPause toggle.\fP" +.ti -1c +.RI "void \fBxine_stop\fP (\fBxine_t\fP *self)" +.br +.RI "\fIStop playing.\fP" +.ti -1c +.RI "int \fBxine_eject\fP (\fBxine_t\fP *self)" +.br +.RI "\fIEject media.\fP" +.ti -1c +.RI "int \fBxine_get_status\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current xine status.\fP" +.ti -1c +.RI "int \fBxine_get_current_position\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current position.\fP" +.ti -1c +.RI "int \fBxine_get_audio_channel\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current audio channel.\fP" +.ti -1c +.RI "void \fBxine_select_audio_channel\fP (\fBxine_t\fP *self, int channel)" +.br +.RI "\fISet audio channel.\fP" +.ti -1c +.RI "int \fBxine_get_spu_channel\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current sub-title channel.\fP" +.ti -1c +.RI "void \fBxine_select_spu_channel\fP (\fBxine_t\fP *self, int channel)" +.br +.RI "\fISet sub-title channel.\fP" +.ti -1c +.RI "char** \fBxine_get_browsable_input_plugin_ids\fP (\fBxine_t\fP *self)" +.br +.RI "\fIRequest list of browsable featured plugins.\fP" +.ti -1c +.RI "\fBmrl_t\fP** \fBxine_get_browse_mrls\fP (\fBxine_t\fP *self, char *plugin_id, char *start_mrl, int *num_mrls)" +.br +.RI "\fIRequest available MRLs from plugins.\fP" +.ti -1c +.RI "char** \fBxine_get_autoplay_input_plugin_ids\fP (\fBxine_t\fP *self)" +.br +.RI "\fIRequest playlist from plugin.\fP" +.ti -1c +.RI "char** \fBxine_get_autoplay_mrls\fP (\fBxine_t\fP *self, char *plugin_id, int *num_mrls)" +.br +.RI "\fIRequest MRL list from plugin.\fP" +.ti -1c +.RI "char** \fBxine_list_video_output_plugins\fP (int visual_type)" +.br +.RI "\fIlist available video output plugins.\fP" +.ti -1c +.RI "\fBvo_driver_t\fP* \fBxine_load_video_output_plugin\fP (\fBconfig_values_t\fP *config, char *id, int visual_type, void *visual)" +.br +.RI "\fIload a specific video output plugin.\fP" +.ti -1c +.RI "char** \fBxine_list_audio_output_plugins\fP (void)" +.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)" +.br +.RI "\fIload a specific audio output plugin.\fP" +.ti -1c +.RI "int \fBxine_register_event_listener\fP (\fBxine_t\fP *self, \fBevent_listener_t\fP listener)" +.br +.RI "\fIregisters an event listener callback.\fP" +.ti -1c +.RI "int \fBxine_remove_event_listener\fP (\fBxine_t\fP *self, \fBevent_listener_t\fP listener)" +.br +.RI "\fIAttempts to remove a registered event listener.\fP" +.ti -1c +.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" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +.PP +\fBAuthor: \fP +.in +1c +Guenter Bartsch <guenter@users.sourceforge.net> , Siegfried Langauf <siggi@users.sourceforge.net> , Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> +.PP +\fBDate: \fP +.in +1c +25/07/2001 +.PP +API of XINE library. +.PP +.nf + + Copyright (C) 2000-2001 the xine project + + This file is part of xine, a unix video player. + + xine is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + xine is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + + +.fi +.PP +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define XINE_SKINDIR '/usr/local/share/xine/skins'" +.PP +Skin file location +.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/xine_api.3 b/doc/man/en/man3/xine_api.3 new file mode 100644 index 000000000..805534f9b --- /dev/null +++ b/doc/man/en/man3/xine_api.3 @@ -0,0 +1,39 @@ +.TH "API functions" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +API functions \- +.SS "Modules" + +.in +1c +.ti -1c +.RI "\fBSending events\fP" +.br +.ti -1c +.RI "\fBLoading plugins\fP" +.br +.ti -1c +.RI "\fBAutoplay support\fP" +.br +.ti -1c +.RI "\fBBrowsing support\fP" +.br +.ti -1c +.RI "\fBEngine management\fP" +.br +.ti -1c +.RI "\fBInit functions\fP" +.br +.ti -1c +.RI "\fBVideo.\fP" +.br +.ti -1c +.RI "\fBVersion functions\fP" +.br +.ti -1c +.RI "\fBVersion constants\fP" +.br +.ti -1c +.RI "\fBPlayer status constants\fP" +.br +.in -1c
\ No newline at end of file diff --git a/doc/man/en/man3/xine_init.3 b/doc/man/en/man3/xine_init.3 new file mode 100644 index 000000000..5e7aa8a80 --- /dev/null +++ b/doc/man/en/man3/xine_init.3 @@ -0,0 +1,149 @@ +.TH "Init functions" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Init functions \- +.SS "Modules" + +.in +1c +.ti -1c +.RI "\fBPossible demuxer guessing strategy.\fP" +.br +.ti -1c +.RI "\fBUI communication callbacks.\fP" +.br +.ti -1c +.RI "\fBConfiguration structure type.\fP" +.br +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "\fBconfig_values_t\fP* \fBconfig_file_init\fP (char *filename)" +.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)" +.br +.RI "\fIInitialisation of xine.\fP" +.ti -1c +.RI "void \fBxine_exit\fP (\fBxine_t\fP *self)" +.br +.RI "\fIDe-initialisation of xine.\fP" +.in -1c +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "\fBconfig_values_t\fP * config_file_init (char * filename)" +.PP +Configuration file initialisation. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIfilename\fP\fP +Pathname of configuration file. +.PP +\fBReturns: \fP +.in +1c +Current config +.PP +\fBSee also: \fP +.in +1c +\fBconfig_values_t\fP +.PP +\fBWarning: \fP +.in +1c +This function should be called at least one time before \fBxine_init\fP() call. +.PP +Read config file and init a config object of \fBconfig_values_t\fP type (if it exists) +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIfilename\fP\fP + +.SS "void xine_exit (\fBxine_t\fP * self)" +.PP +De-initialisation of xine. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration. +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +\fBSee also: \fP +.in +1c +\fBxine_init\fP() +.PP +De-init xine engine. +.PP +\fBParameters: \fP +.in +1c +.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)" +.PP +Initialisation of xine. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIvo\fP\fP +video driver ( see \fBxine_load_video_output_plugin\fP() ) +.TP +\fB\fIao\fP\fP +audio driver ( see \fBxine_load_audio_output_plugin\fP() ) +.TP +\fB\fIconfig\fP\fP +current configuration ( see \fBconfig_file_init\fP() ) +.TP +\fB\fIstream_end\fP\fP +cb called on stream end +.TP +\fB\fIget_next_mrl_cb\fP\fP +called to find out next mrl for seamless branching +.TP +\fB\fIbranched_cb\fP\fP +called if seamless branch was taken +.PP +\fBReturns: \fP +.in +1c +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 +.PP +\fBWarning: \fP +.in +1c +This function should be called before any other xine_*() function. +.PP +Init of xine. It should called once at startup. all callbacks may be NULL if ui is not interested in them for whatever reason ao may be NULL for no audio playback +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIvo\fP\fP + +.TP +\fB\fIao\fP\fP + +.TP +\fB\fIconfig\fP\fP + +.TP +\fB\fIstream_end_cb\fP\fP + +.TP +\fB\fIget_next_mrl_cb\fP\fP + +.TP +\fB\fIbranched_cb\fP\fP +
\ No newline at end of file diff --git a/doc/man/en/man3/xine_management.3 b/doc/man/en/man3/xine_management.3 new file mode 100644 index 000000000..874c926e1 --- /dev/null +++ b/doc/man/en/man3/xine_management.3 @@ -0,0 +1,279 @@ +.TH "Engine management" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Engine management \- +.SS "Functions" + +.in +1c +.ti -1c +.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int pos)" +.br +.RI "\fIStart to play a stream.\fP" +.ti -1c +.RI "void \fBxine_pause\fP (\fBxine_t\fP *self)" +.br +.RI "\fIPause toggle.\fP" +.ti -1c +.RI "void \fBxine_stop\fP (\fBxine_t\fP *self)" +.br +.RI "\fIStop playing.\fP" +.ti -1c +.RI "int \fBxine_eject\fP (\fBxine_t\fP *self)" +.br +.RI "\fIEject media.\fP" +.ti -1c +.RI "int \fBxine_get_status\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current xine status.\fP" +.ti -1c +.RI "int \fBxine_get_current_position\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current position.\fP" +.ti -1c +.RI "int \fBxine_get_audio_channel\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current audio channel.\fP" +.ti -1c +.RI "void \fBxine_select_audio_channel\fP (\fBxine_t\fP *self, int channel)" +.br +.RI "\fISet audio channel.\fP" +.ti -1c +.RI "int \fBxine_get_spu_channel\fP (\fBxine_t\fP *self)" +.br +.RI "\fIGet current sub-title channel.\fP" +.ti -1c +.RI "void \fBxine_select_spu_channel\fP (\fBxine_t\fP *self, int channel)" +.br +.RI "\fISet sub-title channel.\fP" +.in -1c +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "int xine_eject (\fBxine_t\fP * self)" +.PP +Eject media. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +1 on success, 0 on failure. +.PP +Tell current input plugin to eject media. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "int xine_get_audio_channel (\fBxine_t\fP * self)" +.PP +Get current audio channel. +.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 chennel +.PP +Get current audio channel. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "int xine_get_current_position (\fBxine_t\fP * self)" +.PP +Get current position. +.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 ( 0..65535 ) +.PP +Get current position in stream. +.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. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Current sub-title channel +.PP +Get current sub-title channel. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "int xine_get_status (\fBxine_t\fP * self)" +.PP +Get current xine status. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Current status ( see Player status constants ) +.PP +Return the current state of xine engine. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "void xine_pause (\fBxine_t\fP * self)" +.PP +Pause toggle. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Toggle pause mode. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.SS "void xine_play (\fBxine_t\fP * self, char * MRL, int pos)" +.PP +Start to play a stream. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIMRL\fP\fP +Media Resource Location to open +.TP +\fB\fIpos\fP\fP +Start from position (0..65535) +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Open a stream and play it +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIMRL\fP\fP + +.TP +\fB\fIpos\fP\fP + +.SS "void xine_select_audio_channel (\fBxine_t\fP * self, int channel)" +.PP +Set audio channel. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Set desired audio channel. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIchannel\fP\fP + +.SS "void xine_select_spu_channel (\fBxine_t\fP * self, int channel)" +.PP +Set sub-title channel. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Set desired sub-title channel. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIchannel\fP\fP + +.SS "void xine_stop (\fBxine_t\fP * self)" +.PP +Stop playing. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.PP +\fBReturns: \fP +.in +1c +Nothing +.PP +Stop the playback. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +
\ No newline at end of file diff --git a/doc/man/en/man3/xine_t.3 b/doc/man/en/man3/xine_t.3 new file mode 100644 index 000000000..1501ba3e7 --- /dev/null +++ b/doc/man/en/man3/xine_t.3 @@ -0,0 +1,23 @@ +.TH "xine_t" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +xine_t \- +.SH SYNOPSIS +.br +.PP +\fC#include <xine.h>\fP +.PP +.SH "DETAILED DESCRIPTION" +.PP +Opaque data type. +.PP +\fBSee also: \fP +.in +1c +\fBxine_load_audio_output_plugin\fP +.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/xine_version.3 b/doc/man/en/man3/xine_version.3 new file mode 100644 index 000000000..6256448a0 --- /dev/null +++ b/doc/man/en/man3/xine_version.3 @@ -0,0 +1,108 @@ +.TH "Version functions" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Version functions \- +.SS "Functions" + +.in +1c +.ti -1c +.RI "char* \fBxine_get_str_version\fP (void)" +.br +.RI "\fIreturn string version, like '0.5.0'.\fP" +.ti -1c +.RI "int \fBxine_get_major_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_get_minor_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_get_sub_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_check_version\fP (int major, int minor, int sub)" +.br +.RI "\fIcheck minimal version.\fP" +.in -1c +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "int xine_check_version (int major, int minor, int sub)" +.PP +check minimal version. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fImajor\fP\fP +major version wanted. +.TP +\fB\fIminorr\fP\fP +minor version wanted. +.TP +\fB\fIsub\fP\fP +sub version wanted. +.PP +\fBReturns: \fP +.in +1c +1 if installed version is >= to desired, otherwise 0 +.PP +Compare version numbers with xine installed version. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fImajor\fP\fP + +.TP +\fB\fIminor\fP\fP + +.TP +\fB\fIsub\fP\fP + +.SS "int xine_get_major_version (void)" +.PP +return version information. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +major version. +.SS "int xine_get_minor_version (void)" +.PP +return version information. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +minor version. +.SS "char * xine_get_str_version (void)" +.PP +return string version, like '0.5.0'. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +string version +.SS "int xine_get_sub_version (void)" +.PP +return version information. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +sub version.
\ No newline at end of file diff --git a/doc/man/en/xine-lib.3 b/doc/man/en/xine-lib.3 new file mode 100644 index 000000000..5a43ee604 --- /dev/null +++ b/doc/man/en/xine-lib.3 @@ -0,0 +1,68 @@ +.\" -*-Nroff-*- +.\"" +.TH XINE 3x 2000-11-19 "The xine project" +.SH NAME +xine-lib \- xine API. +.SH AVAILABLE MAN PAGES +.B ao_functions_t + +.B autoplay_group + +.B browse_group + +.B build_info + +.B cfg_data_t + +.B config_group + +.B config_values_s + +.B config_values_t + +.B demux_strategy + +.B event_group + +.B loadplugins_group + +.B mrl_t + +.B mrl_types + +.B status_group + +.B ui_callbacks + +.B version_group + +.B video_cap + +.B video_group + +.B video_prop + +.B video_ratio + +.B visual_types + +.B vo_driver_s + +.B vo_driver_t + +.B vo_frame_t + +.B vo_overlay_t + +.B xine.h + +.B xine_api + +.B xine_init + +.B xine_management + +.B xine_t + +.B xine_version + diff --git a/doc/man/en/xine-lib.3.in b/doc/man/en/xine-lib.3.in index ed4428128..78a1500da 100644 --- a/doc/man/en/xine-lib.3.in +++ b/doc/man/en/xine-lib.3.in @@ -1,173 +1,6 @@ .\" -*-Nroff-*- .\"" .TH XINE 3x 2000-11-19 "The xine project" -.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection -.\" other parms are allowed: see man(7), man(1) -.\"" .SH NAME -xine \- MPEG2/MPEG1 audio/video player -.SH SYNOPSIS -.B xine -.I "[options] [MRL] ..." -.SH "DESCRIPTION" -This manual page documents briefly the -.BR xine -audio/video player. -.PP -.B xine -plays MPEG system streams, synchronizing audio and video substreams. It -can play streams from files, Video CDs, DVDs and other sources. -.SH OPTIONS -The programs follow the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options are included below. -For a complete description, see the README and FAQ in @prefix@/share/doc/xine -or on the xine home page. -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-s, \-\-shared\-memory -Use X shared memory extension for output. -.br -This may be useful if you experience -problems using the Xv extension. Xv is used as default, if it is available. -Since Xv is hardware accelerated, it usually provides more features and -better performance. -.TP -.B \-a, \-\-audio\-channel <num> -Select the given audio channel. <num> is the audio channel number, default -is "0". -.br -For MPEG2-Streams, AC3 audio streams are numbered from 0 to 7, while MPEG -audio streams are numbered from 8 to 15 and lpcm audio streams are -numbered 16 to 23 (provided that there are this many audio substreams, -of course). Finding the right audio stream might needs some experimenting, -as some mp2-streams contain audio in strange tracks (track 0 and 1 may -be empty but track 2 contains valid audio, for example). -.TP -.B \-A, \-\-audio\-driver <drv> -Select audio driver. Valid drivers are "oss", "alsa", "esd" or "null". The -default is to use ESD when the "ESPEAKER" environment variable is set, -otherwise ALSA if present, otherwise OSS. The "null" driver may be used to -disable audio output, eg. if there are problems with your sound card. -.TP -.B \-u, \-\-spu\-channel <num> -Select subpicture (subtitle) channel. <num> is the subpicture channel -id, default is no subtitle (-1). -.TP -.B \-S, \-\-spdif -Enable AC3 output via SPDIF. Works only on some ALSA drivers that support -the AC3 passthrough feature. -.TP -.B \-p[f][h][q][d][v] -Start playing immediately after start. Can be followed by "f" to turn -on fullscreen mode and/or "h" to hide GUI, and/or by "q" for quitting -at the end. It is also possible to request the playlist from DVD 'd', -or VCD 'v'. -.TP -.B MRL (media resource locator) -.br -MRLs are similar to URLs in your web browser. They describe the media -to read from. valid MRLs may be plain file names or one of the following: -.BR file://<path> -.br -.BR fifo://<path> -.br -.BR stdin://mpeg1 -or -.BR "stdin://mpeg2" -.br -.BR dvd://VTS_xx_y.VOB -.br -.BR "vcd://<track number>" -.br -.BR "net://???" -.LP -Several MRLs may be specified in order to play a number of consecutive -streams. -.LP -If you don't specify any MRL, you'll have to select a file by drag'n-drop. -Dragging files from the GNOME Midnight Commander (gmc) is known to work. -.SH "SEE ALSO" -The programs are documented fully on the xine home page: -.IR "http://xine.sourceforge.net/" -.SH CONTROL KEYS -Many features can be controlled by pressing control keys. The Key bindings are: -.LP -.BR RETURN : -Play -.br -.BR SPACE -or -.BR P : -Pause -.br -.BR F : -Toggle fullscreen mode (Xv only) -.br -.BR G : -Hide/show the gui. -.br -.BR H : -Hide/show the video output window. -.br -.BR A : -Toggle aspect ratio (AUTO/16:9/4:3/DVB) -.br -.BR C : -Show/hide the video settings window. -.br -.BR E : -Eject the current media. -.br -.BR 0 : -Jump to start of current stream -.br -.BR 1..9 : -Jump to 10%..90% of current stream -.br -.BR PgUp : -Jump to previous stream in playlist -.br -.BR PgDown : -Jump to next stream in playlist -.br -.BR + : -Select next audio channel (may take up to a few seconds to take effect) -.br -.BR - : -Select prev audio channel -.br -.BR Ctrl -Show/hide mouse cursor (only when the GUI is hide) -.br -.BR > -or -.BR . : -Select next sub-title channel. -.br -.BR < -or -.BR , : -Select previous sub-title channel. -.br -.SH Synchronization fine tuning -Some streams have bad timestamps, so synchronization fails. This can be -tweaked using arrow keys: -.br -.BR Left : -press if video runs ahead of audio -.br -.BR Right : -press if video lags behind audio -.br -.BR Home : -press to reset audio/video offset to 0, so stream timestamps are unchanged. - -.SH AUTHOR -This manual page was written by Siggi Langauf <siggi@debian.org>, -for the xine project. Lots of additions by -Guenter Bartsch <guenter@users.sourceforge.net> and -Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> - +xine-lib \- xine API. +.SH AVAILABLE MAN PAGES diff --git a/doc/man/fr/Makefile.am b/doc/man/fr/Makefile.am deleted file mode 100644 index b40770a30..000000000 --- a/doc/man/fr/Makefile.am +++ /dev/null @@ -1,46 +0,0 @@ -mansubdir=/fr/man3 - -man_MANS = xine-lib.3 - -EXTRA_DIST = $(man_MANS) xine-lib.3.in - -install-man3: - $(mkinstalldirs) $(DESTDIR)$(mandir)$(mansubdir) - @list='$(man3_MANS)'; \ - l2='$(man_MANS)'; for i in $$l2; do \ - case "$$i" in \ - *.3*) list="$$list $$i" ;; \ - esac; \ - done; \ - for i in $$list; do \ - if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ - else file=$$i; fi; \ - ext=`echo $$i | sed -e 's/^.*\\.//'`; \ - inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ - inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)$(mansubdir)/$$inst"; \ - $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)$(mansubdir)/$$inst; \ - done - -uninstall-man3: - @list='$(man3_MANS)'; \ - l2='$(man_MANS)'; for i in $$l2; do \ - case "$$i" in \ - *.3*) list="$$list $$i" ;; \ - esac; \ - done; \ - for i in $$list; do \ - ext=`echo $$i | sed -e 's/^.*\\.//'`; \ - inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ - inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " rm -f $(DESTDIR)$(mandir)$(mansubdir)/$$inst"; \ - rm -f $(DESTDIR)$(mandir)$(mansubdir)/$$inst; \ - done - -mostlyclean-generic: - -rm -f *~ \#* .*~ .\#* - -maintainer-clean-generic: - -@echo "This command is intended for maintainers to use;" - -@echo "it deletes files that may require special tools to rebuild." - -rm -f Makefile.in xine-lib.3 diff --git a/doc/man/fr/xine-lib.3.in b/doc/man/fr/xine-lib.3.in deleted file mode 100644 index ef019da07..000000000 --- a/doc/man/fr/xine-lib.3.in +++ /dev/null @@ -1,165 +0,0 @@ -.\" -*-Nroff-*- -.\"" -.TH XINE 3x 2000-11-19 "Le projet xine" -.SH NOM -xine \- Lecteur audio/vidéo MPEG2/MPEG1. -.SH SYNOPSIS -.B xine -.I "[options] [MRL] ..." -.SH DESCRIPTION -Cette page de manuel documente brièvement le lecteur audio/vidéo \fBxine\fP. -.PP -\fBxine\fP lis les flux système MPEG, synchronise les flux audio et vidèo. -Il peux lire les flux a partir de fichiers, CD Vidéo, DVD et d'autres sources. -.SH OPTIONS -Ce programme suis la syntaxe de ligne de commande GNU, avec les longues -options commençant par deux tirets ('-'). -Une list de ces options est incluse plus bas. -Pour une description complète, lisez les fichiers README et FAQ -dans @prefix@/share/doc/xine ou sur la homepage. -.TP -.B \-h, \-\-help -Affiche la liste des options. -.TP -.B \-s, \-\-shared\-memory -utilise l'extension 'X Shared Memory' pour la sortie. -.br -Cela peut être utile si vous rencontrez des problèmes en utilisant -l'extension 'Xv', Xv est utilisée par defaut, si elle est disponible. -Comme Xv est accélérée materiellement, elle offre plus de fonctionnalitées -et de meilleurs performances. -.TP -.B \-a, \-\-audio\-channel <num> -Sélectionne le canal audio spécifié. <num> est le numéro du canal, la valeur -par defaut est '0'. -.br -Pour les flux MPEG2, les flux audio AC3 sont numérotés de 0 à 7, tandis -que les flux MPEG sont numérotés de 8 à 39 (si il y a plusieurs sous -flux audio, bien entendu) -.TP -.B \-A, \-\-audio\-driver <drv> -Sélectionne le pilote audio. Les pilotes valides sont "oss" (defaut), -"alsa", "esd" ou "null". -Par defaut ESD est utilisé si la variable d'environnement "ESPEAKER" -est positionnée, sinon ALSA si présent, ou alors OSS. Le pilote "null" -peut être utilisé pour supprimer la sortie audio, par exemple, si il y -a des problemes avec la carte son. -.TP -.B \-u, \-\-spu\-channel <num> -Sélectionne le canal de subpicture (sous-titres). <num> est le numéro -du canal de subpicture, par défaut il n'y a pas de sous-titre (\-1) -.TP -.B \-S, \-\-spdif -Met en fonction la sortie AC3 via SPDIF. Ne fonctionne qu'avec -certains pilotes ALSA supportant la fonctionnalité AC3 taversante. -.TP -.B \-p[f][h][q][d][v], -Démarre la lecture immédiatement apres l'execution. Peut être suivi -par 'f' pour passer en mode plein écran, et/ou par 'h' pour -masquer le panneau de contrôle, et/ou par 'q' pour quitter -à la fin de la lecture. Il est possible d'obtenir automatiquement -les listes de lecture à partir d'un DVD 'd', ou d'un VCD 'v'. -.TP -.B MRL (media resource locator) -.br -Les MRLs sont similaires aux URLs de votre navigateur internet. Elles -définissent le média à utiliser comme source de lecture. -Les MRLs valides peuvent être les noms de fichiers ou un de ceux qui suis: -.br -.BR file://<chemin> -.br -.BR fifo://<chemin> -.br -.BR stdin://mpeg1 -or -.BR "stdin://mpeg2" -.br -.BR dvd://VTS_xx_y.VOB -.br -.BR "vcd://<numéro piste>" -.br -.BR "net://???" -.LP -Plusieurs MRLs peuvent être spécifiées pour lire un nombre consecutif -de flux. -.LP -Si vous ne spécifiez aucune MRL, vous pourrez sélectionner un fichier -par glisser-lacher. -Glisser des fichiers depuis GNOME Midnight Commander (gmc) est connu -pour fonctionner. -.SH "VOIR AUSSI" -Le programme est complement documenté sur la homepage de xine: -.IR "http://xine.sourceforge.net/" -.SH TOUCHES DE CONTROLE -Beaucoup de fonctions peuvent êtres contrôlées en pressant certaines touches. -La liste de ces touches sont: -.LP -.BR ENTREE : -Lecture -.br -.BR ESPACE -ou -.BR P : -Pause -.br -.BR F : -Bascule plein écran (Xv seulement). -.br -.BR G : -Affiche/masque le panneau de contrôle. -.br -.BR H : -Affiche/masque la fenêtre de sortie. -.br -.BR A : -Bascule du ratio d'aspect (AUTO/16:9/4:3/DVB) -.br -.BR C : -Affiche/masque la fenêtre des réglages vidéo. -.br -.BR E : -Ejecte le média courant. -.br -.BR 0 : -Saute au début du flux courant. -.br -.BR 1..9 : -Saute à 10%..90% du flux courant. -.br -.BR PgUp : -Saute au flux precédent dans la liste de lecture. -.br -.BR PgDown : -Saute au flux suivant dans la liste de lecture. -.br -.BR + : -Sélectionne le canal audio suivant (peux prendre quelques secondes -avant effet). -.br -.BR - : -Sélectionne le canal audio precédent. -.br -.BR Ctrl -Affiche/masque le pointeur de souris (uniquement quand le panneau de -contrôle est masqué). -.br -.BR > -ou -.BR . : -Sélectionne le canal de sous-titres suivant. -.br -.BR < -ou -.BR , : -Sélectionne le canal de sous-titres precédant. -.br -.BR Gauche : -Change négativement la synchronisation A/V. -.br -.BR Droit : -Change positivement la synchronisation A/V. -.br -.BR Début : -Remise à zéro de la synchronisation A/V. -.SH AUTEURS -Cette page de manuel a été écrite par Siggi Langauf <siggi@users.sourceforge.net>, traduite par Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>, pour le projet xine. diff --git a/doc/xine-lib-API.cfg b/doc/xine-lib-API.cfg index 021e283cc..3a6d93659 100644 --- a/doc/xine-lib-API.cfg +++ b/doc/xine-lib-API.cfg @@ -1,7 +1,8 @@ PROJECT_NAME = "XINE, A Free Video Player Project - API reference" -OUTPUT_DIRECTORY = xine-lib-API +HTML_OUTPUT = xine-lib-API/html GENERATE_LATEX = NO -GENERATE_MAN = NO +GENERATE_MAN = YES +MAN_OUTPUT = man/en GENERATE_RTF = NO HTML_HEADER = xine-lib-API/xine_header.html diff --git a/doc/xine-lib-API/Makefile.am b/doc/xine-lib-API/Makefile.am new file mode 100644 index 000000000..d9c437c2d --- /dev/null +++ b/doc/xine-lib-API/Makefile.am @@ -0,0 +1,13 @@ + +SUBDIRS = html + +debug: +install-debug: + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in xine_header.html diff --git a/doc/xine-lib-API/dummy b/doc/xine-lib-API/dummy deleted file mode 100644 index e69de29bb..000000000 --- a/doc/xine-lib-API/dummy +++ /dev/null diff --git a/doc/xine-lib-API/html/Makefile.am b/doc/xine-lib-API/html/Makefile.am new file mode 100644 index 000000000..70ba8c4ae --- /dev/null +++ b/doc/xine-lib-API/html/Makefile.am @@ -0,0 +1,53 @@ +docs_DOCS = group__video__ratio.html group__visual__types.html \ + annotated.html group__xine__api.html doxygen.css \ + group__xine__init.html doxygen.gif group__xine__management.html \ + files.html group__xine__version.html functions.html index.html \ + globals.html modules.html group__autoplay__group.html \ + structao__functions__t.html group__browse__group.html \ + structcfg__data__t.html group__build__info.html \ + structconfig__values__s.html group__config__group.html \ + structconfig__values__t.html group__demux__strategy.html \ + structmrl__t.html group__event__group.html structvo__driver__s.html \ + group__loadplugins__group.html structvo__driver__t.html \ + group__mrl__types.html structvo__frame__t.html \ + group__status__group.html structvo__overlay__t.html \ + group__ui__callbacks.html structxine__t.html \ + group__version__group.html xine_8h-source.html group__video__cap.html \ + xine_8h.html group__video__group.html xine_logo.png \ + group__video__prop.html + +EXTRA_DIST = $(docs_DOCS) + +docdir = $(prefix)/share/doc/xine/xine-lib-API/html + +install-data-local: + @documentations='$(docs_DOCS)'; \ + for doc in $$documentations; do \ + destdir=$(docdir); \ + name=`echo $$doc` \ + dir=$$destdir; \ + $(mkinstalldirs) $$dir; \ + $(INSTALL_DATA) $$doc $$dir/$$name; \ + echo "installing $$doc as $$dir/$$name"; \ + done + +uninstall-local: + @documentations='$(docs_DOCS)'; \ + for doc in $$documentations; do \ + destdir=$(docdir); \ + name=`echo $$doc` \ + dir=$$destdir; \ + rm -f $$dir/$$name; \ + echo "removing $$dir/$$name" ; \ + done + +debug: +install-debug: + +mostlyclean-generic: + -rm -f *~ \#* .*~ .\#* + +maintainer-clean-generic: + -@echo "This command is intended for maintainers to use;" + -@echo "it deletes files that may require special tools to rebuild." + -rm -f Makefile.in diff --git a/doc/xine-lib-API/html/annotated.html b/doc/xine-lib-API/html/annotated.html new file mode 100644 index 000000000..7dd773a46 --- /dev/null +++ b/doc/xine-lib-API/html/annotated.html @@ -0,0 +1,29 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>XINE, A Free Video Player Project - API reference Data Structures</h1>Here are the data structures with brief descriptions:<ul> +<li><a class="el" href="structao__functions__t.html">ao_functions_t</a> +<li><a class="el" href="structcfg__data__t.html">cfg_data_t</a> +<li><a class="el" href="structconfig__values__s.html">config_values_s</a> +<li><a class="el" href="structconfig__values__t.html">config_values_t</a> (Data type of structure <a class="el" href="structconfig__values__s.html">config_values_s</a>) +<li><a class="el" href="structmrl__t.html">mrl_t</a> +<li><a class="el" href="structvo__driver__s.html">vo_driver_s</a> +<li><a class="el" href="structvo__driver__t.html">vo_driver_t</a> (Data type of structure <a class="el" href="structvo__driver__s.html">vo_driver_s</a>) +<li><a class="el" href="structvo__frame__t.html">vo_frame_t</a> +<li><a class="el" href="structvo__overlay__t.html">vo_overlay_t</a> +<li><a class="el" href="structxine__t.html">xine_t</a> +</ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/doxygen.css b/doc/xine-lib-API/html/doxygen.css new file mode 100644 index 000000000..7f8e5b883 --- /dev/null +++ b/doc/xine-lib-API/html/doxygen.css @@ -0,0 +1,20 @@ +H1 { text-align: center; } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #eeeeee } +DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 } +TD.md { background-color: #f2f2ff } +DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold } +DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller } +FONT.keyword { color: #008000 } +FONT.keywordtype { color: #604020 } +FONT.keywordflow { color: #e08000 } +FONT.comment { color: #800000 } +FONT.preprocessor { color: #806020 } +FONT.stringliteral { color: #002080 } +FONT.charliteral { color: #008080 } diff --git a/doc/xine-lib-API/html/doxygen.gif b/doc/xine-lib-API/html/doxygen.gif Binary files differnew file mode 100644 index 000000000..192c83ce0 --- /dev/null +++ b/doc/xine-lib-API/html/doxygen.gif diff --git a/doc/xine-lib-API/html/files.html b/doc/xine-lib-API/html/files.html new file mode 100644 index 000000000..db96ed098 --- /dev/null +++ b/doc/xine-lib-API/html/files.html @@ -0,0 +1,19 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>XINE, A Free Video Player Project - API reference File List</h1>Here is a list of all documented files with brief descriptions:<ul> +<li><a class="el" href="xine_8h.html">xine.h</a> <a href="xine_8h-source.html">[code]</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/functions.html b/doc/xine-lib-API/html/functions.html new file mode 100644 index 000000000..83f056865 --- /dev/null +++ b/doc/xine-lib-API/html/functions.html @@ -0,0 +1,41 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>XINE, A Free Video Player Project - API reference Data Fields</h1>Here is a list of all documented struct and union fields with links to the structures/unions they belong to:<ul> +<li>alloc_frame +: <a class="el" href="structvo__driver__s.html#m1">vo_driver_s</a><li>data +: <a class="el" href="structconfig__values__s.html#m6">config_values_s</a><li>display_frame +: <a class="el" href="structvo__driver__s.html#m3">vo_driver_s</a><li>exit +: <a class="el" href="structvo__driver__s.html#m9">vo_driver_s</a><li>get_capabilities +: <a class="el" href="structvo__driver__s.html#m0">vo_driver_s</a><li>get_property +: <a class="el" href="structvo__driver__s.html#m5">vo_driver_s</a><li>get_property_min_max +: <a class="el" href="structvo__driver__s.html#m7">vo_driver_s</a><li>gui_data_exchange +: <a class="el" href="structvo__driver__s.html#m8">vo_driver_s</a><li>link +: <a class="el" href="structmrl__t.html#m2">mrl_t</a><li>lookup_int +: <a class="el" href="structconfig__values__s.html#m1">config_values_s</a><li>lookup_str +: <a class="el" href="structconfig__values__s.html#m0">config_values_s</a><li>mrl +: <a class="el" href="structmrl__t.html#m1">mrl_t</a><li>origin +: <a class="el" href="structmrl__t.html#m0">mrl_t</a><li>overlay_blend +: <a class="el" href="structvo__driver__s.html#m4">vo_driver_s</a><li>read +: <a class="el" href="structconfig__values__s.html#m5">config_values_s</a><li>save +: <a class="el" href="structconfig__values__s.html#m4">config_values_s</a><li>set_int +: <a class="el" href="structconfig__values__s.html#m3">config_values_s</a><li>set_property +: <a class="el" href="structvo__driver__s.html#m6">vo_driver_s</a><li>set_str +: <a class="el" href="structconfig__values__s.html#m2">config_values_s</a><li>size +: <a class="el" href="structmrl__t.html#m4">mrl_t</a><li>type +: <a class="el" href="structmrl__t.html#m3">mrl_t</a><li>update_frame_format +: <a class="el" href="structvo__driver__s.html#m2">vo_driver_s</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/globals.html b/doc/xine-lib-API/html/globals.html new file mode 100644 index 000000000..45f2a01ca --- /dev/null +++ b/doc/xine-lib-API/html/globals.html @@ -0,0 +1,110 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>XINE, A Free Video Player Project - API reference Globals</h1>Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:<ul> +<li>ASPECT_ANAMORPHIC +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>ASPECT_AUTO +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>ASPECT_DVB +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>ASPECT_FULL +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>config_file_init() +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>DEMUX_CONTENT_STRATEGY +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>DEMUX_DEFAULT_STRATEGY +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>DEMUX_EXTENSION_STRATEGY +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>DEMUX_REVERT_STRATEGY +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>event_listener_t +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>event_t +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>gui_branched_cb_t +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>gui_get_next_mrl_cb_t +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>gui_stream_end_cb_t +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>MRL_DUPLICATE +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>mrl_dvd +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>mrl_file +: <a class="el" href="xine_8h.html#a6">xine.h</a><li>mrl_file_backup +: <a class="el" href="xine_8h.html#a15">xine.h</a><li>mrl_file_blockdev +: <a class="el" href="xine_8h.html#a10">xine.h</a><li>mrl_file_chardev +: <a class="el" href="xine_8h.html#a8">xine.h</a><li>mrl_file_directory +: <a class="el" href="xine_8h.html#a9">xine.h</a><li>mrl_file_exec +: <a class="el" href="xine_8h.html#a14">xine.h</a><li>mrl_file_fifo +: <a class="el" href="xine_8h.html#a7">xine.h</a><li>mrl_file_hidden +: <a class="el" href="xine_8h.html#a16">xine.h</a><li>mrl_file_normal +: <a class="el" href="xine_8h.html#a11">xine.h</a><li>mrl_file_sock +: <a class="el" href="xine_8h.html#a13">xine.h</a><li>mrl_file_symlink +: <a class="el" href="xine_8h.html#a12">xine.h</a><li>mrl_net +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>mrl_rtp +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>mrl_stdin +: <a class="el" href="xine_8h.html#a5">xine.h</a><li>mrl_unknown +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>mrl_vcd +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>MRL_ZERO +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>MRLS_DUPLICATE +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>VISUAL_TYPE_AA +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>VISUAL_TYPE_FB +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>VISUAL_TYPE_GTK +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>VISUAL_TYPE_X11 +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>VO_CAP_BRIGHTNESS +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>VO_CAP_COLORKEY +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>VO_CAP_CONTRAST +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>VO_CAP_HUE +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>VO_CAP_SATURATION +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>VO_NUM_PROPERTIES +: <a class="el" href="xine_8h.html#a7">xine.h</a><li>VO_PROP_ASPECT_RATIO +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>VO_PROP_BRIGHTNESS +: <a class="el" href="xine_8h.html#a5">xine.h</a><li>VO_PROP_COLORKEY +: <a class="el" href="xine_8h.html#a6">xine.h</a><li>VO_PROP_CONTRAST +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>VO_PROP_HUE +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>VO_PROP_INTERLACED +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>VO_PROP_SATURATION +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>XINE_BUILD_CC +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>XINE_BUILD_DATE +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>XINE_BUILD_OS +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>xine_check_version() +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>xine_eject() +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>xine_exit() +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>xine_get_audio_channel() +: <a class="el" href="xine_8h.html#a6">xine.h</a><li>xine_get_autoplay_input_plugin_ids() +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>xine_get_autoplay_mrls() +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>xine_get_browsable_input_plugin_ids() +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>xine_get_browse_mrls() +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>xine_get_current_position() +: <a class="el" href="xine_8h.html#a5">xine.h</a><li>xine_get_major_version() +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>xine_get_minor_version() +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>xine_get_spu_channel() +: <a class="el" href="xine_8h.html#a8">xine.h</a><li>xine_get_status() +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>xine_get_str_version() +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>xine_get_sub_version() +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>xine_init() +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>xine_list_audio_output_plugins() +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>xine_list_video_output_plugins() +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>xine_load_audio_output_plugin() +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>xine_load_video_output_plugin() +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>XINE_MAJOR_VERSION +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>XINE_MINOR_VERSION +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>XINE_PAUSE +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>xine_pause() +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>XINE_PLAY +: <a class="el" href="xine_8h.html#a1">xine.h</a><li>xine_play() +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>XINE_PLUGINDIR +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>XINE_QUIT +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>xine_register_event_listener() +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>xine_remove_event_listener() +: <a class="el" href="xine_8h.html#a3">xine.h</a><li>xine_select_audio_channel() +: <a class="el" href="xine_8h.html#a7">xine.h</a><li>xine_select_spu_channel() +: <a class="el" href="xine_8h.html#a9">xine.h</a><li>xine_send_event() +: <a class="el" href="xine_8h.html#a4">xine.h</a><li>XINE_SKINDIR +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>XINE_STOP +: <a class="el" href="xine_8h.html#a0">xine.h</a><li>xine_stop() +: <a class="el" href="xine_8h.html#a2">xine.h</a><li>XINE_SUB_VERSION +: <a class="el" href="xine_8h.html#a2">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__autoplay__group.html b/doc/xine-lib-API/html/group__autoplay__group.html new file mode 100644 index 000000000..8a2ac229c --- /dev/null +++ b/doc/xine-lib-API/html/group__autoplay__group.html @@ -0,0 +1,149 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Autoplay support</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="autoplay_group::xine_get_autoplay_input_plugin_ids"></a> +char** </td><td valign=bottom><a class="el" href="group__autoplay__group.html#a0">xine_get_autoplay_input_plugin_ids</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Request playlist from plugin.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="autoplay_group::xine_get_autoplay_mrls"></a> +char** </td><td valign=bottom><a class="el" href="group__autoplay__group.html#a1">xine_get_autoplay_mrls</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *plugin_id, int *num_mrls)</td></tr> +<tr><td> </td><td><font size=-1><em>Request MRL list from plugin.</em></font><br><br></td></tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a0" doxytag="xine.h::xine_get_autoplay_input_plugin_ids"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ** xine_get_autoplay_input_plugin_ids ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Request playlist from plugin. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Playlist. +<p> +</dl>Some input plugins can generate autoplay lists returns a list of ids of these plugins. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_get_autoplay_mrls"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ** xine_get_autoplay_mrls ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>plugin_id</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int * <em>num_mrls</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Request MRL list from plugin. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>plugin_id</em> + </td><td> +Plugin name ( see <a class="el" href="xine_8h.html#a0">xine_get_autoplay_input_plugin_ids</a>() ) </td></tr> +<tr><td valign=top><em>num_mrls</em> + </td><td> +Entries in return array. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +MRL list. +<p> +</dl>Get autoplay MRL list for input plugin named <plugin_id>. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>plugin_id</em> + </td><td> + </td></tr> +<tr><td valign=top><em>num_mrls</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__browse__group.html b/doc/xine-lib-API/html/group__browse__group.html new file mode 100644 index 000000000..e693bb0e9 --- /dev/null +++ b/doc/xine-lib-API/html/group__browse__group.html @@ -0,0 +1,285 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Browsing support</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Modules</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__mrl__types.html">Types of available mrls</a></td></tr> +<tr><td colspan=2><br><h2>Data Structures</h2></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structmrl__t.html">mrl_t</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structmrl__t.html">mrl_t</a></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="browse_group::MRL_ZERO"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a2">MRL_ZERO</a>(m)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="browse_group::MRL_DUPLICATE"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a3">MRL_DUPLICATE</a>(s, d)</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="browse_group::MRLS_DUPLICATE"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a4">MRLS_DUPLICATE</a>(s, d)</td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="browse_group::xine_get_browsable_input_plugin_ids"></a> +char** </td><td valign=bottom><a class="el" href="group__browse__group.html#a0">xine_get_browsable_input_plugin_ids</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Request list of browsable featured plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="browse_group::xine_get_browse_mrls"></a> +<a class="el" href="structmrl__t.html">mrl_t</a>** </td><td valign=bottom><a class="el" href="group__browse__group.html#a1">xine_get_browse_mrls</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *plugin_id, char *start_mrl, int *num_mrls)</td></tr> +<tr><td> </td><td><font size=-1><em>Request available MRLs from plugins.</em></font><br><br></td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a4" doxytag="xine.h::MRLS_DUPLICATE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define MRLS_DUPLICATE( + </b></td> + <td valign="bottom"><b> +s, d ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre> { \ + <font class="keywordtype">int</font> i = 0; \ + \ + assert((s) != NULL); \ + assert((d) != NULL); \ + \ + <font class="keywordflow">while</font>((s) != NULL) { \ + d[i] = (<a class="code" href="structmrl__t.html">mrl_t</a> *) malloc(<font class="keyword">sizeof</font>(<a class="code" href="structmrl__t.html">mrl_t</a>)); \ + <a class="code" href="xine_8h.html#a3">MRL_DUPLICATE</a>(s[i], d[i]); \ + i++; \ + } \ +}</pre></div>Duplicate two arrays of mrls (s = source, d = destination). <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a>, <a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>() </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::MRL_DUPLICATE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define MRL_DUPLICATE( + </b></td> + <td valign="bottom"><b> +s, d ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Duplicate two mrls entries (s = source, d = destination). <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a>, <a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>() </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::MRL_ZERO"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define MRL_ZERO( + </b></td> + <td valign="bottom"><b> +m ) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<b>Value:</b><div class="fragment"><pre> { \ + <font class="keywordflow">if</font>((m)) { \ + <font class="keywordflow">if</font>((m)->origin) \ + free((m)->origin); \ + <font class="keywordflow">if</font>((m)->mrl) \ + free((m)->mrl); \ + <font class="keywordflow">if</font>((m)->link) \ + free((m)->link); \ + (m)->origin = NULL; \ + (m)->mrl = NULL; \ + (m)->link = NULL; \ + (m)->type = 0; \ + (m)->size = (off_t) 0; \ + } \ +}</pre></div>Freeing/zeroing all of entries of given mrl. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a>, <a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>() </dl> </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a0" doxytag="xine.h::xine_get_browsable_input_plugin_ids"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ** xine_get_browsable_input_plugin_ids ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Request list of browsable featured plugins. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +List of plugins +<p> +</dl>Some input plugins are browseable, get the list of ids of these plugins. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_get_browse_mrls"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structmrl__t.html">mrl_t</a> ** xine_get_browse_mrls ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>plugin_id</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>start_mrl</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int * <em>num_mrls</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Request available MRLs from plugins. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>plugin_id</em> + </td><td> +Plugin name ( see <a class="el" href="xine_8h.html#a0">xine_get_browsable_input_plugin_ids</a>() ) </td></tr> +<tr><td valign=top><em>start_mrl</em> + </td><td> +MRL </td></tr> +<tr><td valign=top><em>num_mrl</em> + </td><td> +how many mrls was found </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +start_mrl on success, NULL on failure. +<p> +</dl>Asks input plugin named <plugin_id> to return a list of available MRLs in domain/directory <start_mrl>. +<p> +<start_mrl> may be NULL indicating the toplevel domain/dir returns <start_mrl> if <start_mrl> is a valid MRL, not a directory returns NULL if <start_mrl> is an invalid MRL, not even a directory. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>plugin_id</em> + </td><td> + </td></tr> +<tr><td valign=top><em>start_mrl</em> + </td><td> + </td></tr> +<tr><td valign=top><em>num_mrls</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__build__info.html b/doc/xine-lib-API/html/group__build__info.html new file mode 100644 index 000000000..47d1cc38b --- /dev/null +++ b/doc/xine-lib-API/html/group__build__info.html @@ -0,0 +1,96 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Build informations</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="build_info::XINE_BUILD_CC"></a> +#define </td><td valign=bottom><a class="el" href="group__build__info.html#a0">XINE_BUILD_CC</a> "gcc version 2.95.3 20010315 (release)"</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="build_info::XINE_BUILD_OS"></a> +#define </td><td valign=bottom><a class="el" href="group__build__info.html#a1">XINE_BUILD_OS</a> "Linux 2.4.5 i686"</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="build_info::XINE_BUILD_DATE"></a> +#define </td><td valign=bottom><a class="el" href="group__build__info.html#a2">XINE_BUILD_DATE</a> "Thu 26 Jul 2001 09:17:10"</td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a0" doxytag="xine.h::XINE_BUILD_CC"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_BUILD_CC "gcc version 2.95.3 20010315 (release)" + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compiler used to build xine-lib </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::XINE_BUILD_DATE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_BUILD_DATE "Thu 26 Jul 2001 09:17:10" + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Build time </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::XINE_BUILD_OS"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_BUILD_OS "Linux 2.4.5 i686" + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +OS used to build xine-lib </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__config__group.html b/doc/xine-lib-API/html/group__config__group.html new file mode 100644 index 000000000..c3415eb01 --- /dev/null +++ b/doc/xine-lib-API/html/group__config__group.html @@ -0,0 +1,36 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Configuration structure type.</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Data Structures</h2></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structao__functions__t.html">ao_functions_t</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structcfg__data__t.html">cfg_data_t</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structconfig__values__s.html">config_values_s</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structconfig__values__s.html">config_values_s</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structconfig__values__t.html">config_values_t</a></td></tr> +<tr><td> </td><td><font size=-1><em>Data type of structure <a class="el" href="structconfig__values__s.html">config_values_s</a>.</em> <a href="structconfig__values__t.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structxine__t.html">xine_t</a></td></tr> +<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="config_group::xine_t"></a> +typedef void </td><td valign=bottom><b>xine_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="config_group::ao_functions_t"></a> +typedef void </td><td valign=bottom><b>ao_functions_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="config_group::cfg_data_t"></a> +typedef void </td><td valign=bottom><b>cfg_data_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="config_group::config_values_t"></a> +typedef struct <a class="el" href="structconfig__values__s.html">config_values_s</a> </td><td valign=bottom><b>config_values_t</b></td></tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__demux__strategy.html b/doc/xine-lib-API/html/group__demux__strategy.html new file mode 100644 index 000000000..e496bd94a --- /dev/null +++ b/doc/xine-lib-API/html/group__demux__strategy.html @@ -0,0 +1,132 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Possible demuxer guessing strategy.</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="demux_strategy::DEMUX_DEFAULT_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a0">DEMUX_DEFAULT_STRATEGY</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="demux_strategy::DEMUX_REVERT_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a1">DEMUX_REVERT_STRATEGY</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="demux_strategy::DEMUX_CONTENT_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a2">DEMUX_CONTENT_STRATEGY</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="demux_strategy::DEMUX_EXTENSION_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a3">DEMUX_EXTENSION_STRATEGY</a> 3</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +"demux_strategy" should be set to one of these value in configuration file ( see <a href="group__config__group.html">Configuration structure type.</a>) before <a class="el" href="xine_8h.html#a1">xine_init</a>() call. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__t.html">config_values_t</a> </dl><hr><h2>Define Documentation</h2> +<a name="a2" doxytag="xine.h::DEMUX_CONTENT_STRATEGY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define DEMUX_CONTENT_STRATEGY 2 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Recognize by content only. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__t.html">config_values_t</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::DEMUX_DEFAULT_STRATEGY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define DEMUX_DEFAULT_STRATEGY 0 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Recognize by content then by extension. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__t.html">config_values_t</a> </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::DEMUX_EXTENSION_STRATEGY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define DEMUX_EXTENSION_STRATEGY 3 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Recognize by extension only. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__t.html">config_values_t</a> </dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::DEMUX_REVERT_STRATEGY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define DEMUX_REVERT_STRATEGY 1 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Recognize by extension then by content. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__t.html">config_values_t</a> </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__event__group.html b/doc/xine-lib-API/html/group__event__group.html new file mode 100644 index 000000000..4e4fbd6d5 --- /dev/null +++ b/doc/xine-lib-API/html/group__event__group.html @@ -0,0 +1,286 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Sending events</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="event_group::event_t"></a> +typedef void </td><td valign=bottom><a class="el" href="group__event__group.html#a0">event_t</a></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="event_group::event_listener_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__event__group.html#a1">event_listener_t</a> )(<a class="el" href="structxine__t.html">xine_t</a> *xine, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data)</td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="event_group::xine_register_event_listener"></a> +int </td><td valign=bottom><a class="el" href="group__event__group.html#a2">xine_register_event_listener</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a1">event_listener_t</a> listener)</td></tr> +<tr><td> </td><td><font size=-1><em>registers an event listener callback.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="event_group::xine_remove_event_listener"></a> +int </td><td valign=bottom><a class="el" href="group__event__group.html#a3">xine_remove_event_listener</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a1">event_listener_t</a> listener)</td></tr> +<tr><td> </td><td><font size=-1><em>Attempts to remove a registered event listener.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="event_group::xine_send_event"></a> +void </td><td valign=bottom><a class="el" href="group__event__group.html#a4">xine_send_event</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data)</td></tr> +<tr><td> </td><td><font size=-1><em>sends an event to all listeners.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Event dispatcher mechanism <hr><h2>Typedef Documentation</h2> +<a name="a1" doxytag="xine.h::event_listener_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef void(* event_listener_t)(<a class="el" href="structxine__t.html">xine_t</a> *xine, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Event listener callback. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a2">xine_register_event_listener</a>, <a class="el" href="group__event__group.html#a3">xine_remove_event_listener</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::event_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef void event_t + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Opaque data type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a1">event_listener_t</a>, <a class="el" href="group__event__group.html#a4">xine_send_event</a> </dl> </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a2" doxytag="xine.h::xine_register_event_listener"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_register_event_listener ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> <em>listener</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +registers an event listener callback. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> +callback function. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 if the listener was registerd, non-zero if it could not. </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::xine_remove_event_listener"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_remove_event_listener ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> <em>listener</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Attempts to remove a registered event listener. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> +callback function. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 if the listener was removes, non-zero if it wasn't (e.g. not found). </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="xine.h::xine_send_event"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_send_event ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="group__event__group.html#a0">event_t</a> * <em>event</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void * <em>data</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sends an event to all listeners. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>event</em> + </td><td> +FILLME </td></tr> +<tr><td valign=top><em>data</em> + </td><td> +FILLME. </td></tr> +</table> +</dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a0">event_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>event</em> + </td><td> + </td></tr> +<tr><td valign=top><em>data</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__loadplugins__group.html b/doc/xine-lib-API/html/group__loadplugins__group.html new file mode 100644 index 000000000..e4e3eb992 --- /dev/null +++ b/doc/xine-lib-API/html/group__loadplugins__group.html @@ -0,0 +1,287 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Loading plugins</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Modules</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__visual__types.html">Valid visual types</a></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="loadplugins_group::XINE_PLUGINDIR"></a> +#define </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a4">XINE_PLUGINDIR</a> "/usr/local/lib/xine/plugins"</td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="loadplugins_group::xine_list_video_output_plugins"></a> +char** </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a> (int visual_type)</td></tr> +<tr><td> </td><td><font size=-1><em>list available video output plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="loadplugins_group::xine_load_video_output_plugin"></a> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a>* </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a> (<a class="el" href="structconfig__values__t.html">config_values_t</a> *config, char *id, int visual_type, void *visual)</td></tr> +<tr><td> </td><td><font size=-1><em>load a specific video output plugin.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="loadplugins_group::xine_list_audio_output_plugins"></a> +char** </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a2">xine_list_audio_output_plugins</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>generate a list of all available audio output plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="loadplugins_group::xine_load_audio_output_plugin"></a> +<a class="el" href="structao__functions__t.html">ao_functions_t</a>* </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a3">xine_load_audio_output_plugin</a> (<a class="el" href="structconfig__values__t.html">config_values_t</a> *config, char *id)</td></tr> +<tr><td> </td><td><font size=-1><em>load a specific audio output plugin.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +output plugin load support functions <hr><h2>Define Documentation</h2> +<a name="a4" doxytag="xine.h::XINE_PLUGINDIR"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_PLUGINDIR "/usr/local/lib/xine/plugins" + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Plugin files location. </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a2" doxytag="xine.h::xine_list_audio_output_plugins"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ** xine_list_audio_output_plugins ( + </b></td> + <td valign="bottom"><b> +void ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +generate a list of all available audio output plugins. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +a list of available audio output plugins the list returned is sorted by plugin priority </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::xine_list_video_output_plugins"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ** xine_list_video_output_plugins ( + </b></td> + <td valign="bottom"><b> +int <em>visual_type</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +list available video output plugins. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>visual_type</em> + </td><td> +see <a href="group__visual__types.html">Valid visual types</a> </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +a list of available video output plugins for the specified visual type - the list is sorted by plugin priority </dl><dl compact><dt> +<b>See also: </b><dd> +<a href="group__visual__types.html">Valid visual types</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>visual_type</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::xine_load_audio_output_plugin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structao__functions__t.html">ao_functions_t</a> * xine_load_audio_output_plugin ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structconfig__values__t.html">config_values_t</a> * <em>config</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>id</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +load a specific audio output plugin. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>config</em> + </td><td> +current configuration ( see <a class="el" href="xine_8h.html#a0">config_file_init</a>() ) </td></tr> +<tr><td valign=top><em>id</em> + </td><td> +driver name. </td></tr> +</table> +</dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structao__functions__t.html">ao_functions_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>config</em> + </td><td> + </td></tr> +<tr><td valign=top><em>id</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_load_video_output_plugin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> * xine_load_video_output_plugin ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structconfig__values__t.html">config_values_t</a> * <em>config</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>id</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>visual_type</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void * <em>visual</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +load a specific video output plugin. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>config</em> + </td><td> +current configuration ( see <a class="el" href="xine_8h.html#a0">config_file_init</a>() ) </td></tr> +<tr><td valign=top><em>id</em> + </td><td> +driver name. </td></tr> +<tr><td valign=top><em>visual_type</em> + </td><td> +see <a href="group__visual__types.html">Valid visual types</a> </td></tr> +<tr><td valign=top><em>visual</em> + </td><td> +visual type dependant data pointer. </td></tr> +</table> +</dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a>, <a href="group__visual__types.html">Valid visual types</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>config</em> + </td><td> + </td></tr> +<tr><td valign=top><em>id</em> + </td><td> + </td></tr> +<tr><td valign=top><em>visual_type</em> + </td><td> + </td></tr> +<tr><td valign=top><em>visual</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__mrl__types.html b/doc/xine-lib-API/html/group__mrl__types.html new file mode 100644 index 000000000..231128681 --- /dev/null +++ b/doc/xine-lib-API/html/group__mrl__types.html @@ -0,0 +1,483 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Types of available mrls</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="mrl_types::mrl_unknown"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a0">mrl_unknown</a> (0 << 0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="mrl_types::mrl_dvd"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a1">mrl_dvd</a> (1 << 0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="mrl_types::mrl_vcd"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a2">mrl_vcd</a> (1 << 1)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="mrl_types::mrl_net"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a3">mrl_net</a> (1 << 2)</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="mrl_types::mrl_rtp"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a4">mrl_rtp</a> (1 << 3)</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="mrl_types::mrl_stdin"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a5">mrl_stdin</a> (1 << 4)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="mrl_types::mrl_file"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a6">mrl_file</a> (1 << 5)</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="mrl_types::mrl_file_fifo"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a7">mrl_file_fifo</a> (1 << 6)</td></tr> +<tr><td nowrap align=right valign=top><a name="a8" doxytag="mrl_types::mrl_file_chardev"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a8">mrl_file_chardev</a> (1 << 7)</td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="mrl_types::mrl_file_directory"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a9">mrl_file_directory</a> (1 << 8)</td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="mrl_types::mrl_file_blockdev"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a10">mrl_file_blockdev</a> (1 << 9)</td></tr> +<tr><td nowrap align=right valign=top><a name="a11" doxytag="mrl_types::mrl_file_normal"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a11">mrl_file_normal</a> (1 << 10)</td></tr> +<tr><td nowrap align=right valign=top><a name="a12" doxytag="mrl_types::mrl_file_symlink"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a12">mrl_file_symlink</a> (1 << 11)</td></tr> +<tr><td nowrap align=right valign=top><a name="a13" doxytag="mrl_types::mrl_file_sock"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a13">mrl_file_sock</a> (1 << 12)</td></tr> +<tr><td nowrap align=right valign=top><a name="a14" doxytag="mrl_types::mrl_file_exec"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a14">mrl_file_exec</a> (1 << 13)</td></tr> +<tr><td nowrap align=right valign=top><a name="a15" doxytag="mrl_types::mrl_file_backup"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a15">mrl_file_backup</a> (1 << 14)</td></tr> +<tr><td nowrap align=right valign=top><a name="a16" doxytag="mrl_types::mrl_file_hidden"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a16">mrl_file_hidden</a> (1 << 15)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +These types are bit field, can be used ORed/ANDed. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl><hr><h2>Define Documentation</h2> +<a name="a1" doxytag="xine.h::mrl_dvd"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_dvd (1 << 0) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +DVD mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a6" doxytag="xine.h::mrl_file"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file (1 << 5) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a15" doxytag="xine.h::mrl_file_backup"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_backup (1 << 14) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Backup file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a10" doxytag="xine.h::mrl_file_blockdev"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_blockdev (1 << 9) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Block device file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a8" doxytag="xine.h::mrl_file_chardev"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_chardev (1 << 7) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Char device file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a9" doxytag="xine.h::mrl_file_directory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_directory (1 << 8) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Directory file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a14" doxytag="xine.h::mrl_file_exec"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_exec (1 << 13) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Executable file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a7" doxytag="xine.h::mrl_file_fifo"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_fifo (1 << 6) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fifo file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a16" doxytag="xine.h::mrl_file_hidden"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_hidden (1 << 15) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Hidden file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a11" doxytag="xine.h::mrl_file_normal"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_normal (1 << 10) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Normal file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a13" doxytag="xine.h::mrl_file_sock"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_sock (1 << 12) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Socket file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a12" doxytag="xine.h::mrl_file_symlink"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_file_symlink (1 << 11) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Soft link file mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::mrl_net"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_net (1 << 2) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Network mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a4" doxytag="xine.h::mrl_rtp"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_rtp (1 << 3) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Multicast mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a5" doxytag="xine.h::mrl_stdin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_stdin (1 << 4) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Standart input mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::mrl_unknown"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_unknown (0 << 0) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Unknow mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::mrl_vcd"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define mrl_vcd (1 << 1) + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VCD mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structmrl__t.html">mrl_t</a> </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__status__group.html b/doc/xine-lib-API/html/group__status__group.html new file mode 100644 index 000000000..c48f13f26 --- /dev/null +++ b/doc/xine-lib-API/html/group__status__group.html @@ -0,0 +1,129 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Player status constants</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="status_group::XINE_STOP"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a0">XINE_STOP</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="status_group::XINE_PLAY"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a1">XINE_PLAY</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="status_group::XINE_PAUSE"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a2">XINE_PAUSE</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="status_group::XINE_QUIT"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a3">XINE_QUIT</a> 3</td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a2" doxytag="xine.h::XINE_PAUSE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_PAUSE 2 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Pause status. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a4">xine_get_status</a>() </dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::XINE_PLAY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_PLAY 1 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Play status. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a4">xine_get_status</a>() </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::XINE_QUIT"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_QUIT 3 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Quit status. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a4">xine_get_status</a>() </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::XINE_STOP"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_STOP 0 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop status. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a4">xine_get_status</a>() </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__ui__callbacks.html b/doc/xine-lib-API/html/group__ui__callbacks.html new file mode 100644 index 000000000..5e4f6d650 --- /dev/null +++ b/doc/xine-lib-API/html/group__ui__callbacks.html @@ -0,0 +1,111 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>UI communication callbacks.</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ui_callbacks::gui_stream_end_cb_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__ui__callbacks.html#a0">gui_stream_end_cb_t</a> )(int nStatus)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ui_callbacks::gui_get_next_mrl_cb_t"></a> +typedef char* (* </td><td valign=bottom><a class="el" href="group__ui__callbacks.html#a1">gui_get_next_mrl_cb_t</a> )(void)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ui_callbacks::gui_branched_cb_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__ui__callbacks.html#a2">gui_branched_cb_t</a> )(void)</td></tr> +</table> +<hr><h2>Typedef Documentation</h2> +<a name="a2" doxytag="xine.h::gui_branched_cb_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef void(* gui_branched_cb_t)(void) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called when xine branched successfully to the next mrl. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">xine_init</a>() </dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::gui_get_next_mrl_cb_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef char *(* gui_get_next_mrl_cb_t)(void) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called when xine tries to branch seamlessly to the next mrl. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">xine_init</a>() </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::gui_stream_end_cb_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef void(* gui_stream_end_cb_t)(int nStatus) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Notify UI when the stream is finished. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">xine_init</a>() </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__version__group.html b/doc/xine-lib-API/html/group__version__group.html new file mode 100644 index 000000000..88c3da9eb --- /dev/null +++ b/doc/xine-lib-API/html/group__version__group.html @@ -0,0 +1,96 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Version constants</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="version_group::XINE_MAJOR_VERSION"></a> +#define </td><td valign=bottom><a class="el" href="group__version__group.html#a0">XINE_MAJOR_VERSION</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="version_group::XINE_MINOR_VERSION"></a> +#define </td><td valign=bottom><a class="el" href="group__version__group.html#a1">XINE_MINOR_VERSION</a> 5</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="version_group::XINE_SUB_VERSION"></a> +#define </td><td valign=bottom><a class="el" href="group__version__group.html#a2">XINE_SUB_VERSION</a> 0</td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a0" doxytag="xine.h::XINE_MAJOR_VERSION"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_MAJOR_VERSION 0 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Major version constant. </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::XINE_MINOR_VERSION"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_MINOR_VERSION 5 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Minor version constant. </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::XINE_SUB_VERSION"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_SUB_VERSION 0 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sub version constant. </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__video__cap.html b/doc/xine-lib-API/html/group__video__cap.html new file mode 100644 index 000000000..980d9a6b2 --- /dev/null +++ b/doc/xine-lib-API/html/group__video__cap.html @@ -0,0 +1,146 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>video driver capabilities</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="video_cap::VO_CAP_HUE"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a0">VO_CAP_HUE</a> 0x00000010</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="video_cap::VO_CAP_SATURATION"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a1">VO_CAP_SATURATION</a> 0x00000020</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="video_cap::VO_CAP_BRIGHTNESS"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a2">VO_CAP_BRIGHTNESS</a> 0x00000040</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="video_cap::VO_CAP_CONTRAST"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a3">VO_CAP_CONTRAST</a> 0x00000080</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="video_cap::VO_CAP_COLORKEY"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a4">VO_CAP_COLORKEY</a> 0x00000100</td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a2" doxytag="xine.h::VO_CAP_BRIGHTNESS"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_CAP_BRIGHTNESS 0x00000040 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Driver can set BRIGHTNESS value. </td> + </tr> +</table> +<a name="a4" doxytag="xine.h::VO_CAP_COLORKEY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_CAP_COLORKEY 0x00000100 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Driver can set COLORKEY value. </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::VO_CAP_CONTRAST"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_CAP_CONTRAST 0x00000080 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Driver can set CONTRAST value. </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::VO_CAP_HUE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_CAP_HUE 0x00000010 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Driver can set HUE value. </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::VO_CAP_SATURATION"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_CAP_SATURATION 0x00000020 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Driver can set SATURATION value. </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__video__group.html b/doc/xine-lib-API/html/group__video__group.html new file mode 100644 index 000000000..8c5c1e566 --- /dev/null +++ b/doc/xine-lib-API/html/group__video__group.html @@ -0,0 +1,37 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Video.</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Modules</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__video__ratio.html">Possible ratios for the VO_PROP_ASPECT_RATIO call</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__video__prop.html">Constants for the get/set properties functions.</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__video__cap.html">video driver capabilities</a></td></tr> +<tr><td colspan=2><br><h2>Data Structures</h2></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvo__driver__s.html">vo_driver_s</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvo__driver__s.html">vo_driver_s</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvo__driver__t.html">vo_driver_t</a></td></tr> +<tr><td> </td><td><font size=-1><em>Data type of structure <a class="el" href="structvo__driver__s.html">vo_driver_s</a>.</em> <a href="structvo__driver__t.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvo__frame__t.html">vo_frame_t</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvo__overlay__t.html">vo_overlay_t</a></td></tr> +<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="video_group::vo_frame_t"></a> +typedef void </td><td valign=bottom><b>vo_frame_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="video_group::vo_overlay_t"></a> +typedef void </td><td valign=bottom><b>vo_overlay_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="video_group::vo_driver_t"></a> +typedef struct <a class="el" href="structvo__driver__s.html">vo_driver_s</a> </td><td valign=bottom><b>vo_driver_t</b></td></tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__video__prop.html b/doc/xine-lib-API/html/group__video__prop.html new file mode 100644 index 000000000..dc5fb4246 --- /dev/null +++ b/doc/xine-lib-API/html/group__video__prop.html @@ -0,0 +1,237 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Constants for the get/set properties functions.</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="video_prop::VO_PROP_INTERLACED"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a0">VO_PROP_INTERLACED</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="video_prop::VO_PROP_ASPECT_RATIO"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a1">VO_PROP_ASPECT_RATIO</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="video_prop::VO_PROP_HUE"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a2">VO_PROP_HUE</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="video_prop::VO_PROP_SATURATION"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a3">VO_PROP_SATURATION</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="video_prop::VO_PROP_CONTRAST"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a4">VO_PROP_CONTRAST</a> 4</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="video_prop::VO_PROP_BRIGHTNESS"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a5">VO_PROP_BRIGHTNESS</a> 5</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="video_prop::VO_PROP_COLORKEY"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a6">VO_PROP_COLORKEY</a> 6</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="video_prop::VO_NUM_PROPERTIES"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a7">VO_NUM_PROPERTIES</a> 7</td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a7" doxytag="xine.h::VO_NUM_PROPERTIES"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_NUM_PROPERTIES 7 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Number of available properties property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::VO_PROP_ASPECT_RATIO"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_ASPECT_RATIO 1 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Aspect ratio property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a>, <a href="group__video__ratio.html">Possible ratios for the VO_PROP_ASPECT_RATIO call</a> </dl> </td> + </tr> +</table> +<a name="a5" doxytag="xine.h::VO_PROP_BRIGHTNESS"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_BRIGHTNESS 5 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Brightness property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<a name="a6" doxytag="xine.h::VO_PROP_COLORKEY"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_COLORKEY 6 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Colorkey property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<a name="a4" doxytag="xine.h::VO_PROP_CONTRAST"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_CONTRAST 4 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Contrast property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::VO_PROP_HUE"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_HUE 2 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Hue property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::VO_PROP_INTERLACED"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_INTERLACED 0 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Interleave property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::VO_PROP_SATURATION"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VO_PROP_SATURATION 3 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Saturation property. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__video__ratio.html b/doc/xine-lib-API/html/group__video__ratio.html new file mode 100644 index 000000000..9f41c3472 --- /dev/null +++ b/doc/xine-lib-API/html/group__video__ratio.html @@ -0,0 +1,132 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Possible ratios for the VO_PROP_ASPECT_RATIO call</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="video_ratio::ASPECT_AUTO"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a0">ASPECT_AUTO</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="video_ratio::ASPECT_ANAMORPHIC"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a1">ASPECT_ANAMORPHIC</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="video_ratio::ASPECT_FULL"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a2">ASPECT_FULL</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="video_ratio::ASPECT_DVB"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a3">ASPECT_DVB</a> 3</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">VO_PROP_ASPECT_RATIO</a>, <a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl><hr><h2>Define Documentation</h2> +<a name="a1" doxytag="xine.h::ASPECT_ANAMORPHIC"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define ASPECT_ANAMORPHIC 1 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set aspect ration to 16:9. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">VO_PROP_ASPECT_RATIO</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::ASPECT_AUTO"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define ASPECT_AUTO 0 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Let video driver guessing aspect ratio. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">VO_PROP_ASPECT_RATIO</a> </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::ASPECT_DVB"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define ASPECT_DVB 3 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set aspect ration to 1:2. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">VO_PROP_ASPECT_RATIO</a> </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::ASPECT_FULL"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define ASPECT_FULL 2 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set aspect ration to 4:3. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">VO_PROP_ASPECT_RATIO</a> </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__visual__types.html b/doc/xine-lib-API/html/group__visual__types.html new file mode 100644 index 000000000..0856dd2e1 --- /dev/null +++ b/doc/xine-lib-API/html/group__visual__types.html @@ -0,0 +1,129 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Valid visual types</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="visual_types::VISUAL_TYPE_X11"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a0">VISUAL_TYPE_X11</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="visual_types::VISUAL_TYPE_AA"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a1">VISUAL_TYPE_AA</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="visual_types::VISUAL_TYPE_FB"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a2">VISUAL_TYPE_FB</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="visual_types::VISUAL_TYPE_GTK"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a3">VISUAL_TYPE_GTK</a> 4</td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a1" doxytag="xine.h::VISUAL_TYPE_AA"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VISUAL_TYPE_AA 2 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Asci Art visual type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a>, <a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a> </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::VISUAL_TYPE_FB"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VISUAL_TYPE_FB 3 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Framebuffer visual type <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a>, <a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a> </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::VISUAL_TYPE_GTK"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VISUAL_TYPE_GTK 4 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +GTK visual type <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a>, <a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::VISUAL_TYPE_X11"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define VISUAL_TYPE_X11 1 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +X11 visual type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a>, <a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a> </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__xine__api.html b/doc/xine-lib-API/html/group__xine__api.html new file mode 100644 index 000000000..3c1b39ffc --- /dev/null +++ b/doc/xine-lib-API/html/group__xine__api.html @@ -0,0 +1,30 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>API functions</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Modules</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__event__group.html">Sending events</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__loadplugins__group.html">Loading plugins</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__autoplay__group.html">Autoplay support</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__browse__group.html">Browsing support</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__xine__management.html">Engine management</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__xine__init.html">Init functions</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__video__group.html">Video.</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__xine__version.html">Version functions</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__version__group.html">Version constants</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__status__group.html">Player status constants</a></td></tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__xine__init.html b/doc/xine-lib-API/html/group__xine__init.html new file mode 100644 index 000000000..164a46b8c --- /dev/null +++ b/doc/xine-lib-API/html/group__xine__init.html @@ -0,0 +1,251 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Init functions</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Modules</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__demux__strategy.html">Possible demuxer guessing strategy.</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__ui__callbacks.html">UI communication callbacks.</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="group__config__group.html">Configuration structure type.</a></td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine_init::config_file_init"></a> +<a class="el" href="structconfig__values__t.html">config_values_t</a>* </td><td valign=bottom><a class="el" href="group__xine__init.html#a0">config_file_init</a> (char *filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Configuration file initialisation.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine_init::xine_init"></a> +<a class="el" href="structxine__t.html">xine_t</a>* </td><td valign=bottom><a class="el" href="group__xine__init.html#a1">xine_init</a> (<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *vo, <a class="el" href="structao__functions__t.html">ao_functions_t</a> *ao, <a class="el" href="structconfig__values__t.html">config_values_t</a> *config, <a class="el" href="xine_8h.html#a0">gui_stream_end_cb_t</a> stream_end_cb, <a class="el" href="xine_8h.html#a1">gui_get_next_mrl_cb_t</a> get_next_mrl_cb, <a class="el" href="xine_8h.html#a2">gui_branched_cb_t</a> branched_cb)</td></tr> +<tr><td> </td><td><font size=-1><em>Initialisation of xine.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine_init::xine_exit"></a> +void </td><td valign=bottom><a class="el" href="group__xine__init.html#a2">xine_exit</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>De-initialisation of xine.</em></font><br><br></td></tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a0" doxytag="xine.h::config_file_init"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structconfig__values__t.html">config_values_t</a> * config_file_init ( + </b></td> + <td valign="bottom"><b> +char * <em>filename</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Configuration file initialisation. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>filename</em> + </td><td> +Pathname of configuration file. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Current config </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__t.html">config_values_t</a> </dl><dl compact><dt> +<b>Warning: </b><dd> +This function should be called at least one time before <a class="el" href="xine_8h.html#a1">xine_init</a>() call. +<p> +</dl>Read config file and init a config object of <a class="el" href="structconfig__values__t.html">config_values_t</a> type (if it exists) <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>filename</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::xine_exit"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_exit ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +De-initialisation of xine. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">xine_init</a>() +<p> +</dl>De-init xine engine. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_init"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structxine__t.html">xine_t</a> * xine_init ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> * <em>vo</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="structao__functions__t.html">ao_functions_t</a> * <em>ao</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="structconfig__values__t.html">config_values_t</a> * <em>config</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="xine_8h.html#a0">gui_stream_end_cb_t</a> <em>stream_end_cb</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="xine_8h.html#a1">gui_get_next_mrl_cb_t</a> <em>get_next_mrl_cb</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="xine_8h.html#a2">gui_branched_cb_t</a> <em>branched_cb</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initialisation of xine. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>vo</em> + </td><td> +video driver ( see <a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a>() ) </td></tr> +<tr><td valign=top><em>ao</em> + </td><td> +audio driver ( see <a class="el" href="group__loadplugins__group.html#a3">xine_load_audio_output_plugin</a>() ) </td></tr> +<tr><td valign=top><em>config</em> + </td><td> +current configuration ( see <a class="el" href="xine_8h.html#a0">config_file_init</a>() ) </td></tr> +<tr><td valign=top><em>stream_end</em> + </td><td> +cb called on stream end </td></tr> +<tr><td valign=top><em>get_next_mrl_cb</em> + </td><td> +called to find out next mrl for seamless branching </td></tr> +<tr><td valign=top><em>branched_cb</em> + </td><td> +called if seamless branch was taken </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Current xine engine configuration </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a>, <a class="el" href="structao__functions__t.html">ao_functions_t</a>, <a class="el" href="structconfig__values__t.html">config_values_t</a>, <a class="el" href="xine_8h.html#a0">gui_stream_end_cb_t</a>, <a class="el" href="xine_8h.html#a1">gui_get_next_mrl_cb_t</a>, <a class="el" href="xine_8h.html#a2">gui_branched_cb_t</a> </dl><dl compact><dt> +<b>Warning: </b><dd> +This function should be called before any other xine_*() function. +<p> +</dl>Init of xine. It should called once at startup. all callbacks may be NULL if ui is not interested in them for whatever reason ao may be NULL for no audio playback <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>vo</em> + </td><td> + </td></tr> +<tr><td valign=top><em>ao</em> + </td><td> + </td></tr> +<tr><td valign=top><em>config</em> + </td><td> + </td></tr> +<tr><td valign=top><em>stream_end_cb</em> + </td><td> + </td></tr> +<tr><td valign=top><em>get_next_mrl_cb</em> + </td><td> + </td></tr> +<tr><td valign=top><em>branched_cb</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__xine__management.html b/doc/xine-lib-API/html/group__xine__management.html new file mode 100644 index 000000000..0741a0136 --- /dev/null +++ b/doc/xine-lib-API/html/group__xine__management.html @@ -0,0 +1,583 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Engine management</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine_management::xine_play"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a0">xine_play</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *MRL, int pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Start to play a stream.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine_management::xine_pause"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a1">xine_pause</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Pause toggle.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine_management::xine_stop"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a2">xine_stop</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine_management::xine_eject"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a3">xine_eject</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Eject media.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine_management::xine_get_status"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a4">xine_get_status</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current xine status.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="xine_management::xine_get_current_position"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a5">xine_get_current_position</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current position.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="xine_management::xine_get_audio_channel"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a6">xine_get_audio_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current audio channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="xine_management::xine_select_audio_channel"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a7">xine_select_audio_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, int channel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set audio channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a8" doxytag="xine_management::xine_get_spu_channel"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a8">xine_get_spu_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current sub-title channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="xine_management::xine_select_spu_channel"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a9">xine_select_spu_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, int channel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set sub-title channel.</em></font><br><br></td></tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a3" doxytag="xine.h::xine_eject"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_eject ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Eject media. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +1 on success, 0 on failure. +<p> +</dl>Tell current input plugin to eject media. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a6" doxytag="xine.h::xine_get_audio_channel"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_audio_channel ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get current audio channel. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Current audio chennel +<p> +</dl>Get current audio channel. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a5" doxytag="xine.h::xine_get_current_position"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_current_position ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get current position. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Current position ( 0..65535 ) +<p> +</dl>Get current position in stream. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a8" doxytag="xine.h::xine_get_spu_channel"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_spu_channel ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get current sub-title channel. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Current sub-title channel +<p> +</dl>Get current sub-title channel. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="xine.h::xine_get_status"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_status ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get current xine status. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Current status ( see <a href="group__status__group.html">Player status constants</a> ) +<p> +</dl>Return the current state of xine engine. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_pause"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_pause ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Pause toggle. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing +<p> +</dl>Toggle pause mode. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::xine_play"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_play ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>MRL</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>pos</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Start to play a stream. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>MRL</em> + </td><td> +Media Resource Location to open </td></tr> +<tr><td valign=top><em>pos</em> + </td><td> +Start from position (0..65535) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing +<p> +</dl>Open a stream and play it <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>MRL</em> + </td><td> + </td></tr> +<tr><td valign=top><em>pos</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a7" doxytag="xine.h::xine_select_audio_channel"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_select_audio_channel ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>channel</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set audio channel. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing +<p> +</dl>Set desired audio channel. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>channel</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a9" doxytag="xine.h::xine_select_spu_channel"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_select_spu_channel ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>channel</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set sub-title channel. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing +<p> +</dl>Set desired sub-title channel. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>channel</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::xine_stop"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_stop ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop playing. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Nothing +<p> +</dl>Stop the playback. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/group__xine__version.html b/doc/xine-lib-API/html/group__xine__version.html new file mode 100644 index 000000000..88a8c0b72 --- /dev/null +++ b/doc/xine-lib-API/html/group__xine__version.html @@ -0,0 +1,269 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Version functions</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine_version::xine_get_str_version"></a> +char* </td><td valign=bottom><a class="el" href="group__xine__version.html#a0">xine_get_str_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return string version, like "0.5.0".</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine_version::xine_get_major_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a1">xine_get_major_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return version information.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine_version::xine_get_minor_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a2">xine_get_minor_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return version information.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine_version::xine_get_sub_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a3">xine_get_sub_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return version information.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine_version::xine_check_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a4">xine_check_version</a> (int major, int minor, int sub)</td></tr> +<tr><td> </td><td><font size=-1><em>check minimal version.</em></font><br><br></td></tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a4" doxytag="xine.h::xine_check_version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_check_version ( + </b></td> + <td valign="bottom"><b> +int <em>major</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>minor</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>sub</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +check minimal version. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>major</em> + </td><td> +major version wanted. </td></tr> +<tr><td valign=top><em>minorr</em> + </td><td> +minor version wanted. </td></tr> +<tr><td valign=top><em>sub</em> + </td><td> +sub version wanted. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +1 if installed version is >= to desired, otherwise 0 +<p> +</dl>Compare version numbers with xine installed version. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>major</em> + </td><td> + </td></tr> +<tr><td valign=top><em>minor</em> + </td><td> + </td></tr> +<tr><td valign=top><em>sub</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="xine.h::xine_get_major_version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_major_version ( + </b></td> + <td valign="bottom"><b> +void ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +return version information. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>None.</em> + </td><td> +</td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +major version. </dl> </td> + </tr> +</table> +<a name="a2" doxytag="xine.h::xine_get_minor_version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_minor_version ( + </b></td> + <td valign="bottom"><b> +void ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +return version information. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>None.</em> + </td><td> +</td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +minor version. </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::xine_get_str_version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * xine_get_str_version ( + </b></td> + <td valign="bottom"><b> +void ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +return string version, like "0.5.0". +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>None.</em> + </td><td> +</td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +string version </dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::xine_get_sub_version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_get_sub_version ( + </b></td> + <td valign="bottom"><b> +void ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +return version information. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>None.</em> + </td><td> +</td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +sub version. </dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/index.html b/doc/xine-lib-API/html/index.html new file mode 100644 index 000000000..799f3f007 --- /dev/null +++ b/doc/xine-lib-API/html/index.html @@ -0,0 +1,19 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>XINE, A Free Video Player Project - API reference Documentation</h1> +<p> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/modules.html b/doc/xine-lib-API/html/modules.html new file mode 100644 index 000000000..cad612429 --- /dev/null +++ b/doc/xine-lib-API/html/modules.html @@ -0,0 +1,49 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>XINE, A Free Video Player Project - API reference Modules</h1>Here is a list of all modules:<ul> +<li><a class="el" href="group__build__info.html">Build informations</a> +<li><a class="el" href="group__xine__api.html">API functions</a> +<ul> +<li><a class="el" href="group__status__group.html">Player status constants</a> +<li><a class="el" href="group__version__group.html">Version constants</a> +<li><a class="el" href="group__xine__version.html">Version functions</a> +<li><a class="el" href="group__video__group.html">Video.</a> +<ul> +<li><a class="el" href="group__video__cap.html">video driver capabilities</a> +<li><a class="el" href="group__video__prop.html">Constants for the get/set properties functions.</a> +<li><a class="el" href="group__video__ratio.html">Possible ratios for the VO_PROP_ASPECT_RATIO call</a> +</ul> +<li><a class="el" href="group__xine__init.html">Init functions</a> +<ul> +<li><a class="el" href="group__config__group.html">Configuration structure type.</a> +<li><a class="el" href="group__ui__callbacks.html">UI communication callbacks.</a> +<li><a class="el" href="group__demux__strategy.html">Possible demuxer guessing strategy.</a> +</ul> +<li><a class="el" href="group__xine__management.html">Engine management</a> +<li><a class="el" href="group__browse__group.html">Browsing support</a> +<ul> +<li><a class="el" href="group__mrl__types.html">Types of available mrls</a> +</ul> +<li><a class="el" href="group__autoplay__group.html">Autoplay support</a> +<li><a class="el" href="group__loadplugins__group.html">Loading plugins</a> +<ul> +<li><a class="el" href="group__visual__types.html">Valid visual types</a> +</ul> +<li><a class="el" href="group__event__group.html">Sending events</a> +</ul> +</ul> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structao__functions__t.html b/doc/xine-lib-API/html/structao__functions__t.html new file mode 100644 index 000000000..3d96d2ecd --- /dev/null +++ b/doc/xine-lib-API/html/structao__functions__t.html @@ -0,0 +1,26 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>ao_functions_t Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Opaque data type. +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structcfg__data__t.html b/doc/xine-lib-API/html/structcfg__data__t.html new file mode 100644 index 000000000..2d84c47a5 --- /dev/null +++ b/doc/xine-lib-API/html/structcfg__data__t.html @@ -0,0 +1,26 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>cfg_data_t Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Opaque data type. +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structconfig__values__s.html b/doc/xine-lib-API/html/structconfig__values__s.html new file mode 100644 index 000000000..bab56ad69 --- /dev/null +++ b/doc/xine-lib-API/html/structconfig__values__s.html @@ -0,0 +1,219 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>config_values_s Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td nowrap align=right valign=top>char* (* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m0">lookup_str</a> )(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, char *str_default)</td></tr> +<tr><td nowrap align=right valign=top>int (* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m1">lookup_int</a> )(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, int n_default)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m2">set_str</a> )(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, char *value)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m3">set_int</a> )(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, int value)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m4">save</a> )(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m5">read</a> )(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *filename)</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="structcfg__data__t.html">cfg_data_t</a>* </td><td valign=bottom><a class="el" href="structconfig__values__s.html#m6">data</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Configuration file manipulation. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a0">config_file_init</a>() </dl> +<p> +<hr><h2>Field Documentation</h2> +<a name="m6" doxytag="config_values_s::data"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structcfg__data__t.html">cfg_data_t</a> * config_values_s::data + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Contains private data of this configuration file. </td> + </tr> +</table> +<a name="m1" doxytag="config_values_s::lookup_int"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int(* config_values_s::lookup_int)(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, int n_default) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Lookup integer values in configuration file. </td> + </tr> +</table> +<a name="m0" doxytag="config_values_s::lookup_str"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char *(* config_values_s::lookup_str)(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, char *str_default) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Lookup string values in configuration file. </td> + </tr> +</table> +<a name="m5" doxytag="config_values_s::read"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* config_values_s::read)(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *filename) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Read configuration file from disk, overriding values in memory. If you also want to clear values that are not in the file, use <a class="el" href="xine_8h.html#a0">config_file_init</a>() instead! </td> + </tr> +</table> +<a name="m4" doxytag="config_values_s::save"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* config_values_s::save)(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Write configuration file to disk. </td> + </tr> +</table> +<a name="m3" doxytag="config_values_s::set_int"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* config_values_s::set_int)(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, int value) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set integer values in configuration file. </td> + </tr> +</table> +<a name="m2" doxytag="config_values_s::set_str"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* config_values_s::set_str)(<a class="el" href="structconfig__values__t.html">config_values_t</a> *self, char *key, char *value) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set string values in configuration file. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structconfig__values__t.html b/doc/xine-lib-API/html/structconfig__values__t.html new file mode 100644 index 000000000..1578c9efd --- /dev/null +++ b/doc/xine-lib-API/html/structconfig__values__t.html @@ -0,0 +1,33 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>config_values_t Struct Reference</h1>Data type of structure <a class="el" href="structconfig__values__s.html">config_values_s</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Data type of structure <a class="el" href="structconfig__values__s.html">config_values_s</a>. +<p> +<dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structconfig__values__s.html">config_values_s</a>. </dl> +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structmrl__t.html b/doc/xine-lib-API/html/structmrl__t.html new file mode 100644 index 000000000..52a4c077b --- /dev/null +++ b/doc/xine-lib-API/html/structmrl__t.html @@ -0,0 +1,165 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>mrl_t Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="structmrl__t.html#m0">origin</a></td></tr> +<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="structmrl__t.html#m1">mrl</a></td></tr> +<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="structmrl__t.html#m2">link</a></td></tr> +<tr><td nowrap align=right valign=top>uint32_t </td><td valign=bottom><a class="el" href="structmrl__t.html#m3">type</a></td></tr> +<tr><td nowrap align=right valign=top>off_t </td><td valign=bottom><a class="el" href="structmrl__t.html#m4">size</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +mrl type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="xine_8h.html#a1">xine_get_browse_mrls</a>(), <a class="el" href="xine_8h.html#a2">MRL_ZERO</a>, <a class="el" href="xine_8h.html#a3">MRL_DUPLICATE</a>, <a class="el" href="xine_8h.html#a4">MRLS_DUPLICATE</a>, <a href="group__mrl__types.html">Types of available mrls</a> </dl> +<p> +<hr><h2>Field Documentation</h2> +<a name="m2" doxytag="mrl_t::link"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * mrl_t::link + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +name of link, if exist, otherwise NULL </td> + </tr> +</table> +<a name="m1" doxytag="mrl_t::mrl"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * mrl_t::mrl + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<type>://<location> </td> + </tr> +</table> +<a name="m0" doxytag="mrl_t::origin"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * mrl_t::origin + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Origin of grabbed mrls (eg: path for file plugin </td> + </tr> +</table> +<a name="m4" doxytag="mrl_t::size"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +off_t mrl_t::size + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +size of this source, may be 0 </td> + </tr> +</table> +<a name="m3" doxytag="mrl_t::type"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +uint32_t mrl_t::type + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +match to mrl_type enum </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structvo__driver__s.html b/doc/xine-lib-API/html/structvo__driver__s.html new file mode 100644 index 000000000..55829ca6d --- /dev/null +++ b/doc/xine-lib-API/html/structvo__driver__s.html @@ -0,0 +1,308 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>vo_driver_s Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td nowrap align=right valign=top>uint32_t (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m0">get_capabilities</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self)</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="structvo__frame__t.html">vo_frame_t</a>* (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m1">alloc_frame</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m2">update_frame_format</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, <a class="el" href="structvo__frame__t.html">vo_frame_t</a> *img, uint32_t width, uint32_t height, int ratio_code, int format)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m3">display_frame</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, <a class="el" href="structvo__frame__t.html">vo_frame_t</a> *vo_img)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m4">overlay_blend</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, <a class="el" href="structvo__frame__t.html">vo_frame_t</a> *vo_img, <a class="el" href="structvo__overlay__t.html">vo_overlay_t</a> *overlay)</td></tr> +<tr><td nowrap align=right valign=top>int (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m5">get_property</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int property)</td></tr> +<tr><td nowrap align=right valign=top>int (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m6">set_property</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int property, int value)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m7">get_property_min_max</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int property, int *min, int *max)</td></tr> +<tr><td nowrap align=right valign=top>int (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m8">gui_data_exchange</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int data_type, void *data)</td></tr> +<tr><td nowrap align=right valign=top>void (* </td><td valign=bottom><a class="el" href="structvo__driver__s.html#m9">exit</a> )(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Video driver fonctions. +<p> +<hr><h2>Field Documentation</h2> +<a name="m1" doxytag="vo_driver_s::alloc_frame"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="structvo__frame__t.html">vo_frame_t</a> *(* vo_driver_s::alloc_frame)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocate an <a class="el" href="structvo__frame__t.html">vo_frame_t</a> struct, the driver must supply the copy, field and dispose functions </td> + </tr> +</table> +<a name="m3" doxytag="vo_driver_s::display_frame"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* vo_driver_s::display_frame)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, <a class="el" href="structvo__frame__t.html">vo_frame_t</a> *vo_img) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Display a given frame </td> + </tr> +</table> +<a name="m9" doxytag="vo_driver_s::exit"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* vo_driver_s::exit)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Leaving video driver. </td> + </tr> +</table> +<a name="m0" doxytag="vo_driver_s::get_capabilities"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +uint32_t(* vo_driver_s::get_capabilities)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get capabilities of video driver. <dl compact><dt> +<b>See also: </b><dd> +<a href="group__video__cap.html">video driver capabilities</a> </dl> </td> + </tr> +</table> +<a name="m5" doxytag="vo_driver_s::get_property"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int(* vo_driver_s::get_property)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int property) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get value if property. <dl compact><dt> +<b>See also: </b><dd> +<a href="group__video__prop.html">Constants for the get/set properties functions.</a> </dl> </td> + </tr> +</table> +<a name="m7" doxytag="vo_driver_s::get_property_min_max"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* vo_driver_s::get_property_min_max)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int property, int *min, int *max) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get min/max values of property. <dl compact><dt> +<b>See also: </b><dd> +<a href="group__video__prop.html">Constants for the get/set properties functions.</a> </dl> </td> + </tr> +</table> +<a name="m8" doxytag="vo_driver_s::gui_data_exchange"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int(* vo_driver_s::gui_data_exchange)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int data_type, void *data) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +General purpose communication channel between gui and driver +<p> +this should be used to propagate events, display data, window sizes etc. to the driver </td> + </tr> +</table> +<a name="m4" doxytag="vo_driver_s::overlay_blend"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* vo_driver_s::overlay_blend)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, <a class="el" href="structvo__frame__t.html">vo_frame_t</a> *vo_img, <a class="el" href="structvo__overlay__t.html">vo_overlay_t</a> *overlay) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Overlay functions </td> + </tr> +</table> +<a name="m6" doxytag="vo_driver_s::set_property"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int(* vo_driver_s::set_property)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, int property, int value) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set value of property. <dl compact><dt> +<b>See also: </b><dd> +<a href="group__video__prop.html">Constants for the get/set properties functions.</a> </dl> </td> + </tr> +</table> +<a name="m2" doxytag="vo_driver_s::update_frame_format"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void(* vo_driver_s::update_frame_format)(<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *self, <a class="el" href="structvo__frame__t.html">vo_frame_t</a> *img, uint32_t width, uint32_t height, int ratio_code, int format) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Check if the given image fullfills the format specified (re-)allocate memory if necessary </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structvo__driver__t.html b/doc/xine-lib-API/html/structvo__driver__t.html new file mode 100644 index 000000000..bcbd8e454 --- /dev/null +++ b/doc/xine-lib-API/html/structvo__driver__t.html @@ -0,0 +1,33 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>vo_driver_t Struct Reference</h1>Data type of structure <a class="el" href="structvo__driver__s.html">vo_driver_s</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Data type of structure <a class="el" href="structvo__driver__s.html">vo_driver_s</a>. +<p> +<dl compact><dt> +<b>See also: </b><dd> +structure <a class="el" href="structvo__driver__s.html">vo_driver_s</a>. </dl> +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structvo__frame__t.html b/doc/xine-lib-API/html/structvo__frame__t.html new file mode 100644 index 000000000..64d62e794 --- /dev/null +++ b/doc/xine-lib-API/html/structvo__frame__t.html @@ -0,0 +1,28 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>vo_frame_t Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Opaque data type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structvo__overlay__t.html b/doc/xine-lib-API/html/structvo__overlay__t.html new file mode 100644 index 000000000..71eb5f694 --- /dev/null +++ b/doc/xine-lib-API/html/structvo__overlay__t.html @@ -0,0 +1,28 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>vo_overlay_t Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Opaque data type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a> </dl> +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/structxine__t.html b/doc/xine-lib-API/html/structxine__t.html new file mode 100644 index 000000000..3d930fc98 --- /dev/null +++ b/doc/xine-lib-API/html/structxine__t.html @@ -0,0 +1,28 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>xine_t Struct Reference</h1><code>#include <<a class="el" href="xine_8h-source.html">xine.h</a>></code> +<p> +<table border=0 cellpadding=0 cellspacing=0> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Opaque data type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__loadplugins__group.html#a3">xine_load_audio_output_plugin</a> </dl> +<p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="xine_8h-source.html">xine.h</a></ul> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/xine_8h-source.html b/doc/xine-lib-API/html/xine_8h-source.html new file mode 100644 index 000000000..f5f081660 --- /dev/null +++ b/doc/xine-lib-API/html/xine_8h-source.html @@ -0,0 +1,346 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>xine.h</h1><a href="xine_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/* !! DO NO EDIT THIS FILE, it is automatically generated */</font> +00031 <font class="comment">/*</font> +00032 <font class="comment"> * $Id: xine_8h-source.html,v 1.1 2001/07/26 11:12:26 f1rmb Exp $</font> +00033 <font class="comment"> *</font> +00034 <font class="comment"> */</font> +00035 +00036 <font class="preprocessor">#ifndef HAVE_XINE_H</font> +00037 <font class="preprocessor"></font><font class="preprocessor">#define HAVE_XINE_H</font> +00038 <font class="preprocessor"></font> +00039 <font class="preprocessor">#ifdef __cplusplus</font> +00040 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> { +00041 <font class="preprocessor">#endif</font> +00042 <font class="preprocessor"></font> +00043 <font class="preprocessor">#include <inttypes.h></font> +00044 <font class="preprocessor">#include <unistd.h></font> +00045 <font class="preprocessor">#include <sys/types.h></font> +00046 +00047 <font class="preprocessor">#ifndef DOC_HIDDEN</font> +00048 <font class="preprocessor"></font><font class="preprocessor">#include <xine/events.h></font> +00049 <font class="preprocessor">#endif</font> +00050 <font class="preprocessor"></font> +<a name="l00055"></a><a class="code" href="xine_8h.html#a0">00055</a> <font class="preprocessor">#define XINE_SKINDIR "/usr/local/share/xine/skins"</font> +00056 <font class="preprocessor"></font> +00066 <font class="preprocessor">#define XINE_BUILD_CC "gcc version 2.95.3 20010315 (release)"</font> +00067 <font class="preprocessor"></font> +00070 <font class="preprocessor">#define XINE_BUILD_OS "Linux 2.4.5 i686"</font> +00071 <font class="preprocessor"></font> +00074 <font class="preprocessor">#define XINE_BUILD_DATE "Thu 26 Jul 2001 09:17:10"</font> +00075 <font class="preprocessor"></font> +00093 <font class="preprocessor">#define XINE_STOP 0</font> +00094 <font class="preprocessor"></font> +00099 <font class="preprocessor">#define XINE_PLAY 1</font> +00100 <font class="preprocessor"></font> +00105 <font class="preprocessor">#define XINE_PAUSE 2</font> +00106 <font class="preprocessor"></font> +00111 <font class="preprocessor">#define XINE_QUIT 3</font> +00112 <font class="preprocessor"></font> +00124 <font class="preprocessor">#define XINE_MAJOR_VERSION 0</font> +00125 <font class="preprocessor"></font> +00129 <font class="preprocessor">#define XINE_MINOR_VERSION 5</font> +00130 <font class="preprocessor"></font> +00134 <font class="preprocessor">#define XINE_SUB_VERSION 0</font> +00135 <font class="preprocessor"></font> +00150 <font class="keywordtype">char</font> *<a class="code" href="xine_8h.html#a0">xine_get_str_version</a>(<font class="keywordtype">void</font>); +00151 +00159 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a1">xine_get_major_version</a>(<font class="keywordtype">void</font>); +00160 +00168 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a2">xine_get_minor_version</a>(<font class="keywordtype">void</font>); +00169 +00177 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a3">xine_get_sub_version</a>(<font class="keywordtype">void</font>); +00178 +00189 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a4">xine_check_version</a>(<font class="keywordtype">int</font> major, <font class="keywordtype">int</font> minor, <font class="keywordtype">int</font> sub); +00190 +00207 <font class="preprocessor">#define VO_CAP_HUE 0x00000010</font> +00208 <font class="preprocessor"></font> +00212 <font class="preprocessor">#define VO_CAP_SATURATION 0x00000020</font> +00213 <font class="preprocessor"></font> +00217 <font class="preprocessor">#define VO_CAP_BRIGHTNESS 0x00000040</font> +00218 <font class="preprocessor"></font> +00222 <font class="preprocessor">#define VO_CAP_CONTRAST 0x00000080</font> +00223 <font class="preprocessor"></font> +00227 <font class="preprocessor">#define VO_CAP_COLORKEY 0x00000100</font> +00228 <font class="preprocessor"></font> +00241 <font class="preprocessor">#define VO_PROP_INTERLACED 0</font> +00242 <font class="preprocessor"></font> +00247 <font class="preprocessor">#define VO_PROP_ASPECT_RATIO 1</font> +00248 <font class="preprocessor"></font> +00253 <font class="preprocessor">#define VO_PROP_HUE 2</font> +00254 <font class="preprocessor"></font> +00259 <font class="preprocessor">#define VO_PROP_SATURATION 3</font> +00260 <font class="preprocessor"></font> +00265 <font class="preprocessor">#define VO_PROP_CONTRAST 4</font> +00266 <font class="preprocessor"></font> +00271 <font class="preprocessor">#define VO_PROP_BRIGHTNESS 5</font> +00272 <font class="preprocessor"></font> +00277 <font class="preprocessor">#define VO_PROP_COLORKEY 6</font> +00278 <font class="preprocessor"></font> +00283 <font class="preprocessor">#define VO_NUM_PROPERTIES 7</font> +00284 <font class="preprocessor"></font> +<a name="l00298"></a><a class="code" href="group__video__ratio.html#a0">00298</a> <font class="preprocessor">#define ASPECT_AUTO 0</font> +00299 <font class="preprocessor"></font> +<a name="l00304"></a><a class="code" href="group__video__ratio.html#a1">00304</a> <font class="preprocessor">#define ASPECT_ANAMORPHIC 1</font> +00305 <font class="preprocessor"></font> +<a name="l00310"></a><a class="code" href="group__video__ratio.html#a2">00310</a> <font class="preprocessor">#define ASPECT_FULL 2</font> +00311 <font class="preprocessor"></font> +<a name="l00316"></a><a class="code" href="group__video__ratio.html#a3">00316</a> <font class="preprocessor">#define ASPECT_DVB 3</font> +00317 <font class="preprocessor"></font> +00325 <font class="keyword">typedef</font> <font class="keywordtype">void</font> vo_frame_t; +00331 <font class="keyword">typedef</font> <font class="keywordtype">void</font> vo_overlay_t; +00332 +00338 <font class="keyword">typedef</font> <font class="keyword">struct </font><a class="code" href="structvo__driver__s.html">vo_driver_s</a> <a class="code" href="structvo__driver__s.html">vo_driver_t</a>; +00339 +00344 <font class="keyword">struct </font><a class="code" href="structvo__driver__s.html">vo_driver_s</a> { +00349 uint32_t (*get_capabilities) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self); +00354 vo_frame_t* (*alloc_frame) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self); +00359 void (*update_frame_format) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, vo_frame_t *img, +00360 uint32_t width, uint32_t height, +00361 <font class="keywordtype">int</font> ratio_code, <font class="keywordtype">int</font> format); +00365 void (*display_frame) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, vo_frame_t *vo_img); +00369 void (*overlay_blend) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, vo_frame_t *vo_img, vo_overlay_t *overlay); +00377 int (*get_property) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, <font class="keywordtype">int</font> property); +00382 int (*set_property) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, +00383 <font class="keywordtype">int</font> property, <font class="keywordtype">int</font> value); +00388 void (*get_property_min_max) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, +00389 <font class="keywordtype">int</font> property, <font class="keywordtype">int</font> *min, <font class="keywordtype">int</font> *max); +00396 int (*gui_data_exchange) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self, <font class="keywordtype">int</font> data_type, +00397 <font class="keywordtype">void</font> *data); +00401 void (*exit) (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *self); +00402 +00403 }; +00404 +00422 <font class="keyword">typedef</font> <font class="keywordtype">void</font> xine_t; +00427 <font class="keyword">typedef</font> <font class="keywordtype">void</font> ao_functions_t; +00432 <font class="keyword">typedef</font> <font class="keywordtype">void</font> cfg_data_t; +00438 <font class="keyword">typedef</font> <font class="keyword">struct </font><a class="code" href="structconfig__values__s.html">config_values_s</a> <a class="code" href="structconfig__values__s.html">config_values_t</a>; +00444 <font class="keyword">struct </font><a class="code" href="structconfig__values__s.html">config_values_s</a> { +00448 <font class="keywordtype">char</font>* (*lookup_str) (<a class="code" href="structconfig__values__s.html">config_values_t</a> *self, +00449 <font class="keywordtype">char</font> *key, <font class="keywordtype">char</font> *str_default); +00453 int (*lookup_int) (<a class="code" href="structconfig__values__s.html">config_values_t</a> *self, +00454 <font class="keywordtype">char</font> *key, <font class="keywordtype">int</font> n_default); +00458 void (*set_str) (<a class="code" href="structconfig__values__s.html">config_values_t</a> *self, +00459 <font class="keywordtype">char</font> *key, <font class="keywordtype">char</font> *value) ; +00463 void (*set_int) (<a class="code" href="structconfig__values__s.html">config_values_t</a> *self, +00464 <font class="keywordtype">char</font> *key, <font class="keywordtype">int</font> value) ; +00468 void (*save) (<a class="code" href="structconfig__values__s.html">config_values_t</a> *self); +00474 void (*read) (<a class="code" href="structconfig__values__s.html">config_values_t</a> *self, <font class="keywordtype">char</font> *filename); +<a name="l00478"></a><a class="code" href="structconfig__values__s.html#m6">00478</a> cfg_data_t *data; +00479 }; +00480 +00494 <a class="code" href="structconfig__values__s.html">config_values_t</a> *<a class="code" href="xine_8h.html#a0">config_file_init</a> (<font class="keywordtype">char</font> *filename); +00495 +00506 <font class="keyword">typedef</font> void (*gui_stream_end_cb_t) (<font class="keywordtype">int</font> nStatus); +00511 <font class="keyword">typedef</font> <font class="keywordtype">char</font>* (*gui_get_next_mrl_cb_t) (<font class="keywordtype">void</font>); +00516 <font class="keyword">typedef</font> void (*gui_branched_cb_t) (<font class="keywordtype">void</font>); +00517 +<a name="l00532"></a><a class="code" href="group__demux__strategy.html#a0">00532</a> <font class="preprocessor">#define DEMUX_DEFAULT_STRATEGY 0</font> +00533 <font class="preprocessor"></font> +<a name="l00538"></a><a class="code" href="group__demux__strategy.html#a1">00538</a> <font class="preprocessor">#define DEMUX_REVERT_STRATEGY 1</font> +00539 <font class="preprocessor"></font> +<a name="l00544"></a><a class="code" href="group__demux__strategy.html#a2">00544</a> <font class="preprocessor">#define DEMUX_CONTENT_STRATEGY 2</font> +00545 <font class="preprocessor"></font> +<a name="l00550"></a><a class="code" href="group__demux__strategy.html#a3">00550</a> <font class="preprocessor">#define DEMUX_EXTENSION_STRATEGY 3</font> +00551 <font class="preprocessor"></font> +00572 xine_t *<a class="code" href="xine_8h.html#a1">xine_init</a> (<a class="code" href="structvo__driver__s.html">vo_driver_t</a> *vo, +00573 ao_functions_t *ao, +00574 <a class="code" href="structconfig__values__s.html">config_values_t</a> *config, +00575 gui_stream_end_cb_t stream_end_cb, +00576 gui_get_next_mrl_cb_t get_next_mrl_cb, +00577 gui_branched_cb_t branched_cb); +00578 +00588 <font class="keywordtype">void</font> <a class="code" href="xine_8h.html#a2">xine_exit</a> (xine_t *self); +00589 +00607 <font class="keywordtype">void</font> <a class="code" href="xine_8h.html#a0">xine_play</a> (xine_t *self, <font class="keywordtype">char</font> *MRL, <font class="keywordtype">int</font> pos); +00608 +00617 <font class="keywordtype">void</font> <a class="code" href="xine_8h.html#a1">xine_pause</a> (xine_t *self); +00618 +00627 <font class="keywordtype">void</font> <a class="code" href="xine_8h.html#a2">xine_stop</a> (xine_t *self); +00628 +00637 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a3">xine_eject</a>(xine_t *self); +00638 +00647 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a4">xine_get_status</a> (xine_t *self); +00648 +00657 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a5">xine_get_current_position</a> (xine_t *self); +00658 +00667 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a6">xine_get_audio_channel</a> (xine_t *self); +00668 +00677 <font class="keywordtype">void</font> <a class="code" href="xine_8h.html#a7">xine_select_audio_channel</a> (xine_t *self, <font class="keywordtype">int</font> channel); +00678 +00687 <font class="keywordtype">int</font> <a class="code" href="xine_8h.html#a8">xine_get_spu_channel</a> (xine_t *self); +00688 +00697 <font class="keywordtype">void</font> <a class="code" href="xine_8h.html#a9">xine_select_spu_channel</a> (xine_t *self, <font class="keywordtype">int</font> channel); +00698 +00715 <font class="keywordtype">char</font> **<a class="code" href="xine_8h.html#a0">xine_get_browsable_input_plugin_ids</a> (xine_t *self) ; +00716 +<a name="l00729"></a><a class="code" href="group__mrl__types.html#a0">00729</a> <font class="preprocessor">#define mrl_unknown (0 << 0)</font> +00730 <font class="preprocessor"></font> +<a name="l00735"></a><a class="code" href="group__mrl__types.html#a1">00735</a> <font class="preprocessor">#define mrl_dvd (1 << 0)</font> +00736 <font class="preprocessor"></font> +<a name="l00741"></a><a class="code" href="group__mrl__types.html#a2">00741</a> <font class="preprocessor">#define mrl_vcd (1 << 1)</font> +00742 <font class="preprocessor"></font> +<a name="l00747"></a><a class="code" href="group__mrl__types.html#a3">00747</a> <font class="preprocessor">#define mrl_net (1 << 2)</font> +00748 <font class="preprocessor"></font> +<a name="l00753"></a><a class="code" href="group__mrl__types.html#a4">00753</a> <font class="preprocessor">#define mrl_rtp (1 << 3)</font> +00754 <font class="preprocessor"></font> +<a name="l00759"></a><a class="code" href="group__mrl__types.html#a5">00759</a> <font class="preprocessor">#define mrl_stdin (1 << 4)</font> +00760 <font class="preprocessor"></font> +<a name="l00765"></a><a class="code" href="group__mrl__types.html#a6">00765</a> <font class="preprocessor">#define mrl_file (1 << 5)</font> +00766 <font class="preprocessor"></font> +<a name="l00771"></a><a class="code" href="group__mrl__types.html#a7">00771</a> <font class="preprocessor">#define mrl_file_fifo (1 << 6)</font> +00772 <font class="preprocessor"></font> +<a name="l00777"></a><a class="code" href="group__mrl__types.html#a8">00777</a> <font class="preprocessor">#define mrl_file_chardev (1 << 7)</font> +00778 <font class="preprocessor"></font> +<a name="l00783"></a><a class="code" href="group__mrl__types.html#a9">00783</a> <font class="preprocessor">#define mrl_file_directory (1 << 8)</font> +00784 <font class="preprocessor"></font> +<a name="l00789"></a><a class="code" href="group__mrl__types.html#a10">00789</a> <font class="preprocessor">#define mrl_file_blockdev (1 << 9)</font> +00790 <font class="preprocessor"></font> +<a name="l00795"></a><a class="code" href="group__mrl__types.html#a11">00795</a> <font class="preprocessor">#define mrl_file_normal (1 << 10)</font> +00796 <font class="preprocessor"></font> +<a name="l00801"></a><a class="code" href="group__mrl__types.html#a12">00801</a> <font class="preprocessor">#define mrl_file_symlink (1 << 11)</font> +00802 <font class="preprocessor"></font> +<a name="l00807"></a><a class="code" href="group__mrl__types.html#a13">00807</a> <font class="preprocessor">#define mrl_file_sock (1 << 12)</font> +00808 <font class="preprocessor"></font> +<a name="l00813"></a><a class="code" href="group__mrl__types.html#a14">00813</a> <font class="preprocessor">#define mrl_file_exec (1 << 13)</font> +00814 <font class="preprocessor"></font> +<a name="l00819"></a><a class="code" href="group__mrl__types.html#a15">00819</a> <font class="preprocessor">#define mrl_file_backup (1 << 14)</font> +00820 <font class="preprocessor"></font> +<a name="l00825"></a><a class="code" href="group__mrl__types.html#a16">00825</a> <font class="preprocessor">#define mrl_file_hidden (1 << 15)</font> +00826 <font class="preprocessor"></font> +00834 <font class="preprocessor">#define MRL_ZERO(m) { \</font> +00835 <font class="preprocessor"> if((m)) { \</font> +00836 <font class="preprocessor"> if((m)->origin) \</font> +00837 <font class="preprocessor"> free((m)->origin); \</font> +00838 <font class="preprocessor"> if((m)->mrl) \</font> +00839 <font class="preprocessor"> free((m)->mrl); \</font> +00840 <font class="preprocessor"> if((m)->link) \</font> +00841 <font class="preprocessor"> free((m)->link); \</font> +00842 <font class="preprocessor"> (m)->origin = NULL; \</font> +00843 <font class="preprocessor"> (m)->mrl = NULL; \</font> +00844 <font class="preprocessor"> (m)->link = NULL; \</font> +00845 <font class="preprocessor"> (m)->type = 0; \</font> +00846 <font class="preprocessor"> (m)->size = (off_t) 0; \</font> +00847 <font class="preprocessor"> } \</font> +00848 <font class="preprocessor">}</font> +00849 <font class="preprocessor"></font> +00855 <font class="preprocessor">#define MRL_DUPLICATE(s, d) { \</font> +00856 <font class="preprocessor"> assert((s) != NULL); \</font> +00857 <font class="preprocessor"> assert((d) != NULL); \</font> +00858 <font class="preprocessor"> \</font> +00859 <font class="preprocessor"> if((s)->origin) { \</font> +00860 <font class="preprocessor"> if((d)->origin) { \</font> +00861 <font class="preprocessor"> (d)->origin = (char *) realloc((d)->origin, strlen((s)->origin) + 1); \</font> +00862 <font class="preprocessor"> sprintf((d)->origin, "%s", (s)->origin); \</font> +00863 <font class="preprocessor"> } \</font> +00864 <font class="preprocessor"> else \</font> +00865 <font class="preprocessor"> (d)->origin = strdup((s)->origin); \</font> +00866 <font class="preprocessor"> } \</font> +00867 <font class="preprocessor"> else \</font> +00868 <font class="preprocessor"> (d)->origin = NULL; \</font> +00869 <font class="preprocessor"> \</font> +00870 <font class="preprocessor"> if((s)->mrl) { \</font> +00871 <font class="preprocessor"> if((d)->mrl) { \</font> +00872 <font class="preprocessor"> (d)->mrl = (char *) realloc((d)->mrl, strlen((s)->mrl) + 1); \</font> +00873 <font class="preprocessor"> sprintf((d)->mrl, "%s", (s)->mrl); \</font> +00874 <font class="preprocessor"> } \</font> +00875 <font class="preprocessor"> else \</font> +00876 <font class="preprocessor"> (d)->mrl = strdup((s)->mrl); \</font> +00877 <font class="preprocessor"> } \</font> +00878 <font class="preprocessor"> else \</font> +00879 <font class="preprocessor"> (d)->mrl = NULL; \</font> +00880 <font class="preprocessor"> \</font> +00881 <font class="preprocessor"> if((s)->link) { \</font> +00882 <font class="preprocessor"> if((d)->link) { \</font> +00883 <font class="preprocessor"> (d)->link = (char *) realloc((d)->link, strlen((s)->link) + 1); \</font> +00884 <font class="preprocessor"> sprintf((d)->link, "%s", (s)->link); \</font> +00885 <font class="preprocessor"> } \</font> +00886 <font class="preprocessor"> else \</font> +00887 <font class="preprocessor"> (d)->link = strdup((s)->link); \</font> +00888 <font class="preprocessor"> } \</font> +00889 <font class="preprocessor"> else \</font> +00890 <font class="preprocessor"> (d)->link = NULL; \</font> +00891 <font class="preprocessor"> \</font> +00892 <font class="preprocessor"> (d)->type = (s)->type; \</font> +00893 <font class="preprocessor"> (d)->size = (s)->size; \</font> +00894 <font class="preprocessor">}</font> +00895 <font class="preprocessor"></font> +00901 <font class="preprocessor">#define MRLS_DUPLICATE(s, d) { \</font> +00902 <font class="preprocessor"> int i = 0; \</font> +00903 <font class="preprocessor"> \</font> +00904 <font class="preprocessor"> assert((s) != NULL); \</font> +00905 <font class="preprocessor"> assert((d) != NULL); \</font> +00906 <font class="preprocessor"> \</font> +00907 <font class="preprocessor"> while((s) != NULL) { \</font> +00908 <font class="preprocessor"> d[i] = (mrl_t *) malloc(sizeof(mrl_t)); \</font> +00909 <font class="preprocessor"> MRL_DUPLICATE(s[i], d[i]); \</font> +00910 <font class="preprocessor"> i++; \</font> +00911 <font class="preprocessor"> } \</font> +00912 <font class="preprocessor">}</font> +00913 <font class="preprocessor"></font> +00919 <font class="keyword">typedef</font> <font class="keyword">struct </font>{ +<a name="l00921"></a><a class="code" href="structmrl__t.html#m0">00921</a> <font class="keywordtype">char</font> *origin; +<a name="l00923"></a><a class="code" href="structmrl__t.html#m1">00923</a> <font class="keywordtype">char</font> *mrl; +<a name="l00925"></a><a class="code" href="structmrl__t.html#m2">00925</a> <font class="keywordtype">char</font> *link; +<a name="l00927"></a><a class="code" href="structmrl__t.html#m3">00927</a> uint32_t type; +<a name="l00929"></a><a class="code" href="structmrl__t.html#m4">00929</a> off_t size; +00930 } <a class="code" href="structmrl__t.html">mrl_t</a>; +00931 +00949 <a class="code" href="structmrl__t.html">mrl_t</a> **<a class="code" href="xine_8h.html#a1">xine_get_browse_mrls</a> (xine_t *self, <font class="keywordtype">char</font> *plugin_id, <font class="keywordtype">char</font> *start_mrl, <font class="keywordtype">int</font> *num_mrls); +00950 +00966 <font class="keywordtype">char</font> **<a class="code" href="xine_8h.html#a0">xine_get_autoplay_input_plugin_ids</a> (xine_t *self) ; +00967 +00978 <font class="keywordtype">char</font> **<a class="code" href="xine_8h.html#a1">xine_get_autoplay_mrls</a> (xine_t *self, <font class="keywordtype">char</font> *plugin_id, <font class="keywordtype">int</font> *num_mrls); +00979 +<a name="l00993"></a><a class="code" href="group__loadplugins__group.html#a4">00993</a> <font class="preprocessor">#define XINE_PLUGINDIR "/usr/local/lib/xine/plugins"</font> +00994 <font class="preprocessor"></font> +01005 <font class="preprocessor">#define VISUAL_TYPE_X11 1</font> +01006 <font class="preprocessor"></font> +01011 <font class="preprocessor">#define VISUAL_TYPE_AA 2</font> +01012 <font class="preprocessor"></font> +01017 <font class="preprocessor">#define VISUAL_TYPE_FB 3</font> +01018 <font class="preprocessor"></font> +01023 <font class="preprocessor">#define VISUAL_TYPE_GTK 4</font> +01024 <font class="preprocessor"></font> +01034 <font class="keywordtype">char</font> **<a class="code" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a> (<font class="keywordtype">int</font> visual_type); +01035 +01045 <a class="code" href="structvo__driver__s.html">vo_driver_t</a> *<a class="code" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a>(<a class="code" href="structconfig__values__s.html">config_values_t</a> *config, +01046 <font class="keywordtype">char</font> *id, <font class="keywordtype">int</font> visual_type, <font class="keywordtype">void</font> *visual); +01047 +01053 <font class="keywordtype">char</font> **<a class="code" href="group__loadplugins__group.html#a2">xine_list_audio_output_plugins</a> (<font class="keywordtype">void</font>); +01054 +01062 ao_functions_t *<a class="code" href="group__loadplugins__group.html#a3">xine_load_audio_output_plugin</a>(<a class="code" href="structconfig__values__s.html">config_values_t</a> *config, <font class="keywordtype">char</font> *id); +01063 +01073 <font class="preprocessor">#ifdef DOC_HIDDEN</font> +01074 <font class="preprocessor"></font> +<a name="l01078"></a><a class="code" href="group__event__group.html#a0">01078</a> <font class="keyword">typedef</font> <font class="keywordtype">void</font> event_t; +01079 <font class="preprocessor">#endif</font> +01080 <font class="preprocessor"></font> +<a name="l01085"></a><a class="code" href="group__event__group.html#a1">01085</a> <font class="keyword">typedef</font> void (*event_listener_t) (xine_t *xine, event_t *event, <font class="keywordtype">void</font> *data); +01086 +01095 <font class="keywordtype">int</font> <a class="code" href="group__event__group.html#a2">xine_register_event_listener</a>(xine_t *self, event_listener_t listener); +01096 +01105 <font class="keywordtype">int</font> <a class="code" href="group__event__group.html#a3">xine_remove_event_listener</a>(xine_t *self, event_listener_t listener); +01106 +01115 <font class="keywordtype">void</font> <a class="code" href="group__event__group.html#a4">xine_send_event</a>(xine_t *self, event_t *event, <font class="keywordtype">void</font> *data); +01116 +01121 <font class="preprocessor">#ifdef __cplusplus</font> +01122 <font class="preprocessor"></font>} +01123 <font class="preprocessor">#endif</font> +01124 <font class="preprocessor"></font> +01125 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/xine_8h.html b/doc/xine-lib-API/html/xine_8h.html new file mode 100644 index 000000000..b2dbe1ccf --- /dev/null +++ b/doc/xine-lib-API/html/xine_8h.html @@ -0,0 +1,306 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>xine.h File Reference</h1> +<p> +<a href="xine_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Data Structures</h2></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structconfig__values__s.html">config_values_s</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structmrl__t.html">mrl_t</a></td></tr> +<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvo__driver__s.html">vo_driver_s</a></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="xine_8h.html#a0">XINE_SKINDIR</a> "/usr/local/share/xine/skins"</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::XINE_BUILD_CC"></a> +#define </td><td valign=bottom><a class="el" href="group__build__info.html#a0">XINE_BUILD_CC</a> "gcc version 2.95.3 20010315 (release)"</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::XINE_BUILD_OS"></a> +#define </td><td valign=bottom><a class="el" href="group__build__info.html#a1">XINE_BUILD_OS</a> "Linux 2.4.5 i686"</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::XINE_BUILD_DATE"></a> +#define </td><td valign=bottom><a class="el" href="group__build__info.html#a2">XINE_BUILD_DATE</a> "Thu 26 Jul 2001 09:17:10"</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::XINE_STOP"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a0">XINE_STOP</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::XINE_PLAY"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a1">XINE_PLAY</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::XINE_PAUSE"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a2">XINE_PAUSE</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::XINE_QUIT"></a> +#define </td><td valign=bottom><a class="el" href="group__status__group.html#a3">XINE_QUIT</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::XINE_MAJOR_VERSION"></a> +#define </td><td valign=bottom><a class="el" href="group__version__group.html#a0">XINE_MAJOR_VERSION</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::XINE_MINOR_VERSION"></a> +#define </td><td valign=bottom><a class="el" href="group__version__group.html#a1">XINE_MINOR_VERSION</a> 5</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::XINE_SUB_VERSION"></a> +#define </td><td valign=bottom><a class="el" href="group__version__group.html#a2">XINE_SUB_VERSION</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::VO_CAP_HUE"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a0">VO_CAP_HUE</a> 0x00000010</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::VO_CAP_SATURATION"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a1">VO_CAP_SATURATION</a> 0x00000020</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::VO_CAP_BRIGHTNESS"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a2">VO_CAP_BRIGHTNESS</a> 0x00000040</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::VO_CAP_CONTRAST"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a3">VO_CAP_CONTRAST</a> 0x00000080</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::VO_CAP_COLORKEY"></a> +#define </td><td valign=bottom><a class="el" href="group__video__cap.html#a4">VO_CAP_COLORKEY</a> 0x00000100</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::VO_PROP_INTERLACED"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a0">VO_PROP_INTERLACED</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::VO_PROP_ASPECT_RATIO"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a1">VO_PROP_ASPECT_RATIO</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::VO_PROP_HUE"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a2">VO_PROP_HUE</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::VO_PROP_SATURATION"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a3">VO_PROP_SATURATION</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::VO_PROP_CONTRAST"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a4">VO_PROP_CONTRAST</a> 4</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="xine.h::VO_PROP_BRIGHTNESS"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a5">VO_PROP_BRIGHTNESS</a> 5</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="xine.h::VO_PROP_COLORKEY"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a6">VO_PROP_COLORKEY</a> 6</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="xine.h::VO_NUM_PROPERTIES"></a> +#define </td><td valign=bottom><a class="el" href="group__video__prop.html#a7">VO_NUM_PROPERTIES</a> 7</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::ASPECT_AUTO"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a0">ASPECT_AUTO</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::ASPECT_ANAMORPHIC"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a1">ASPECT_ANAMORPHIC</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::ASPECT_FULL"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a2">ASPECT_FULL</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::ASPECT_DVB"></a> +#define </td><td valign=bottom><a class="el" href="group__video__ratio.html#a3">ASPECT_DVB</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::DEMUX_DEFAULT_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a0">DEMUX_DEFAULT_STRATEGY</a> 0</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::DEMUX_REVERT_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a1">DEMUX_REVERT_STRATEGY</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::DEMUX_CONTENT_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a2">DEMUX_CONTENT_STRATEGY</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::DEMUX_EXTENSION_STRATEGY"></a> +#define </td><td valign=bottom><a class="el" href="group__demux__strategy.html#a3">DEMUX_EXTENSION_STRATEGY</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::mrl_unknown"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a0">mrl_unknown</a> (0 << 0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::mrl_dvd"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a1">mrl_dvd</a> (1 << 0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::mrl_vcd"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a2">mrl_vcd</a> (1 << 1)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::mrl_net"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a3">mrl_net</a> (1 << 2)</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::mrl_rtp"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a4">mrl_rtp</a> (1 << 3)</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="xine.h::mrl_stdin"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a5">mrl_stdin</a> (1 << 4)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="xine.h::mrl_file"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a6">mrl_file</a> (1 << 5)</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="xine.h::mrl_file_fifo"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a7">mrl_file_fifo</a> (1 << 6)</td></tr> +<tr><td nowrap align=right valign=top><a name="a8" doxytag="xine.h::mrl_file_chardev"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a8">mrl_file_chardev</a> (1 << 7)</td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="xine.h::mrl_file_directory"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a9">mrl_file_directory</a> (1 << 8)</td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="xine.h::mrl_file_blockdev"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a10">mrl_file_blockdev</a> (1 << 9)</td></tr> +<tr><td nowrap align=right valign=top><a name="a11" doxytag="xine.h::mrl_file_normal"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a11">mrl_file_normal</a> (1 << 10)</td></tr> +<tr><td nowrap align=right valign=top><a name="a12" doxytag="xine.h::mrl_file_symlink"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a12">mrl_file_symlink</a> (1 << 11)</td></tr> +<tr><td nowrap align=right valign=top><a name="a13" doxytag="xine.h::mrl_file_sock"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a13">mrl_file_sock</a> (1 << 12)</td></tr> +<tr><td nowrap align=right valign=top><a name="a14" doxytag="xine.h::mrl_file_exec"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a14">mrl_file_exec</a> (1 << 13)</td></tr> +<tr><td nowrap align=right valign=top><a name="a15" doxytag="xine.h::mrl_file_backup"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a15">mrl_file_backup</a> (1 << 14)</td></tr> +<tr><td nowrap align=right valign=top><a name="a16" doxytag="xine.h::mrl_file_hidden"></a> +#define </td><td valign=bottom><a class="el" href="group__mrl__types.html#a16">mrl_file_hidden</a> (1 << 15)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::MRL_ZERO"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a2">MRL_ZERO</a>(m)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::MRL_DUPLICATE"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a3">MRL_DUPLICATE</a>(s, d)</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::MRLS_DUPLICATE"></a> +#define </td><td valign=bottom><a class="el" href="group__browse__group.html#a4">MRLS_DUPLICATE</a>(s, d)</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::XINE_PLUGINDIR"></a> +#define </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a4">XINE_PLUGINDIR</a> "/usr/local/lib/xine/plugins"</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::VISUAL_TYPE_X11"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a0">VISUAL_TYPE_X11</a> 1</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::VISUAL_TYPE_AA"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a1">VISUAL_TYPE_AA</a> 2</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::VISUAL_TYPE_FB"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a2">VISUAL_TYPE_FB</a> 3</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::VISUAL_TYPE_GTK"></a> +#define </td><td valign=bottom><a class="el" href="group__visual__types.html#a3">VISUAL_TYPE_GTK</a> 4</td></tr> +<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::vo_frame_t"></a> +typedef void </td><td valign=bottom><b>vo_frame_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::vo_overlay_t"></a> +typedef void </td><td valign=bottom><b>vo_overlay_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::vo_driver_t"></a> +typedef struct <a class="el" href="structvo__driver__s.html">vo_driver_s</a> </td><td valign=bottom><b>vo_driver_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::xine_t"></a> +typedef void </td><td valign=bottom><b>xine_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::ao_functions_t"></a> +typedef void </td><td valign=bottom><b>ao_functions_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::cfg_data_t"></a> +typedef void </td><td valign=bottom><b>cfg_data_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::config_values_t"></a> +typedef struct <a class="el" href="structconfig__values__s.html">config_values_s</a> </td><td valign=bottom><b>config_values_t</b></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::gui_stream_end_cb_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__ui__callbacks.html#a0">gui_stream_end_cb_t</a> )(int nStatus)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::gui_get_next_mrl_cb_t"></a> +typedef char* (* </td><td valign=bottom><a class="el" href="group__ui__callbacks.html#a1">gui_get_next_mrl_cb_t</a> )(void)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::gui_branched_cb_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__ui__callbacks.html#a2">gui_branched_cb_t</a> )(void)</td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::event_t"></a> +typedef void </td><td valign=bottom><a class="el" href="group__event__group.html#a0">event_t</a></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::event_listener_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__event__group.html#a1">event_listener_t</a> )(<a class="el" href="structxine__t.html">xine_t</a> *xine, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data)</td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::xine_get_str_version"></a> +char* </td><td valign=bottom><a class="el" href="group__xine__version.html#a0">xine_get_str_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return string version, like "0.5.0".</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::xine_get_major_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a1">xine_get_major_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return version information.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::xine_get_minor_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a2">xine_get_minor_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return version information.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::xine_get_sub_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a3">xine_get_sub_version</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>return version information.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::xine_check_version"></a> +int </td><td valign=bottom><a class="el" href="group__xine__version.html#a4">xine_check_version</a> (int major, int minor, int sub)</td></tr> +<tr><td> </td><td><font size=-1><em>check minimal version.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::config_file_init"></a> +<a class="el" href="structconfig__values__t.html">config_values_t</a>* </td><td valign=bottom><a class="el" href="group__xine__init.html#a0">config_file_init</a> (char *filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Configuration file initialisation.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::xine_init"></a> +<a class="el" href="structxine__t.html">xine_t</a>* </td><td valign=bottom><a class="el" href="group__xine__init.html#a1">xine_init</a> (<a class="el" href="structvo__driver__t.html">vo_driver_t</a> *vo, <a class="el" href="structao__functions__t.html">ao_functions_t</a> *ao, <a class="el" href="structconfig__values__t.html">config_values_t</a> *config, <a class="el" href="xine_8h.html#a0">gui_stream_end_cb_t</a> stream_end_cb, <a class="el" href="xine_8h.html#a1">gui_get_next_mrl_cb_t</a> get_next_mrl_cb, <a class="el" href="xine_8h.html#a2">gui_branched_cb_t</a> branched_cb)</td></tr> +<tr><td> </td><td><font size=-1><em>Initialisation of xine.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::xine_exit"></a> +void </td><td valign=bottom><a class="el" href="group__xine__init.html#a2">xine_exit</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>De-initialisation of xine.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::xine_play"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a0">xine_play</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *MRL, int pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Start to play a stream.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::xine_pause"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a1">xine_pause</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Pause toggle.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::xine_stop"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a2">xine_stop</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::xine_eject"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a3">xine_eject</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Eject media.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::xine_get_status"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a4">xine_get_status</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current xine status.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="xine.h::xine_get_current_position"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a5">xine_get_current_position</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current position.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="xine.h::xine_get_audio_channel"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a6">xine_get_audio_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current audio channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="xine.h::xine_select_audio_channel"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a7">xine_select_audio_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, int channel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set audio channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a8" doxytag="xine.h::xine_get_spu_channel"></a> +int </td><td valign=bottom><a class="el" href="group__xine__management.html#a8">xine_get_spu_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Get current sub-title channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="xine.h::xine_select_spu_channel"></a> +void </td><td valign=bottom><a class="el" href="group__xine__management.html#a9">xine_select_spu_channel</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, int channel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set sub-title channel.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::xine_get_browsable_input_plugin_ids"></a> +char** </td><td valign=bottom><a class="el" href="group__browse__group.html#a0">xine_get_browsable_input_plugin_ids</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Request list of browsable featured plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::xine_get_browse_mrls"></a> +<a class="el" href="structmrl__t.html">mrl_t</a>** </td><td valign=bottom><a class="el" href="group__browse__group.html#a1">xine_get_browse_mrls</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *plugin_id, char *start_mrl, int *num_mrls)</td></tr> +<tr><td> </td><td><font size=-1><em>Request available MRLs from plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::xine_get_autoplay_input_plugin_ids"></a> +char** </td><td valign=bottom><a class="el" href="group__autoplay__group.html#a0">xine_get_autoplay_input_plugin_ids</a> (<a class="el" href="structxine__t.html">xine_t</a> *self)</td></tr> +<tr><td> </td><td><font size=-1><em>Request playlist from plugin.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::xine_get_autoplay_mrls"></a> +char** </td><td valign=bottom><a class="el" href="group__autoplay__group.html#a1">xine_get_autoplay_mrls</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, char *plugin_id, int *num_mrls)</td></tr> +<tr><td> </td><td><font size=-1><em>Request MRL list from plugin.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="xine.h::xine_list_video_output_plugins"></a> +char** </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a0">xine_list_video_output_plugins</a> (int visual_type)</td></tr> +<tr><td> </td><td><font size=-1><em>list available video output plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="xine.h::xine_load_video_output_plugin"></a> +<a class="el" href="structvo__driver__t.html">vo_driver_t</a>* </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a1">xine_load_video_output_plugin</a> (<a class="el" href="structconfig__values__t.html">config_values_t</a> *config, char *id, int visual_type, void *visual)</td></tr> +<tr><td> </td><td><font size=-1><em>load a specific video output plugin.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::xine_list_audio_output_plugins"></a> +char** </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a2">xine_list_audio_output_plugins</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>generate a list of all available audio output plugins.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::xine_load_audio_output_plugin"></a> +<a class="el" href="structao__functions__t.html">ao_functions_t</a>* </td><td valign=bottom><a class="el" href="group__loadplugins__group.html#a3">xine_load_audio_output_plugin</a> (<a class="el" href="structconfig__values__t.html">config_values_t</a> *config, char *id)</td></tr> +<tr><td> </td><td><font size=-1><em>load a specific audio output plugin.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="xine.h::xine_register_event_listener"></a> +int </td><td valign=bottom><a class="el" href="group__event__group.html#a2">xine_register_event_listener</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a1">event_listener_t</a> listener)</td></tr> +<tr><td> </td><td><font size=-1><em>registers an event listener callback.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="xine.h::xine_remove_event_listener"></a> +int </td><td valign=bottom><a class="el" href="group__event__group.html#a3">xine_remove_event_listener</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a1">event_listener_t</a> listener)</td></tr> +<tr><td> </td><td><font size=-1><em>Attempts to remove a registered event listener.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="xine.h::xine_send_event"></a> +void </td><td valign=bottom><a class="el" href="group__event__group.html#a4">xine_send_event</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data)</td></tr> +<tr><td> </td><td><font size=-1><em>sends an event to all listeners.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> + +<p> +<dl compact><dt> +<b>Author: </b><dd> +Guenter Bartsch <<a href="mailto:guenter@users.sourceforge.net">guenter@users.sourceforge.net</a>> , Siegfried Langauf <<a href="mailto:siggi@users.sourceforge.net">siggi@users.sourceforge.net</a>> , Daniel Caujolle-Bert <<a href="mailto:f1rmb@users.sourceforge.net">f1rmb@users.sourceforge.net</a>> </dl><dl compact><dt> +<b>Date: </b><dd> +25/07/2001 +<p> +</dl>API of XINE library. <div class="fragment"><pre> + Copyright (C) 2000-2001 the xine project + + This file is part of xine, a unix video player. + + xine is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + xine is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + + </pre></div> +<p> +<hr><h2>Define Documentation</h2> +<a name="a0" doxytag="xine.h::XINE_SKINDIR"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +#define XINE_SKINDIR "/usr/local/share/xine/skins" + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Skin file location </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/xine-lib-API/html/xine_logo.png b/doc/xine-lib-API/html/xine_logo.png Binary files differnew file mode 100644 index 000000000..3aad01fc9 --- /dev/null +++ b/doc/xine-lib-API/html/xine_logo.png |
