From a101b38dea6890fa1dbf5b8560665826b69fa4ae Mon Sep 17 00:00:00 2001 From: Daniel Caujolle-Bert Date: Thu, 26 Jul 2001 11:12:25 +0000 Subject: Updated doxy sections in xine.h.tmpl.in. Added man3. Removed french man page. Added API doc in html. Add new rpm package (doc). Fixes some little bugs in proto decl, etc... CVS patchset: 350 CVS date: 2001/07/26 11:12:25 --- doc/xine-lib-API/html/Makefile.am | 53 ++ doc/xine-lib-API/html/annotated.html | 29 + doc/xine-lib-API/html/doxygen.css | 20 + doc/xine-lib-API/html/doxygen.gif | Bin 0 -> 2378 bytes doc/xine-lib-API/html/files.html | 19 + doc/xine-lib-API/html/functions.html | 41 ++ doc/xine-lib-API/html/globals.html | 110 ++++ doc/xine-lib-API/html/group__autoplay__group.html | 149 ++++++ doc/xine-lib-API/html/group__browse__group.html | 285 ++++++++++ doc/xine-lib-API/html/group__build__info.html | 96 ++++ doc/xine-lib-API/html/group__config__group.html | 36 ++ doc/xine-lib-API/html/group__demux__strategy.html | 132 +++++ doc/xine-lib-API/html/group__event__group.html | 286 ++++++++++ .../html/group__loadplugins__group.html | 287 ++++++++++ doc/xine-lib-API/html/group__mrl__types.html | 483 +++++++++++++++++ doc/xine-lib-API/html/group__status__group.html | 129 +++++ doc/xine-lib-API/html/group__ui__callbacks.html | 111 ++++ doc/xine-lib-API/html/group__version__group.html | 96 ++++ doc/xine-lib-API/html/group__video__cap.html | 146 ++++++ doc/xine-lib-API/html/group__video__group.html | 37 ++ doc/xine-lib-API/html/group__video__prop.html | 237 +++++++++ doc/xine-lib-API/html/group__video__ratio.html | 132 +++++ doc/xine-lib-API/html/group__visual__types.html | 129 +++++ doc/xine-lib-API/html/group__xine__api.html | 30 ++ doc/xine-lib-API/html/group__xine__init.html | 251 +++++++++ doc/xine-lib-API/html/group__xine__management.html | 583 +++++++++++++++++++++ doc/xine-lib-API/html/group__xine__version.html | 269 ++++++++++ doc/xine-lib-API/html/index.html | 19 + doc/xine-lib-API/html/modules.html | 49 ++ doc/xine-lib-API/html/structao__functions__t.html | 26 + doc/xine-lib-API/html/structcfg__data__t.html | 26 + doc/xine-lib-API/html/structconfig__values__s.html | 219 ++++++++ doc/xine-lib-API/html/structconfig__values__t.html | 33 ++ doc/xine-lib-API/html/structmrl__t.html | 165 ++++++ doc/xine-lib-API/html/structvo__driver__s.html | 308 +++++++++++ doc/xine-lib-API/html/structvo__driver__t.html | 33 ++ doc/xine-lib-API/html/structvo__frame__t.html | 28 + doc/xine-lib-API/html/structvo__overlay__t.html | 28 + doc/xine-lib-API/html/structxine__t.html | 28 + doc/xine-lib-API/html/xine_8h-source.html | 346 ++++++++++++ doc/xine-lib-API/html/xine_8h.html | 306 +++++++++++ doc/xine-lib-API/html/xine_logo.png | Bin 0 -> 41894 bytes 42 files changed, 5790 insertions(+) create mode 100644 doc/xine-lib-API/html/Makefile.am create mode 100644 doc/xine-lib-API/html/annotated.html create mode 100644 doc/xine-lib-API/html/doxygen.css create mode 100644 doc/xine-lib-API/html/doxygen.gif create mode 100644 doc/xine-lib-API/html/files.html create mode 100644 doc/xine-lib-API/html/functions.html create mode 100644 doc/xine-lib-API/html/globals.html create mode 100644 doc/xine-lib-API/html/group__autoplay__group.html create mode 100644 doc/xine-lib-API/html/group__browse__group.html create mode 100644 doc/xine-lib-API/html/group__build__info.html create mode 100644 doc/xine-lib-API/html/group__config__group.html create mode 100644 doc/xine-lib-API/html/group__demux__strategy.html create mode 100644 doc/xine-lib-API/html/group__event__group.html create mode 100644 doc/xine-lib-API/html/group__loadplugins__group.html create mode 100644 doc/xine-lib-API/html/group__mrl__types.html create mode 100644 doc/xine-lib-API/html/group__status__group.html create mode 100644 doc/xine-lib-API/html/group__ui__callbacks.html create mode 100644 doc/xine-lib-API/html/group__version__group.html create mode 100644 doc/xine-lib-API/html/group__video__cap.html create mode 100644 doc/xine-lib-API/html/group__video__group.html create mode 100644 doc/xine-lib-API/html/group__video__prop.html create mode 100644 doc/xine-lib-API/html/group__video__ratio.html create mode 100644 doc/xine-lib-API/html/group__visual__types.html create mode 100644 doc/xine-lib-API/html/group__xine__api.html create mode 100644 doc/xine-lib-API/html/group__xine__init.html create mode 100644 doc/xine-lib-API/html/group__xine__management.html create mode 100644 doc/xine-lib-API/html/group__xine__version.html create mode 100644 doc/xine-lib-API/html/index.html create mode 100644 doc/xine-lib-API/html/modules.html create mode 100644 doc/xine-lib-API/html/structao__functions__t.html create mode 100644 doc/xine-lib-API/html/structcfg__data__t.html create mode 100644 doc/xine-lib-API/html/structconfig__values__s.html create mode 100644 doc/xine-lib-API/html/structconfig__values__t.html create mode 100644 doc/xine-lib-API/html/structmrl__t.html create mode 100644 doc/xine-lib-API/html/structvo__driver__s.html create mode 100644 doc/xine-lib-API/html/structvo__driver__t.html create mode 100644 doc/xine-lib-API/html/structvo__frame__t.html create mode 100644 doc/xine-lib-API/html/structvo__overlay__t.html create mode 100644 doc/xine-lib-API/html/structxine__t.html create mode 100644 doc/xine-lib-API/html/xine_8h-source.html create mode 100644 doc/xine-lib-API/html/xine_8h.html create mode 100644 doc/xine-lib-API/html/xine_logo.png (limited to 'doc/xine-lib-API/html') 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

XINE, A Free Video Player Project - API reference Data Structures

Here are the data structures with brief descriptions: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 new file mode 100644 index 000000000..192c83ce0 Binary files /dev/null and b/doc/xine-lib-API/html/doxygen.gif differ 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

XINE, A Free Video Player Project - API reference File List

Here is a list of all documented files with brief descriptions: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

XINE, A Free Video Player Project - API reference Data Fields

Here is a list of all documented struct and union fields with links to the structures/unions they belong to: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

XINE, A Free Video Player Project - API reference Globals

Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +
Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Autoplay support

+ + + + + +

Functions

+char** xine_get_autoplay_input_plugin_ids (xine_t *self)
 Request playlist from plugin.

+char** xine_get_autoplay_mrls (xine_t *self, char *plugin_id, int *num_mrls)
 Request MRL list from plugin.

+

Function Documentation

+

+ + + + +
+ + + + + + +
+char ** xine_get_autoplay_input_plugin_ids ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Request playlist from plugin. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Playlist. +

+

Some input plugins can generate autoplay lists returns a list of ids of these plugins.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + +
+char ** xine_get_autoplay_mrls ( + +xine_t * self, +
+char * plugin_id, +
+int * num_mrls ) +
+
+ + + + + +
+   + + +

+Request MRL list from plugin. +

+

+Parameters:
+ + + + +
self +  +Current xine engine configuration ( see xine_init() )
plugin_id +  +Plugin name ( see xine_get_autoplay_input_plugin_ids() )
num_mrls +  +Entries in return array.
+
+Returns:
+MRL list. +

+

Get autoplay MRL list for input plugin named <plugin_id>.
+Parameters:
+ + + + +
self +  +
plugin_id +  +
num_mrls +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Browsing support

