1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
.TH "Engine management" 3 "15 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Engine management \-
.SS "Defines"
.in +1c
.ti -1c
.RI "#define \fBSPEED_PAUSE\fP 0"
.br
.ti -1c
.RI "#define \fBSPEED_SLOW_4\fP 1"
.br
.ti -1c
.RI "#define \fBSPEED_SLOW_2\fP 2"
.br
.ti -1c
.RI "#define \fBSPEED_NORMAL\fP 4"
.br
.ti -1c
.RI "#define \fBSPEED_FAST_2\fP 8"
.br
.ti -1c
.RI "#define \fBSPEED_FAST_4\fP 16"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBxine_play\fP (\fBxine_t\fP *self, char *MRL, int start_pos, int start_time)"
.br
.RI "\fIStart to play a stream.\fP"
.ti -1c
.RI "void \fBxine_set_speed\fP (\fBxine_t\fP *self, int speed)"
.br
.RI "\fISet playback speed.\fP"
.ti -1c
.RI "int \fBxine_get_speed\fP (\fBxine_t\fP *self)"
.br
.RI "\fIGet the playback speed.\fP"
.ti -1c
.RI "void \fBxine_set_av_offset\fP (\fBxine_t\fP *self, int offset_pts)"
.br
.RI "\fISet audio/video sync.\fP"
.ti -1c
.RI "int \fBxine_get_av_offset\fP (\fBxine_t\fP *self)"
.br
.RI "\fIGet audio/video sync.\fP"
.ti -1c
.RI "void \fBxine_stop\fP (\fBxine_t\fP *self)"
.br
.RI "\fIStop playing.\fP"
.ti -1c
.RI "int \fBxine_eject\fP (\fBxine_t\fP *self)"
.br
.RI "\fIEject media.\fP"
.ti -1c
.RI "int \fBxine_get_status\fP (\fBxine_t\fP *self)"
.br
.RI "\fIGet current xine status.\fP"
.ti -1c
.RI "int \fBxine_get_current_position\fP (\fBxine_t\fP *self)"
.br
.RI "\fIGet current position.\fP"
.ti -1c
.RI "int \fBxine_get_current_time\fP (\fBxine_t\fP *self)"
.br
.RI "\fIget current pos in seconds.\fP"
.ti -1c
.RI "int \fBxine_get_stream_length\fP (\fBxine_t\fP *self)"
.br
.RI "\fIestimate length of input stream in seconds.\fP"
.ti -1c
.RI "int \fBxine_get_audio_channel\fP (\fBxine_t\fP *self)"
.br
.RI "\fIGet current audio channel.\fP"
.ti -1c
.RI "void \fBxine_select_audio_channel\fP (\fBxine_t\fP *self, int channel)"
.br
.RI "\fISet audio channel.\fP"
.ti -1c
.RI "int \fBxine_get_spu_channel\fP (\fBxine_t\fP *self)"
.br
.RI "\fIGet current sub-title channel.\fP"
.ti -1c
.RI "void \fBxine_select_spu_channel\fP (\fBxine_t\fP *self, int channel)"
.br
.RI "\fISet sub-title channel.\fP"
.in -1c
.SH "DEFINE DOCUMENTATION"
.PP
.SS "#define SPEED_FAST_2 8"
.PP
Playback at 200% speed.
.PP
\fBSee also: \fP
.in +1c
\fBxine_set_speed\fP(), \fBxine_get_speed\fP()
.SS "#define SPEED_FAST_4 16"
.PP
Playback at 400% speed.
.PP
\fBSee also: \fP
.in +1c
\fBxine_set_speed\fP(), \fBxine_get_speed\fP()
.SS "#define SPEED_NORMAL 4"
.PP
Playback at 100% speed.
.PP
\fBSee also: \fP
.in +1c
\fBxine_set_speed\fP(), \fBxine_get_speed\fP()
.SS "#define SPEED_PAUSE 0"
.PP
Playback pause.
.PP
\fBSee also: \fP
.in +1c
\fBxine_set_speed\fP(), \fBxine_get_speed\fP()
.SS "#define SPEED_SLOW_2 2"
.PP
Playback at 50% speed.
.PP
\fBSee also: \fP
.in +1c
\fBxine_set_speed\fP(), \fBxine_get_speed\fP()
.SS "#define SPEED_SLOW_4 1"
.PP
Playback at 25% speed.
.PP
\fBSee also: \fP
.in +1c
\fBxine_set_speed\fP(), \fBxine_get_speed\fP()
.SH "FUNCTION DOCUMENTATION"
.PP
.SS "int xine_eject (\fBxine_t\fP * self)"
.PP
Eject media.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
1 on success, 0 on failure.
.PP
Tell current input plugin to eject media.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_audio_channel (\fBxine_t\fP * self)"
.PP
Get current audio channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Current audio chennel
.PP
Get current audio channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_av_offset (\fBxine_t\fP * self)"
.PP
Get audio/video sync.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Current audio/video offset.
.PP
Return the current audio/video sync offset ( see \fBxine_set_av_offset\fP() ).
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_current_position (\fBxine_t\fP * self)"
.PP
Get current position.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Current position ( 0..65535 )
.PP
Get current position in stream.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_current_time (\fBxine_t\fP * self)"
.PP
get current pos in seconds.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
current position measured in seconds from the beginning of the stream
.PP
get current position measured in seconds from the beginning of the stream
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_speed (\fBxine_t\fP * self)"
.PP
Get the playback speed.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
speed value ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 )
.PP
Get the current speed playback. Possible values are SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_spu_channel (\fBxine_t\fP * self)"
.PP
Get current sub-title channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Current sub-title channel
.PP
Get current sub-title channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_status (\fBxine_t\fP * self)"
.PP
Get current xine status.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Current status ( see Player status constants )
.PP
Return the current state of xine engine.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "int xine_get_stream_length (\fBxine_t\fP * self)"
.PP
estimate length of input stream in seconds.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
length of input stream in seconds or 0 if stream is not seekable
.PP
estimate length of input stream in seconds
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.SS "void xine_play (\fBxine_t\fP * self, char * MRL, int start_pos, int start_time)"
.PP
Start to play a stream.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.TP
\fB\fIMRL\fP\fP
Media Resource Location to open
.TP
\fB\fIstart_pos\fP\fP
position in input source (0..65535)
.TP
\fB\fIstart_time\fP\fP
position measured in seconds from stream start
.PP
\fBReturns: \fP
.in +1c
Nothing
.PP
Open a stream and play it. If both start position parameters are !=0 start_pos will be used for non-seekable streams both values will be ignored
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.TP
\fB\fIMRL\fP\fP
.TP
\fB\fIstart_pos\fP\fP
.TP
\fB\fIstart_time\fP\fP
.SS "void xine_select_audio_channel (\fBxine_t\fP * self, int channel)"
.PP
Set audio channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Nothing
.PP
Set desired audio channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.TP
\fB\fIchannel\fP\fP
.SS "void xine_select_spu_channel (\fBxine_t\fP * self, int channel)"
.PP
Set sub-title channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Nothing
.PP
Set desired sub-title channel.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.TP
\fB\fIchannel\fP\fP
.SS "void xine_set_av_offset (\fBxine_t\fP * self, int offset_pts)"
.PP
Set audio/video sync.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.TP
\fB\fIoffset_pts\fP\fP
New pts.
.PP
\fBReturns: \fP
.in +1c
Nothing
.PP
Set audio/video sync offset, according to offset_pts value ( see \fBxine_get_av_offset\fP() ).
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.TP
\fB\fIoffset_pts\fP\fP
.SS "void xine_set_speed (\fBxine_t\fP * self, int speed)"
.PP
Set playback speed.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.TP
\fB\fIspeed\fP\fP
Desired playback speed ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 )
.PP
\fBReturns: \fP
.in +1c
Nothing
.PP
Set the playback speed to desired speed, according of SPEED_x constant.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
.TP
\fB\fIspeed\fP\fP
.SS "void xine_stop (\fBxine_t\fP * self)"
.PP
Stop playing.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
Current xine engine configuration ( see \fBxine_init\fP() )
.PP
\fBReturns: \fP
.in +1c
Nothing
.PP
Stop the playback.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIself\fP\fP
|
