From e9d3fc29c17ce3cb3f609e65de4b4852681ae4ef Mon Sep 17 00:00:00 2001 From: Daniel Caujolle-Bert Date: Sun, 16 Sep 2001 23:13:45 +0000 Subject: Update docs. Fixed some warnings. configure.in is ready for 0.9.1. CVS patchset: 646 CVS date: 2001/09/16 23:13:45 --- doc/xine-lib-API/html/group__xine__management.html | 538 +++++++++++++++++++-- 1 file changed, 499 insertions(+), 39 deletions(-) (limited to 'doc/xine-lib-API/html/group__xine__management.html') diff --git a/doc/xine-lib-API/html/group__xine__management.html b/doc/xine-lib-API/html/group__xine__management.html index 0741a0136..7bd36d803 100644 --- a/doc/xine-lib-API/html/group__xine__management.html +++ b/doc/xine-lib-API/html/group__xine__management.html @@ -9,40 +9,219 @@
Main Page   Modules   Data Structures   File List   Data Fields   Globals  

Engine management

+ + + + + + + +void  - - - + + + + + + + + + - + - + - + - + + + + + - + - + - +

Defines

+#define SPEED_PAUSE   0
+#define SPEED_SLOW_4   1
+#define SPEED_SLOW_2   2
+#define SPEED_NORMAL   4
+#define SPEED_FAST_2   8
+#define SPEED_FAST_4   16

Functions

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

-void xine_pause (xine_t *self)
 Pause toggle.

-void xine_stop (xine_t *self)
+void xine_set_speed (xine_t *self, int speed)
 Set playback speed.

+int xine_get_speed (xine_t *self)
 Get the playback speed.

+void xine_set_av_offset (xine_t *self, int offset_pts)
 Set audio/video sync.

+int xine_get_av_offset (xine_t *self)
 Get audio/video sync.

+void xine_stop (xine_t *self)
 Stop playing.

-int xine_eject (xine_t *self)
+int xine_eject (xine_t *self)
 Eject media.

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

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

-int xine_get_audio_channel (xine_t *self)
+int xine_get_current_time (xine_t *self)
 get current pos in seconds.

+int xine_get_stream_length (xine_t *self)
 estimate length of input stream in seconds.

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

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

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

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

+

Define Documentation

+

+ + + + +
+ + +
+#define SPEED_FAST_2   8 +
+
+ + + + + +
+   + + +

+Playback at 200% speed.

+See also:
+xine_set_speed(), xine_get_speed()
+

+ + + + +
+ + +
+#define SPEED_FAST_4   16 +
+
+ + + + + +
+   + + +

+Playback at 400% speed.

+See also:
+xine_set_speed(), xine_get_speed()
+

+ + + + +
+ + +
+#define SPEED_NORMAL   4 +
+
+ + + + + +
+   + + +

+Playback at 100% speed.

+See also:
+xine_set_speed(), xine_get_speed()
+

+ + + + +
+ + +
+#define SPEED_PAUSE   0 +
+
+ + + + + +
+   + + +

+Playback pause.

+See also:
+xine_set_speed(), xine_get_speed()
+

+ + + + +
+ + +
+#define SPEED_SLOW_2   2 +
+
+ + + + + +
+   + + +

+Playback at 50% speed.

+See also:
+xine_set_speed(), xine_get_speed()
+

+ + + + +
+ + +
+#define SPEED_SLOW_4   1 +
+
+ + + + + +
+   + + +

+Playback at 25% speed.

+See also:
+xine_set_speed(), xine_get_speed()

Function Documentation

-

+

@@ -91,7 +270,7 @@ Current xine engine configuration ( see xin
-

+

@@ -140,7 +319,56 @@ Current audio chennel
-

+

+ + + + +
+ + + + + + +
+int xine_get_av_offset ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Get audio/video sync. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+Current audio/video offset. +

+

Return the current audio/video sync offset ( see xine_set_av_offset() ).
+Parameters:
+ + +
self +  +
+
+

@@ -189,7 +417,105 @@ Current position ( 0..65535 )
-

+

+ + + + +
+ + + + + + +
+int xine_get_current_time ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+get current pos in seconds. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+current position measured in seconds from the beginning of the stream +

+

get current position measured in seconds from the beginning of the stream
+Parameters:
+ + +
self +  +
+
+

+ + + + +
+ + + + + + +
+int xine_get_speed ( + +xine_t * self ) +
+
+ + + + + +
+   + + +

+Get the playback speed. +

+

+Parameters:
+ + +
self +  +Current xine engine configuration ( see xine_init() )
+
+Returns:
+speed value ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 ) +

+

Get the current speed playback. Possible values are SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4.
+Parameters:
+ + +
self +  +
+
+

@@ -238,7 +564,7 @@ Current sub-title channel
-

+

@@ -287,14 +613,14 @@ Current status ( see Player status constants
-

+

-void xine_pause ( +int xine_get_stream_length ( xine_t * self ) @@ -313,7 +639,7 @@ void xine_pause (

-Pause toggle. +estimate length of input stream in seconds.

Parameters:
@@ -324,9 +650,9 @@ Current xine engine configuration ( see xin
Returns:
-Nothing +length of input stream in seconds or 0 if stream is not seekable

-

Toggle pause mode.
+
estimate length of input stream in seconds
Parameters:
+ + + + @@ -385,15 +717,18 @@ Current xine engine configuration ( see xin - + +position measured in seconds from stream start
self @@ -358,7 +684,13 @@ char * MRL,
-int pos ) +int start_pos, +
+int start_time )
MRL   Media Resource Location to open
pos +
start_pos +  +position in input source (0..65535)
start_time   -Start from position (0..65535)
Returns:
Nothing

-

Open a stream and play it
+
Open a stream and play it. If both start position parameters are !=0 start_pos will be used for non-seekable streams both values will be ignored
Parameters:
- +
self @@ -402,14 +737,17 @@ Nothing
MRL  
pos +
start_pos +  +
start_time  
-

+

@@ -467,7 +805,7 @@ Nothing
-

+

@@ -525,7 +863,129 @@ Nothing
-

+

+ + + + +
+ + + + + + + + + + +
+void xine_set_av_offset ( + +xine_t * self, +
+int offset_pts ) +
+
+ + + + + +
+   + + +

+Set audio/video sync. +

+

+Parameters:
+ + + +
self +  +Current xine engine configuration ( see xine_init() )
offset_pts +  +New pts.
+
+Returns:
+Nothing +

+

Set audio/video sync offset, according to offset_pts value ( see xine_get_av_offset() ).
+Parameters:
+ + + +
self +  +
offset_pts +  +
+
+

+ + + + +
+ + + + + + + + + + +
+void xine_set_speed ( + +xine_t * self, +
+int speed ) +
+
+ + + + + +
+   + + +

+Set playback speed. +

+

+Parameters:
+ + + +
self +  +Current xine engine configuration ( see xine_init() )
speed +  +Desired playback speed ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 )
+
+Returns:
+Nothing +

+

Set the playback speed to desired speed, according of SPEED_x constant.
+Parameters:
+ + + +
self +  +
speed +  +
+
+

@@ -574,7 +1034,7 @@ Nothing
-

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +
Generated at Mon Sep 17 01:05:55 2001 for XINE, A Free Video Player Project - API reference by doxygen1.2.8 written by Dimitri van Heesch, -- cgit v1.2.3