+ + + + + + + + + + + + + + +

Modules

Types of available mrls

Data Structures

struct  mrl_t
struct  mrl_t

Defines

+#define MRL_ZERO(m)
+#define MRL_DUPLICATE(s, d)
+#define MRLS_DUPLICATE(s, d)

Functions

+char** xine_get_browsable_input_plugin_ids (xine_t *self)
 Request list of browsable featured plugins.

+mrl_t** xine_get_browse_mrls (xine_t *self, char *plugin_id, char *start_mrl, int *num_mrls)
 Request available MRLs from plugins.

+

Define Documentation

+

+ + + + +
+ + + +
+#define MRLS_DUPLICATE( + +s, d ) +
+
+ + + + + +
+   + + +

+Value:

  {                                                \
+  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++;                                                                      \
+  }                                                                           \
+}
Duplicate two arrays of mrls (s = source, d = destination).
+See also:
+mrl_t, xine_get_browse_mrls()
+

+ + + + +
+ + + +
+#define MRL_DUPLICATE( + +s, d ) +
+
+ + + + + +
+   + + +

+Duplicate two mrls entries (s = source, d = destination).

+See also:
+mrl_t, xine_get_browse_mrls()
+

+ + + + +
+ + + +
+#define MRL_ZERO( + +m ) +
+
+ + + + + +
+   + + +

+Value:

  {                                                         \
+  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;                                                  \
+  }                                                                           \
+}
Freeing/zeroing all of entries of given mrl.
+See also:
+mrl_t, xine_get_browse_mrls()
+

Function Documentation

+

+ + + + +
+ + + + + + +
+char ** xine_get_browsable_input_plugin_ids ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Request list of browsable featured plugins. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+List of plugins +

+

Some input plugins are browseable, get the list of ids of these plugins.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
+mrl_t ** xine_get_browse_mrls ( + +xine_t * self, +
+char * plugin_id, +
+char * start_mrl, +
+int * num_mrls ) +
+
+ + + + + +
+   + + +

+Request available MRLs from plugins. +

+

+Parameters:
+ + + + + +
self +  +Current xine engine configuration ( see xine_init() )
plugin_id +  +Plugin name ( see xine_get_browsable_input_plugin_ids() )
start_mrl +  +MRL
num_mrl +  +how many mrls was found
+
+Returns:
+start_mrl on success, NULL on failure. +

+

Asks input plugin named <plugin_id> to return a list of available MRLs in domain/directory <start_mrl>. +

+<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.

+Parameters:
+ + + + + +
self +  +
plugin_id +  +
start_mrl +  +
num_mrls +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Build informations

+ + + + +

Defines

+#define XINE_BUILD_CC   "gcc version 2.95.3 20010315 (release)"
+#define XINE_BUILD_OS   "Linux 2.4.5 i686"
+#define XINE_BUILD_DATE   "Thu 26 Jul 2001 09:17:10"
+

Define Documentation

+

+ + + + +
+ + +
+#define XINE_BUILD_CC   "gcc version 2.95.3 20010315 (release)" +
+
+ + + + + +
+   + + +

+Compiler used to build xine-lib

+

+ + + + +
+ + +
+#define XINE_BUILD_DATE   "Thu 26 Jul 2001 09:17:10" +
+
+ + + + + +
+   + + +

+Build time

+

+ + + + +
+ + +
+#define XINE_BUILD_OS   "Linux 2.4.5 i686" +
+
+ + + + + +
+   + + +

+OS used to build xine-lib

+

Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Configuration structure type.

+ + + + + + + + + + + + + +

Data Structures

struct  ao_functions_t
struct  cfg_data_t
struct  config_values_s
struct  config_values_s
struct  config_values_t
 Data type of structure config_values_s. More...

struct  xine_t

Typedefs

+typedef void xine_t
+typedef void ao_functions_t
+typedef void cfg_data_t
+typedef struct config_values_s config_values_t
+
Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Possible demuxer guessing strategy.

+ + + + + +

Defines

+#define DEMUX_DEFAULT_STRATEGY   0
+#define DEMUX_REVERT_STRATEGY   1
+#define DEMUX_CONTENT_STRATEGY   2
+#define DEMUX_EXTENSION_STRATEGY   3
+

Detailed Description

+"demux_strategy" should be set to one of these value in configuration file ( see Configuration structure type.) before xine_init() call.
+See also:
+config_values_t

Define Documentation

+

+ + + + +
+ + +
+#define DEMUX_CONTENT_STRATEGY   2 +
+
+ + + + + +
+   + + +

+Recognize by content only.

+See also:
+config_values_t
+

+ + + + +
+ + +
+#define DEMUX_DEFAULT_STRATEGY   0 +
+
+ + + + + +
+   + + +

+Recognize by content then by extension.

+See also:
+config_values_t
+

+ + + + +
+ + +
+#define DEMUX_EXTENSION_STRATEGY   3 +
+
+ + + + + +
+   + + +

+Recognize by extension only.

+See also:
+config_values_t
+

+ + + + +
+ + +
+#define DEMUX_REVERT_STRATEGY   1 +
+
+ + + + + +
+   + + +

+Recognize by extension then by content.

+See also:
+config_values_t
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Sending events

+ + + + + + + + + + +

Typedefs

+typedef void event_t
+typedef void (* event_listener_t )(xine_t *xine, event_t *event, void *data)

Functions

+int xine_register_event_listener (xine_t *self, event_listener_t listener)
 registers an event listener callback.

+int xine_remove_event_listener (xine_t *self, event_listener_t listener)
 Attempts to remove a registered event listener.

+void xine_send_event (xine_t *self, event_t *event, void *data)
 sends an event to all listeners.

+

Detailed Description

+Event dispatcher mechanism

Typedef Documentation

+

+ + + + +
+ + + + + +
+typedef void(* event_listener_t)(xine_t *xine, event_t *event, void *data) +
+
+ + + + + +
+   + + +

+Event listener callback.

+See also:
+xine_register_event_listener, xine_remove_event_listener
+

+ + + + +
+ + + + + +
+typedef void event_t +
+
+ + + + + +
+   + + +

+Opaque data type.

+See also:
+event_listener_t, xine_send_event
+

Function Documentation

+

+ + + + +
+ + + + + + + + + + +
+int xine_register_event_listener ( + +xine_t * self, +
+event_listener_t listener ) +
+
+ + + + + +
+   + + +

+registers an event listener callback. +

+

+Parameters:
+ + + +
self +  +Current xine engine configuration ( see xine_init() )
listener +  +callback function.
+
+Returns:
+0 if the listener was registerd, non-zero if it could not.
+See also:
+event_listener_t
+Parameters:
+ + + +
self +  +
listener +  +
+
+

+ + + + +
+ + + + + + + + + + +
+int xine_remove_event_listener ( + +xine_t * self, +
+event_listener_t listener ) +
+
+ + + + + +
+   + + +

+Attempts to remove a registered event listener. +

+

+Parameters:
+ + + +
self +  +Current xine engine configuration ( see xine_init() )
listener +  +callback function.
+
+Returns:
+0 if the listener was removes, non-zero if it wasn't (e.g. not found).
+See also:
+event_listener_t
+Parameters:
+ + + +
self +  +
listener +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + +
+void xine_send_event ( + +xine_t * self, +
+event_t * event, +
+void * data ) +
+
+ + + + + +
+   + + +

+sends an event to all listeners. +

+

+Parameters:
+ + + + +
self +  +Current xine engine configuration ( see xine_init() )
event +  +FILLME
data +  +FILLME.
+
+See also:
+event_t
+Parameters:
+ + + + +
self +  +
event +  +
data +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Loading plugins

+ + + + + + + + + + + + + +

Modules

Valid visual types

Defines

+#define XINE_PLUGINDIR   "/usr/local/lib/xine/plugins"

Functions

+char** xine_list_video_output_plugins (int visual_type)
 list available video output plugins.

+vo_driver_t* xine_load_video_output_plugin (config_values_t *config, char *id, int visual_type, void *visual)
 load a specific video output plugin.

+char** xine_list_audio_output_plugins (void)
 generate a list of all available audio output plugins.

+ao_functions_t* xine_load_audio_output_plugin (config_values_t *config, char *id)
 load a specific audio output plugin.

+

Detailed Description

+output plugin load support functions

Define Documentation

+

+ + + + +
+ + +
+#define XINE_PLUGINDIR   "/usr/local/lib/xine/plugins" +
+
+ + + + + +
+   + + +

+Plugin files location.

+

Function Documentation

+

+ + + + +
+ + + + + + +
+char ** xine_list_audio_output_plugins ( + +void ) +
+
+ + + + + +
+   + + +

+generate a list of all available audio output plugins. +

+

+Returns:
+a list of available audio output plugins the list returned is sorted by plugin priority
+

+ + + + +
+ + + + + + +
+char ** xine_list_video_output_plugins ( + +int visual_type ) +
+
+ + + + + +
+   + + +

+list available video output plugins. +

+

+Parameters:
+ + +
visual_type +  +see Valid visual types
+
+Returns:
+a list of available video output plugins for the specified visual type - the list is sorted by plugin priority
+See also:
+Valid visual types
+Parameters:
+ + +
visual_type +  +
+
+

+ + + + +
+ + + + + + + + + + +
+ao_functions_t * xine_load_audio_output_plugin ( + +config_values_t * config, +
+char * id ) +
+
+ + + + + +
+   + + +

+load a specific audio output plugin. +

+

+Parameters:
+ + + +
config +  +current configuration ( see config_file_init() )
id +  +driver name.
+
+See also:
+ao_functions_t
+Parameters:
+ + + +
config +  +
id +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
+vo_driver_t * xine_load_video_output_plugin ( + +config_values_t * config, +
+char * id, +
+int visual_type, +
+void * visual ) +
+
+ + + + + +
+   + + +

+load a specific video output plugin. +

+

+Parameters:
+ + + + + +
config +  +current configuration ( see config_file_init() )
id +  +driver name.
visual_type +  +see Valid visual types
visual +  +visual type dependant data pointer.
+
+See also:
+vo_driver_t, Valid visual types
+Parameters:
+ + + + + +
config +  +
id +  +
visual_type +  +
visual +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Types of available mrls

+ + + + + + + + + + + + + + + + + + +

Defines

+#define mrl_unknown   (0 << 0)
+#define mrl_dvd   (1 << 0)
+#define mrl_vcd   (1 << 1)
+#define mrl_net   (1 << 2)
+#define mrl_rtp   (1 << 3)
+#define mrl_stdin   (1 << 4)
+#define mrl_file   (1 << 5)
+#define mrl_file_fifo   (1 << 6)
+#define mrl_file_chardev   (1 << 7)
+#define mrl_file_directory   (1 << 8)
+#define mrl_file_blockdev   (1 << 9)
+#define mrl_file_normal   (1 << 10)
+#define mrl_file_symlink   (1 << 11)
+#define mrl_file_sock   (1 << 12)
+#define mrl_file_exec   (1 << 13)
+#define mrl_file_backup   (1 << 14)
+#define mrl_file_hidden   (1 << 15)
+

Detailed Description

+These types are bit field, can be used ORed/ANDed.
+See also:
+mrl_t

Define Documentation

+

+ + + + +
+ + +
+#define mrl_dvd   (1 << 0) +
+
+ + + + + +
+   + + +

+DVD mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file   (1 << 5) +
+
+ + + + + +
+   + + +

+File mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_backup   (1 << 14) +
+
+ + + + + +
+   + + +

+Backup file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_blockdev   (1 << 9) +
+
+ + + + + +
+   + + +

+Block device file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_chardev   (1 << 7) +
+
+ + + + + +
+   + + +

+Char device file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_directory   (1 << 8) +
+
+ + + + + +
+   + + +

+Directory file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_exec   (1 << 13) +
+
+ + + + + +
+   + + +

+Executable file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_fifo   (1 << 6) +
+
+ + + + + +
+   + + +

+Fifo file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_hidden   (1 << 15) +
+
+ + + + + +
+   + + +

+Hidden file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_normal   (1 << 10) +
+
+ + + + + +
+   + + +

+Normal file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_sock   (1 << 12) +
+
+ + + + + +
+   + + +

+Socket file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_file_symlink   (1 << 11) +
+
+ + + + + +
+   + + +

+Soft link file mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_net   (1 << 2) +
+
+ + + + + +
+   + + +

+Network mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_rtp   (1 << 3) +
+
+ + + + + +
+   + + +

+Multicast mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_stdin   (1 << 4) +
+
+ + + + + +
+   + + +

+Standart input mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_unknown   (0 << 0) +
+
+ + + + + +
+   + + +

+Unknow mrl type.

+See also:
+mrl_t
+

+ + + + +
+ + +
+#define mrl_vcd   (1 << 1) +
+
+ + + + + +
+   + + +

+VCD mrl type.

+See also:
+mrl_t
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Player status constants

+ + + + + +

Defines

+#define XINE_STOP   0
+#define XINE_PLAY   1
+#define XINE_PAUSE   2
+#define XINE_QUIT   3
+

Define Documentation

+

+ + + + +
+ + +
+#define XINE_PAUSE   2 +
+
+ + + + + +
+   + + +

+Pause status.

+See also:
+xine_get_status()
+

+ + + + +
+ + +
+#define XINE_PLAY   1 +
+
+ + + + + +
+   + + +

+Play status.

+See also:
+xine_get_status()
+

+ + + + +
+ + +
+#define XINE_QUIT   3 +
+
+ + + + + +
+   + + +

+Quit status.

+See also:
+xine_get_status()
+

+ + + + +
+ + +
+#define XINE_STOP   0 +
+
+ + + + + +
+   + + +

+Stop status.

+See also:
+xine_get_status()
+

Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

UI communication callbacks.

+ + + + +

Typedefs

+typedef void (* gui_stream_end_cb_t )(int nStatus)
+typedef char* (* gui_get_next_mrl_cb_t )(void)
+typedef void (* gui_branched_cb_t )(void)
+

Typedef Documentation

+

+ + + + +
+ + + + + +
+typedef void(* gui_branched_cb_t)(void) +
+
+ + + + + +
+   + + +

+Called when xine branched successfully to the next mrl.

+See also:
+xine_init()
+

+ + + + +
+ + + + + +
+typedef char *(* gui_get_next_mrl_cb_t)(void) +
+
+ + + + + +
+   + + +

+Called when xine tries to branch seamlessly to the next mrl.

+See also:
+xine_init()
+

+ + + + +
+ + + + + +
+typedef void(* gui_stream_end_cb_t)(int nStatus) +
+
+ + + + + +
+   + + +

+Notify UI when the stream is finished.

+See also:
+xine_init()
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Version constants

+ + + + +

Defines

+#define XINE_MAJOR_VERSION   0
+#define XINE_MINOR_VERSION   5
+#define XINE_SUB_VERSION   0
+

Define Documentation

+

+ + + + +
+ + +
+#define XINE_MAJOR_VERSION   0 +
+
+ + + + + +
+   + + +

+Major version constant.

+

+ + + + +
+ + +
+#define XINE_MINOR_VERSION   5 +
+
+ + + + + +
+   + + +

+Minor version constant.

+

+ + + + +
+ + +
+#define XINE_SUB_VERSION   0 +
+
+ + + + + +
+   + + +

+Sub version constant.

+

Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

video driver capabilities

+ + + + + + +

Defines

+#define VO_CAP_HUE   0x00000010
+#define VO_CAP_SATURATION   0x00000020
+#define VO_CAP_BRIGHTNESS   0x00000040
+#define VO_CAP_CONTRAST   0x00000080
+#define VO_CAP_COLORKEY   0x00000100
+

Define Documentation

+

+ + + + +
+ + +
+#define VO_CAP_BRIGHTNESS   0x00000040 +
+
+ + + + + +
+   + + +

+Driver can set BRIGHTNESS value.

+

+ + + + +
+ + +
+#define VO_CAP_COLORKEY   0x00000100 +
+
+ + + + + +
+   + + +

+Driver can set COLORKEY value.

+

+ + + + +
+ + +
+#define VO_CAP_CONTRAST   0x00000080 +
+
+ + + + + +
+   + + +

+Driver can set CONTRAST value.

+

+ + + + +
+ + +
+#define VO_CAP_HUE   0x00000010 +
+
+ + + + + +
+   + + +

+Driver can set HUE value.

+

+ + + + +
+ + +
+#define VO_CAP_SATURATION   0x00000020 +
+
+ + + + + +
+   + + +

+Driver can set SATURATION value.

+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Video.

+ + + + + + + + + + + + + + + +

Modules

Possible ratios for the VO_PROP_ASPECT_RATIO call
Constants for the get/set properties functions.
video driver capabilities

Data Structures

struct  vo_driver_s
struct  vo_driver_s
struct  vo_driver_t
 Data type of structure vo_driver_s. More...

struct  vo_frame_t
struct  vo_overlay_t

Typedefs

+typedef void vo_frame_t
+typedef void vo_overlay_t
+typedef struct vo_driver_s vo_driver_t
+
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Constants for the get/set properties functions.

+ + + + + + + + + +

Defines

+#define VO_PROP_INTERLACED   0
+#define VO_PROP_ASPECT_RATIO   1
+#define VO_PROP_HUE   2
+#define VO_PROP_SATURATION   3
+#define VO_PROP_CONTRAST   4
+#define VO_PROP_BRIGHTNESS   5
+#define VO_PROP_COLORKEY   6
+#define VO_NUM_PROPERTIES   7
+

Define Documentation

+

+ + + + +
+ + +
+#define VO_NUM_PROPERTIES   7 +
+
+ + + + + +
+   + + +

+Number of available properties property.

+See also:
+vo_driver_t
+

+ + + + +
+ + +
+#define VO_PROP_ASPECT_RATIO   1 +
+
+ + + + + +
+   + + +

+Aspect ratio property.

+See also:
+vo_driver_t, Possible ratios for the VO_PROP_ASPECT_RATIO call
+

+ + + + +
+ + +
+#define VO_PROP_BRIGHTNESS   5 +
+
+ + + + + +
+   + + +

+Brightness property.

+See also:
+vo_driver_t
+

+ + + + +
+ + +
+#define VO_PROP_COLORKEY   6 +
+
+ + + + + +
+   + + +

+Colorkey property.

+See also:
+vo_driver_t
+

+ + + + +
+ + +
+#define VO_PROP_CONTRAST   4 +
+
+ + + + + +
+   + + +

+Contrast property.

+See also:
+vo_driver_t
+

+ + + + +
+ + +
+#define VO_PROP_HUE   2 +
+
+ + + + + +
+   + + +

+Hue property.

+See also:
+vo_driver_t
+

+ + + + +
+ + +
+#define VO_PROP_INTERLACED   0 +
+
+ + + + + +
+   + + +

+Interleave property.

+See also:
+vo_driver_t
+

+ + + + +
+ + +
+#define VO_PROP_SATURATION   3 +
+
+ + + + + +
+   + + +

+Saturation property.

+See also:
+vo_driver_t
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Possible ratios for the VO_PROP_ASPECT_RATIO call

+ + + + + +

Defines

+#define ASPECT_AUTO   0
+#define ASPECT_ANAMORPHIC   1
+#define ASPECT_FULL   2
+#define ASPECT_DVB   3
+

Detailed Description

+
+See also:
+VO_PROP_ASPECT_RATIO, vo_driver_t

Define Documentation

+

+ + + + +
+ + +
+#define ASPECT_ANAMORPHIC   1 +
+
+ + + + + +
+   + + +

+Set aspect ration to 16:9.

+See also:
+VO_PROP_ASPECT_RATIO
+

+ + + + +
+ + +
+#define ASPECT_AUTO   0 +
+
+ + + + + +
+   + + +

+Let video driver guessing aspect ratio.

+See also:
+VO_PROP_ASPECT_RATIO
+

+ + + + +
+ + +
+#define ASPECT_DVB   3 +
+
+ + + + + +
+   + + +

+Set aspect ration to 1:2.

+See also:
+VO_PROP_ASPECT_RATIO
+

+ + + + +
+ + +
+#define ASPECT_FULL   2 +
+
+ + + + + +
+   + + +

+Set aspect ration to 4:3.

+See also:
+VO_PROP_ASPECT_RATIO
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Valid visual types

+ + + + + +

Defines

+#define VISUAL_TYPE_X11   1
+#define VISUAL_TYPE_AA   2
+#define VISUAL_TYPE_FB   3
+#define VISUAL_TYPE_GTK   4
+

Define Documentation

+

+ + + + +
+ + +
+#define VISUAL_TYPE_AA   2 +
+
+ + + + + +
+   + + +

+Asci Art visual type.

+See also:
+xine_list_video_output_plugins, xine_load_video_output_plugin
+

+ + + + +
+ + +
+#define VISUAL_TYPE_FB   3 +
+
+ + + + + +
+   + + +

+Framebuffer visual type

+See also:
+xine_list_video_output_plugins, xine_load_video_output_plugin
+

+ + + + +
+ + +
+#define VISUAL_TYPE_GTK   4 +
+
+ + + + + +
+   + + +

+GTK visual type

+See also:
+xine_list_video_output_plugins, xine_load_video_output_plugin
+

+ + + + +
+ + +
+#define VISUAL_TYPE_X11   1 +
+
+ + + + + +
+   + + +

+X11 visual type.

+See also:
+xine_list_video_output_plugins, xine_load_video_output_plugin
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

API functions

+ + + + + + + + + + + +

Modules

Sending events
Loading plugins
Autoplay support
Browsing support
Engine management
Init functions
Video.
Version functions
Version constants
Player status constants
+
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Init functions

+ + + + + + + + + + + +

Modules

Possible demuxer guessing strategy.
UI communication callbacks.
Configuration structure type.

Functions

+config_values_t* config_file_init (char *filename)
 Configuration file initialisation.

+xine_t* xine_init (vo_driver_t *vo, ao_functions_t *ao, config_values_t *config, gui_stream_end_cb_t stream_end_cb, gui_get_next_mrl_cb_t get_next_mrl_cb, gui_branched_cb_t branched_cb)
 Initialisation of xine.

+void xine_exit (xine_t *self)
 De-initialisation of xine.

+

Function Documentation

+

+ + + + +
+ + + + + + +
+config_values_t * config_file_init ( + +char * filename ) +
+
+ + + + + +
+   + + +

+Configuration file initialisation. +

+

+Parameters:
+ + +
filename +  +Pathname of configuration file.
+
+Returns:
+Current config
+See also:
+config_values_t
+Warning:
+This function should be called at least one time before xine_init() call. +

+

Read config file and init a config object of config_values_t type (if it exists)
+Parameters:
+ + +
filename +  +
+
+

+ + + + +
+ + + + + + +
+void xine_exit ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+De-initialisation of xine. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration.
+
+Returns:
+Nothing
+See also:
+xine_init() +

+

De-init xine engine.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+xine_t * xine_init ( + +vo_driver_t * vo, +
+ao_functions_t * ao, +
+config_values_t * config, +
+gui_stream_end_cb_t stream_end_cb, +
+gui_get_next_mrl_cb_t get_next_mrl_cb, +
+gui_branched_cb_t branched_cb ) +
+
+ + + + + +
+   + + +

+Initialisation of xine. +

+

+Parameters:
+ + + + + + + +
vo +  +video driver ( see xine_load_video_output_plugin() )
ao +  +audio driver ( see xine_load_audio_output_plugin() )
config +  +current configuration ( see config_file_init() )
stream_end +  +cb called on stream end
get_next_mrl_cb +  +called to find out next mrl for seamless branching
branched_cb +  +called if seamless branch was taken
+
+Returns:
+Current xine engine configuration
+See also:
+vo_driver_t, ao_functions_t, config_values_t, gui_stream_end_cb_t, gui_get_next_mrl_cb_t, gui_branched_cb_t
+Warning:
+This function should be called before any other xine_*() function. +

+

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
+Parameters:
+ + + + + + + +
vo +  +
ao +  +
config +  +
stream_end_cb +  +
get_next_mrl_cb +  +
branched_cb +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Engine management

+ + + + + + + + + + + + + + + + + + + + + +

Functions

+void xine_play (xine_t *self, char *MRL, int pos)
 Start to play a stream.

+void xine_pause (xine_t *self)
 Pause toggle.

+void xine_stop (xine_t *self)
 Stop playing.

+int xine_eject (xine_t *self)
 Eject media.

+int xine_get_status (xine_t *self)
 Get current xine status.

+int xine_get_current_position (xine_t *self)
 Get current position.

+int xine_get_audio_channel (xine_t *self)
 Get current audio channel.

+void xine_select_audio_channel (xine_t *self, int channel)
 Set audio channel.

+int xine_get_spu_channel (xine_t *self)
 Get current sub-title channel.

+void xine_select_spu_channel (xine_t *self, int channel)
 Set sub-title channel.

+

Function Documentation

+

+ + + + +
+ + + + + + +
+int xine_eject ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Eject media. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+1 on success, 0 on failure. +

+

Tell current input plugin to eject media.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + +
+int xine_get_audio_channel ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Get current audio channel. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Current audio chennel +

+

Get current audio channel.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + +
+int xine_get_current_position ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Get current position. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Current position ( 0..65535 ) +

+

Get current position in stream.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + +
+int xine_get_spu_channel ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Get current sub-title channel. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Current sub-title channel +

+

Get current sub-title channel.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + +
+int xine_get_status ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Get current xine status. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Current status ( see Player status constants ) +

+

Return the current state of xine engine.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + +
+void xine_pause ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Pause toggle. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Nothing +

+

Toggle pause mode.
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + +
+void xine_play ( + +xine_t * self, +
+char * MRL, +
+int pos ) +
+
+ + + + + +
+   + + +

+Start to play a stream. +

+

+Parameters:
+ + + + +
self +  +Current xine engine configuration ( see xine_init() )
MRL +  +Media Resource Location to open
pos +  +Start from position (0..65535)
+
+Returns:
+Nothing +

+

Open a stream and play it
+Parameters:
+ + + + +
self +  +
MRL +  +
pos +  +
+
+

+ + + + +
+ + + + + + + + + + +
+void xine_select_audio_channel ( + +xine_t * self, +
+int channel ) +
+
+ + + + + +
+   + + +

+Set audio channel. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Nothing +

+

Set desired audio channel.
+Parameters:
+ + + +
self +  +
channel +  +
+
+

+ + + + +
+ + + + + + + + + + +
+void xine_select_spu_channel ( + +xine_t * self, +
+int channel ) +
+
+ + + + + +
+   + + +

+Set sub-title channel. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Nothing +

+

Set desired sub-title channel.
+Parameters:
+ + + +
self +  +
channel +  +
+
+

+ + + + +
+ + + + + + +
+void xine_stop ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Stop playing. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Nothing +

+

Stop the playback.
+Parameters:
+ + +
self +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Version functions

+ + + + + + + + + + + +

Functions

+char* xine_get_str_version (void)
 return string version, like "0.5.0".

+int xine_get_major_version (void)
 return version information.

+int xine_get_minor_version (void)
 return version information.

+int xine_get_sub_version (void)
 return version information.

+int xine_check_version (int major, int minor, int sub)
 check minimal version.

+

Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + +
+int xine_check_version ( + +int major, +
+int minor, +
+int sub ) +
+
+ + + + + +
+   + + +

+check minimal version. +

+

+Parameters:
+ + + + +
major +  +major version wanted.
minorr +  +minor version wanted.
sub +  +sub version wanted.
+
+Returns:
+1 if installed version is >= to desired, otherwise 0 +

+

Compare version numbers with xine installed version.
+Parameters:
+ + + + +
major +  +
minor +  +
sub +  +
+
+

+ + + + +
+ + + + + + +
+int xine_get_major_version ( + +void ) +
+
+ + + + + +
+   + + +

+return version information. +

+

+Parameters:
+ + +
None. +  +
+
+Returns:
+major version.
+

+ + + + +
+ + + + + + +
+int xine_get_minor_version ( + +void ) +
+
+ + + + + +
+   + + +

+return version information. +

+

+Parameters:
+ + +
None. +  +
+
+Returns:
+minor version.
+

+ + + + +
+ + + + + + +
+char * xine_get_str_version ( + +void ) +
+
+ + + + + +
+   + + +

+return string version, like "0.5.0". +

+

+Parameters:
+ + +
None. +  +
+
+Returns:
+string version
+

+ + + + +
+ + + + + + +
+int xine_get_sub_version ( + +void ) +
+
+ + + + + +
+   + + +

+return version information. +

+

+Parameters:
+ + +
None. +  +
+
+Returns:
+sub version.
+

Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

XINE, A Free Video Player Project - API reference Documentation

+

+

Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

XINE, A Free Video Player Project - API reference Modules

Here is a list of all modules: +
Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

ao_functions_t Struct Reference

#include <xine.h> +

+ +
+

Detailed Description

+Opaque data type. +

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

cfg_data_t Struct Reference

#include <xine.h> +

+ +
+

Detailed Description

+Opaque data type. +

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

config_values_s Struct Reference

#include <xine.h> +

+ + + + + + + + + +

Data Fields

char* (* lookup_str )(config_values_t *self, char *key, char *str_default)
int (* lookup_int )(config_values_t *self, char *key, int n_default)
void (* set_str )(config_values_t *self, char *key, char *value)
void (* set_int )(config_values_t *self, char *key, int value)
void (* save )(config_values_t *self)
void (* read )(config_values_t *self, char *filename)
cfg_data_t* data
+

Detailed Description

+Configuration file manipulation.
+See also:
+config_file_init()
+

+

Field Documentation

+

+ + + + +
+ + + + + +
+cfg_data_t * config_values_s::data +
+
+ + + + + +
+   + + +

+Contains private data of this configuration file.

+

+ + + + +
+ + + + + +
+int(* config_values_s::lookup_int)(config_values_t *self, char *key, int n_default) +
+
+ + + + + +
+   + + +

+Lookup integer values in configuration file.

+

+ + + + +
+ + + + + +
+char *(* config_values_s::lookup_str)(config_values_t *self, char *key, char *str_default) +
+
+ + + + + +
+   + + +

+Lookup string values in configuration file.

+

+ + + + +
+ + + + + +
+void(* config_values_s::read)(config_values_t *self, char *filename) +
+
+ + + + + +
+   + + +

+Read configuration file from disk, overriding values in memory. If you also want to clear values that are not in the file, use config_file_init() instead!

+

+ + + + +
+ + + + + +
+void(* config_values_s::save)(config_values_t *self) +
+
+ + + + + +
+   + + +

+Write configuration file to disk.

+

+ + + + +
+ + + + + +
+void(* config_values_s::set_int)(config_values_t *self, char *key, int value) +
+
+ + + + + +
+   + + +

+Set integer values in configuration file.

+

+ + + + +
+ + + + + +
+void(* config_values_s::set_str)(config_values_t *self, char *key, char *value) +
+
+ + + + + +
+   + + +

+Set string values in configuration file.

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

config_values_t Struct Reference

Data type of structure config_values_s. +More... +

+#include <xine.h> +

+ +
+

Detailed Description

+Data type of structure config_values_s. +

+

+See also:
+config_values_s.
+

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

mrl_t Struct Reference

#include <xine.h> +

+ + + + + + + +

Data Fields

char* origin
char* mrl
char* link
uint32_t type
off_t size
+

Detailed Description

+mrl type.
+See also:
+xine_get_browse_mrls(), MRL_ZERO, MRL_DUPLICATE, MRLS_DUPLICATE, Types of available mrls
+

+

Field Documentation

+

+ + + + +
+ + + + + +
+char * mrl_t::link +
+
+ + + + + +
+   + + +

+name of link, if exist, otherwise NULL

+

+ + + + +
+ + + + + +
+char * mrl_t::mrl +
+
+ + + + + +
+   + + +

+<type>://<location>

+

+ + + + +
+ + + + + +
+char * mrl_t::origin +
+
+ + + + + +
+   + + +

+Origin of grabbed mrls (eg: path for file plugin

+

+ + + + +
+ + + + + +
+off_t mrl_t::size +
+
+ + + + + +
+   + + +

+size of this source, may be 0

+

+ + + + +
+ + + + + +
+uint32_t mrl_t::type +
+
+ + + + + +
+   + + +

+match to mrl_type enum

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

vo_driver_s Struct Reference

#include <xine.h> +

+ + + + + + + + + + + + +

Data Fields

uint32_t (* get_capabilities )(vo_driver_t *self)
vo_frame_t* (* alloc_frame )(vo_driver_t *self)
void (* update_frame_format )(vo_driver_t *self, vo_frame_t *img, uint32_t width, uint32_t height, int ratio_code, int format)
void (* display_frame )(vo_driver_t *self, vo_frame_t *vo_img)
void (* overlay_blend )(vo_driver_t *self, vo_frame_t *vo_img, vo_overlay_t *overlay)
int (* get_property )(vo_driver_t *self, int property)
int (* set_property )(vo_driver_t *self, int property, int value)
void (* get_property_min_max )(vo_driver_t *self, int property, int *min, int *max)
int (* gui_data_exchange )(vo_driver_t *self, int data_type, void *data)
void (* exit )(vo_driver_t *self)
+

Detailed Description

+Video driver fonctions. +

+

Field Documentation

+

+ + + + +
+ + + + + +
+vo_frame_t *(* vo_driver_s::alloc_frame)(vo_driver_t *self) +
+
+ + + + + +
+   + + +

+Allocate an vo_frame_t struct, the driver must supply the copy, field and dispose functions

+

+ + + + +
+ + + + + +
+void(* vo_driver_s::display_frame)(vo_driver_t *self, vo_frame_t *vo_img) +
+
+ + + + + +
+   + + +

+Display a given frame

+

+ + + + +
+ + + + + +
+void(* vo_driver_s::exit)(vo_driver_t *self) +
+
+ + + + + +
+   + + +

+Leaving video driver.

+

+ + + + +
+ + + + + +
+uint32_t(* vo_driver_s::get_capabilities)(vo_driver_t *self) +
+
+ + + + + +
+   + + +

+Get capabilities of video driver.

+See also:
+video driver capabilities
+

+ + + + +
+ + + + + +
+int(* vo_driver_s::get_property)(vo_driver_t *self, int property) +
+
+ + + + + +
+   + + +

+Get value if property.

+See also:
+Constants for the get/set properties functions.
+

+ + + + +
+ + + + + +
+void(* vo_driver_s::get_property_min_max)(vo_driver_t *self, int property, int *min, int *max) +
+
+ + + + + +
+   + + +

+Get min/max values of property.

+See also:
+Constants for the get/set properties functions.
+

+ + + + +
+ + + + + +
+int(* vo_driver_s::gui_data_exchange)(vo_driver_t *self, int data_type, void *data) +
+
+ + + + + +
+   + + +

+General purpose communication channel between gui and driver +

+this should be used to propagate events, display data, window sizes etc. to the driver

+

+ + + + +
+ + + + + +
+void(* vo_driver_s::overlay_blend)(vo_driver_t *self, vo_frame_t *vo_img, vo_overlay_t *overlay) +
+
+ + + + + +
+   + + +

+Overlay functions

+

+ + + + +
+ + + + + +
+int(* vo_driver_s::set_property)(vo_driver_t *self, int property, int value) +
+
+ + + + + +
+   + + +

+Set value of property.

+See also:
+Constants for the get/set properties functions.
+

+ + + + +
+ + + + + +
+void(* vo_driver_s::update_frame_format)(vo_driver_t *self, vo_frame_t *img, uint32_t width, uint32_t height, int ratio_code, int format) +
+
+ + + + + +
+   + + +

+Check if the given image fullfills the format specified (re-)allocate memory if necessary

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

vo_driver_t Struct Reference

Data type of structure vo_driver_s. +More... +

+#include <xine.h> +

+ +
+

Detailed Description

+Data type of structure vo_driver_s. +

+

+See also:
+structure vo_driver_s.
+

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

vo_frame_t Struct Reference

#include <xine.h> +

+ +
+

Detailed Description

+Opaque data type.
+See also:
+vo_driver_t
+

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

vo_overlay_t Struct Reference

#include <xine.h> +

+ +
+

Detailed Description

+Opaque data type.
+See also:
+vo_driver_t
+

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

xine_t Struct Reference

#include <xine.h> +

+ +
+

Detailed Description

+Opaque data type.
+See also:
+xine_load_audio_output_plugin
+

+

The documentation for this struct was generated from the following file: +
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

xine.h

Go to the documentation of this file.
00001 /* !! DO NO EDIT THIS FILE, it is automatically generated */
+00031 /*
+00032  * $Id: xine_8h-source.html,v 1.1 2001/07/26 11:12:26 f1rmb Exp $
+00033  *
+00034  */
+00035 
+00036 #ifndef HAVE_XINE_H
+00037 #define HAVE_XINE_H
+00038 
+00039 #ifdef __cplusplus
+00040 extern "C" {
+00041 #endif
+00042 
+00043 #include <inttypes.h>
+00044 #include <unistd.h>
+00045 #include <sys/types.h>
+00046 
+00047 #ifndef DOC_HIDDEN
+00048 #include <xine/events.h>
+00049 #endif
+00050 
+00055 #define XINE_SKINDIR    "/usr/local/share/xine/skins"
+00056 
+00066 #define XINE_BUILD_CC      "gcc version 2.95.3 20010315 (release)"
+00067 
+00070 #define XINE_BUILD_OS      "Linux 2.4.5 i686"
+00071 
+00074 #define XINE_BUILD_DATE    "Thu 26 Jul 2001 09:17:10"
+00075 
+00093 #define XINE_STOP      0
+00094 
+00099 #define XINE_PLAY      1
+00100 
+00105 #define XINE_PAUSE     2
+00106 
+00111 #define XINE_QUIT      3
+00112 
+00124 #define XINE_MAJOR_VERSION 0
+00125 
+00129 #define XINE_MINOR_VERSION 5
+00130 
+00134 #define XINE_SUB_VERSION   0
+00135 
+00150 char *xine_get_str_version(void);
+00151 
+00159 int xine_get_major_version(void);
+00160 
+00168 int xine_get_minor_version(void);
+00169 
+00177 int xine_get_sub_version(void);
+00178 
+00189 int xine_check_version(int major, int minor, int sub);
+00190 
+00207 #define VO_CAP_HUE          0x00000010
+00208 
+00212 #define VO_CAP_SATURATION   0x00000020
+00213 
+00217 #define VO_CAP_BRIGHTNESS   0x00000040
+00218 
+00222 #define VO_CAP_CONTRAST     0x00000080
+00223 
+00227 #define VO_CAP_COLORKEY     0x00000100
+00228 
+00241 #define VO_PROP_INTERLACED      0
+00242 
+00247 #define VO_PROP_ASPECT_RATIO    1
+00248 
+00253 #define VO_PROP_HUE             2
+00254 
+00259 #define VO_PROP_SATURATION      3
+00260 
+00265 #define VO_PROP_CONTRAST        4
+00266 
+00271 #define VO_PROP_BRIGHTNESS      5
+00272 
+00277 #define VO_PROP_COLORKEY        6
+00278 
+00283 #define VO_NUM_PROPERTIES       7
+00284 
+00298 #define ASPECT_AUTO        0
+00299 
+00304 #define ASPECT_ANAMORPHIC  1
+00305 
+00310 #define ASPECT_FULL        2
+00311 
+00316 #define ASPECT_DVB         3
+00317 
+00325 typedef void vo_frame_t;
+00331 typedef void vo_overlay_t;
+00332 
+00338 typedef struct vo_driver_s vo_driver_t;
+00339 
+00344 struct vo_driver_s {
+00349   uint32_t (*get_capabilities) (vo_driver_t *self);
+00354   vo_frame_t* (*alloc_frame) (vo_driver_t *self);
+00359   void (*update_frame_format) (vo_driver_t *self, vo_frame_t *img,
+00360                                uint32_t width, uint32_t height, 
+00361                                int ratio_code, int format);
+00365   void (*display_frame) (vo_driver_t *self, vo_frame_t *vo_img);
+00369   void (*overlay_blend) (vo_driver_t *self, vo_frame_t *vo_img, vo_overlay_t *overlay);
+00377   int (*get_property) (vo_driver_t *self, int property);
+00382   int (*set_property) (vo_driver_t *self, 
+00383                        int property, int value);
+00388   void (*get_property_min_max) (vo_driver_t *self,
+00389                                 int property, int *min, int *max);
+00396   int (*gui_data_exchange) (vo_driver_t *self, int data_type,
+00397                             void *data);
+00401   void (*exit) (vo_driver_t *self);
+00402 
+00403 };
+00404 
+00422 typedef void xine_t;
+00427 typedef void ao_functions_t;
+00432 typedef void cfg_data_t;
+00438 typedef struct config_values_s config_values_t;
+00444 struct config_values_s {
+00448   char* (*lookup_str) (config_values_t *self,
+00449                        char *key, char *str_default);
+00453   int (*lookup_int) (config_values_t *self,
+00454                      char *key, int n_default);
+00458   void (*set_str) (config_values_t *self,
+00459                    char *key, char *value) ;
+00463   void (*set_int) (config_values_t *self,
+00464                    char *key, int value) ;
+00468   void (*save) (config_values_t *self);
+00474   void (*read) (config_values_t *self, char *filename);
+00478   cfg_data_t *data;
+00479 };
+00480 
+00494 config_values_t *config_file_init (char *filename);
+00495 
+00506 typedef void (*gui_stream_end_cb_t) (int nStatus);
+00511 typedef char* (*gui_get_next_mrl_cb_t) (void);
+00516 typedef void (*gui_branched_cb_t) (void);
+00517 
+00532 #define DEMUX_DEFAULT_STRATEGY    0
+00533 
+00538 #define DEMUX_REVERT_STRATEGY     1
+00539 
+00544 #define DEMUX_CONTENT_STRATEGY    2
+00545 
+00550 #define DEMUX_EXTENSION_STRATEGY  3
+00551 
+00572 xine_t *xine_init (vo_driver_t *vo, 
+00573                    ao_functions_t *ao,
+00574                    config_values_t *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 void xine_exit (xine_t *self);
+00589 
+00607 void xine_play (xine_t *self, char *MRL, int pos);
+00608 
+00617 void xine_pause (xine_t *self);
+00618 
+00627 void xine_stop (xine_t *self);
+00628 
+00637 int xine_eject(xine_t *self);
+00638 
+00647 int xine_get_status (xine_t *self);
+00648 
+00657 int xine_get_current_position (xine_t *self);
+00658 
+00667 int xine_get_audio_channel (xine_t *self);
+00668 
+00677 void xine_select_audio_channel (xine_t *self, int channel);
+00678 
+00687 int xine_get_spu_channel (xine_t *self);
+00688 
+00697 void xine_select_spu_channel (xine_t *self, int channel);
+00698 
+00715 char **xine_get_browsable_input_plugin_ids (xine_t *self) ;
+00716 
+00729 #define mrl_unknown        (0 << 0)
+00730 
+00735 #define mrl_dvd            (1 << 0)
+00736 
+00741 #define mrl_vcd            (1 << 1)
+00742 
+00747 #define mrl_net            (1 << 2)
+00748 
+00753 #define mrl_rtp            (1 << 3)
+00754 
+00759 #define mrl_stdin          (1 << 4)
+00760 
+00765 #define mrl_file           (1 << 5)
+00766 
+00771 #define mrl_file_fifo      (1 << 6)
+00772 
+00777 #define mrl_file_chardev   (1 << 7)
+00778 
+00783 #define mrl_file_directory (1 << 8)
+00784 
+00789 #define mrl_file_blockdev  (1 << 9)
+00790 
+00795 #define mrl_file_normal    (1 << 10)
+00796 
+00801 #define mrl_file_symlink   (1 << 11)
+00802 
+00807 #define mrl_file_sock      (1 << 12)
+00808 
+00813 #define mrl_file_exec      (1 << 13)
+00814 
+00819 #define mrl_file_backup    (1 << 14)
+00820 
+00825 #define mrl_file_hidden    (1 << 15)
+00826 
+00834 #define MRL_ZERO(m) {                                                         \
+00835   if((m)) {                                                                   \
+00836     if((m)->origin)                                                           \
+00837       free((m)->origin);                                                      \
+00838     if((m)->mrl)                                                              \
+00839       free((m)->mrl);                                                         \
+00840     if((m)->link)                                                             \
+00841       free((m)->link);                                                        \
+00842     (m)->origin = NULL;                                                       \
+00843     (m)->mrl    = NULL;                                                       \
+00844     (m)->link   = NULL;                                                       \
+00845     (m)->type   = 0;                                                          \
+00846     (m)->size   = (off_t) 0;                                                  \
+00847   }                                                                           \
+00848 }
+00849 
+00855 #define MRL_DUPLICATE(s, d) {                                                 \
+00856   assert((s) != NULL);                                                        \
+00857   assert((d) != NULL);                                                        \
+00858                                                                               \
+00859   if((s)->origin) {                                                           \
+00860     if((d)->origin) {                                                         \
+00861       (d)->origin = (char *) realloc((d)->origin, strlen((s)->origin) + 1);   \
+00862       sprintf((d)->origin, "%s", (s)->origin);                                \
+00863     }                                                                         \
+00864     else                                                                      \
+00865       (d)->origin = strdup((s)->origin);                                      \
+00866   }                                                                           \
+00867   else                                                                        \
+00868     (d)->origin = NULL;                                                       \
+00869                                                                               \
+00870   if((s)->mrl) {                                                              \
+00871     if((d)->mrl) {                                                            \
+00872       (d)->mrl = (char *) realloc((d)->mrl, strlen((s)->mrl) + 1);            \
+00873       sprintf((d)->mrl, "%s", (s)->mrl);                                      \
+00874     }                                                                         \
+00875     else                                                                      \
+00876       (d)->mrl = strdup((s)->mrl);                                            \
+00877   }                                                                           \
+00878   else                                                                        \
+00879     (d)->mrl = NULL;                                                          \
+00880                                                                               \
+00881   if((s)->link) {                                                             \
+00882     if((d)->link) {                                                           \
+00883       (d)->link = (char *) realloc((d)->link, strlen((s)->link) + 1);         \
+00884       sprintf((d)->link, "%s", (s)->link);                                    \
+00885     }                                                                         \
+00886     else                                                                      \
+00887       (d)->link = strdup((s)->link);                                          \
+00888   }                                                                           \
+00889   else                                                                        \
+00890     (d)->link = NULL;                                                         \
+00891                                                                               \
+00892   (d)->type = (s)->type;                                                      \
+00893   (d)->size = (s)->size;                                                      \
+00894 }
+00895 
+00901 #define MRLS_DUPLICATE(s, d) {                                                \
+00902   int i = 0;                                                                  \
+00903                                                                               \
+00904   assert((s) != NULL);                                                        \
+00905   assert((d) != NULL);                                                        \
+00906                                                                               \
+00907   while((s) != NULL) {                                                        \
+00908     d[i] = (mrl_t *) malloc(sizeof(mrl_t));                                   \
+00909     MRL_DUPLICATE(s[i], d[i]);                                                \
+00910     i++;                                                                      \
+00911   }                                                                           \
+00912 }
+00913 
+00919 typedef struct {
+00921   char         *origin;
+00923   char         *mrl;
+00925   char         *link;
+00927   uint32_t      type;
+00929   off_t         size;
+00930 } mrl_t;
+00931 
+00949 mrl_t **xine_get_browse_mrls (xine_t *self, char *plugin_id, char *start_mrl, int *num_mrls);
+00950 
+00966 char **xine_get_autoplay_input_plugin_ids (xine_t *self) ;
+00967 
+00978 char **xine_get_autoplay_mrls (xine_t *self, char *plugin_id, int *num_mrls);
+00979 
+00993 #define XINE_PLUGINDIR  "/usr/local/lib/xine/plugins"
+00994 
+01005 #define VISUAL_TYPE_X11   1
+01006 
+01011 #define VISUAL_TYPE_AA    2
+01012 
+01017 #define VISUAL_TYPE_FB    3
+01018 
+01023 #define VISUAL_TYPE_GTK   4
+01024 
+01034 char **xine_list_video_output_plugins (int visual_type);
+01035 
+01045 vo_driver_t *xine_load_video_output_plugin(config_values_t *config,
+01046                                            char *id, int visual_type, void *visual);
+01047 
+01053 char **xine_list_audio_output_plugins (void);
+01054 
+01062 ao_functions_t *xine_load_audio_output_plugin(config_values_t *config, char *id);
+01063 
+01073 #ifdef DOC_HIDDEN
+01074 
+01078 typedef void event_t;
+01079 #endif
+01080 
+01085 typedef void (*event_listener_t) (xine_t *xine, event_t *event, void *data);
+01086 
+01095 int xine_register_event_listener(xine_t *self, event_listener_t listener);
+01096 
+01105 int xine_remove_event_listener(xine_t *self, event_listener_t listener);
+01106 
+01115 void xine_send_event(xine_t *self, event_t *event, void *data);
+01116 
+01121 #ifdef __cplusplus
+01122 }
+01123 #endif
+01124 
+01125 #endif
+
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + 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 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

xine.h File Reference

+

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  config_values_s
struct  mrl_t
struct  vo_driver_s

Defines

#define XINE_SKINDIR   "/usr/local/share/xine/skins"
+#define XINE_BUILD_CC   "gcc version 2.95.3 20010315 (release)"
+#define XINE_BUILD_OS   "Linux 2.4.5 i686"
+#define XINE_BUILD_DATE   "Thu 26 Jul 2001 09:17:10"
+#define XINE_STOP   0
+#define XINE_PLAY   1
+#define XINE_PAUSE   2
+#define XINE_QUIT   3
+#define XINE_MAJOR_VERSION   0
+#define XINE_MINOR_VERSION   5
+#define XINE_SUB_VERSION   0
+#define VO_CAP_HUE   0x00000010
+#define VO_CAP_SATURATION   0x00000020
+#define VO_CAP_BRIGHTNESS   0x00000040
+#define VO_CAP_CONTRAST   0x00000080
+#define VO_CAP_COLORKEY   0x00000100
+#define VO_PROP_INTERLACED   0
+#define VO_PROP_ASPECT_RATIO   1
+#define VO_PROP_HUE   2
+#define VO_PROP_SATURATION   3
+#define VO_PROP_CONTRAST   4
+#define VO_PROP_BRIGHTNESS   5
+#define VO_PROP_COLORKEY   6
+#define VO_NUM_PROPERTIES   7
+#define ASPECT_AUTO   0
+#define ASPECT_ANAMORPHIC   1
+#define ASPECT_FULL   2
+#define ASPECT_DVB   3
+#define DEMUX_DEFAULT_STRATEGY   0
+#define DEMUX_REVERT_STRATEGY   1
+#define DEMUX_CONTENT_STRATEGY   2
+#define DEMUX_EXTENSION_STRATEGY   3
+#define mrl_unknown   (0 << 0)
+#define mrl_dvd   (1 << 0)
+#define mrl_vcd   (1 << 1)
+#define mrl_net   (1 << 2)
+#define mrl_rtp   (1 << 3)
+#define mrl_stdin   (1 << 4)
+#define mrl_file   (1 << 5)
+#define mrl_file_fifo   (1 << 6)
+#define mrl_file_chardev   (1 << 7)
+#define mrl_file_directory   (1 << 8)
+#define mrl_file_blockdev   (1 << 9)
+#define mrl_file_normal   (1 << 10)
+#define mrl_file_symlink   (1 << 11)
+#define mrl_file_sock   (1 << 12)
+#define mrl_file_exec   (1 << 13)
+#define mrl_file_backup   (1 << 14)
+#define mrl_file_hidden   (1 << 15)
+#define MRL_ZERO(m)
+#define MRL_DUPLICATE(s, d)
+#define MRLS_DUPLICATE(s, d)
+#define XINE_PLUGINDIR   "/usr/local/lib/xine/plugins"
+#define VISUAL_TYPE_X11   1
+#define VISUAL_TYPE_AA   2
+#define VISUAL_TYPE_FB   3
+#define VISUAL_TYPE_GTK   4

Typedefs

+typedef void vo_frame_t
+typedef void vo_overlay_t
+typedef struct vo_driver_s vo_driver_t
+typedef void xine_t
+typedef void ao_functions_t
+typedef void cfg_data_t
+typedef struct config_values_s config_values_t
+typedef void (* gui_stream_end_cb_t )(int nStatus)
+typedef char* (* gui_get_next_mrl_cb_t )(void)
+typedef void (* gui_branched_cb_t )(void)
+typedef void event_t
+typedef void (* event_listener_t )(xine_t *xine, event_t *event, void *data)

Functions

+char* xine_get_str_version (void)
 return string version, like "0.5.0".

+int xine_get_major_version (void)
 return version information.

+int xine_get_minor_version (void)
 return version information.

+int xine_get_sub_version (void)
 return version information.

+int xine_check_version (int major, int minor, int sub)
 check minimal version.

+config_values_t* config_file_init (char *filename)
 Configuration file initialisation.

+xine_t* xine_init (vo_driver_t *vo, ao_functions_t *ao, config_values_t *config, gui_stream_end_cb_t stream_end_cb, gui_get_next_mrl_cb_t get_next_mrl_cb, gui_branched_cb_t branched_cb)
 Initialisation of xine.

+void xine_exit (xine_t *self)
 De-initialisation of xine.

+void xine_play (xine_t *self, char *MRL, int pos)
 Start to play a stream.

+void xine_pause (xine_t *self)
 Pause toggle.

+void xine_stop (xine_t *self)
 Stop playing.

+int xine_eject (xine_t *self)
 Eject media.

+int xine_get_status (xine_t *self)
 Get current xine status.

+int xine_get_current_position (xine_t *self)
 Get current position.

+int xine_get_audio_channel (xine_t *self)
 Get current audio channel.

+void xine_select_audio_channel (xine_t *self, int channel)
 Set audio channel.

+int xine_get_spu_channel (xine_t *self)
 Get current sub-title channel.

+void xine_select_spu_channel (xine_t *self, int channel)
 Set sub-title channel.

+char** xine_get_browsable_input_plugin_ids (xine_t *self)
 Request list of browsable featured plugins.

+mrl_t** xine_get_browse_mrls (xine_t *self, char *plugin_id, char *start_mrl, int *num_mrls)
 Request available MRLs from plugins.

+char** xine_get_autoplay_input_plugin_ids (xine_t *self)
 Request playlist from plugin.

+char** xine_get_autoplay_mrls (xine_t *self, char *plugin_id, int *num_mrls)
 Request MRL list from plugin.

+char** xine_list_video_output_plugins (int visual_type)
 list available video output plugins.

+vo_driver_t* xine_load_video_output_plugin (config_values_t *config, char *id, int visual_type, void *visual)
 load a specific video output plugin.

+char** xine_list_audio_output_plugins (void)
 generate a list of all available audio output plugins.

+ao_functions_t* xine_load_audio_output_plugin (config_values_t *config, char *id)
 load a specific audio output plugin.

+int xine_register_event_listener (xine_t *self, event_listener_t listener)
 registers an event listener callback.

+int xine_remove_event_listener (xine_t *self, event_listener_t listener)
 Attempts to remove a registered event listener.

+void xine_send_event (xine_t *self, event_t *event, void *data)
 sends an event to all listeners.

+

Detailed Description

+ +

+

+Author:
+Guenter Bartsch <guenter@users.sourceforge.net> , Siegfried Langauf <siggi@users.sourceforge.net> , Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>
+Date:
+25/07/2001 +

+

API of XINE library. 
+   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
+ 
+
+

+

Define Documentation

+

+ + + + +
+ + +
+#define XINE_SKINDIR   "/usr/local/share/xine/skins" +
+
+ + + + + +
+   + + +

+Skin file location

+

Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + diff --git a/doc/xine-lib-API/html/xine_logo.png b/doc/xine-lib-API/html/xine_logo.png new file mode 100644 index 000000000..3aad01fc9 Binary files /dev/null and b/doc/xine-lib-API/html/xine_logo.png differ -- cgit v1.2.3