1 /*****************************************************************************
2 * control_structures.h: global header for mediacontrol
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
7 * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 * \defgroup mediacontrol_structures MediaControl Structures
25 * Data structures used in the MediaControl API.
30 #ifndef _VLC_CONTROL_STRUCTURES_H
31 #define _VLC_CONTROL_STRUCTURES_H 1
40 * A position may have different origins:
41 * - absolute counts from the movie start
42 * - relative counts from the current position
43 * - modulo counts from the current position and wraps at the end of the movie
46 mediacontrol_AbsolutePosition,
47 mediacontrol_RelativePosition,
48 mediacontrol_ModuloPosition
49 } mediacontrol_PositionOrigin;
52 * Units available in mediacontrol Positions
53 * - ByteCount number of bytes
54 * - SampleCount number of frames
55 * - MediaTime time in milliseconds
58 mediacontrol_ByteCount,
59 mediacontrol_SampleCount,
60 mediacontrol_MediaTime
61 } mediacontrol_PositionKey;
64 * Possible player status
65 * Note the order of these enums must match exactly the order of
66 * libvlc_state_t and input_state_e enums.
69 mediacontrol_UndefinedStatus=0, mediacontrol_InitStatus,
70 mediacontrol_BufferingStatus, mediacontrol_PlayingStatus,
71 mediacontrol_PauseStatus, mediacontrol_StopStatus,
72 mediacontrol_ForwardStatus, mediacontrol_BackwardStatus,
73 mediacontrol_EndStatus, mediacontrol_ErrorStatus,
74 } mediacontrol_PlayerStatus;
77 * MediaControl Position
80 mediacontrol_PositionOrigin origin;
81 mediacontrol_PositionKey key;
83 } mediacontrol_Position;
86 * RGBPicture structure
87 * This generic structure holds a picture in an encoding specified by type.
96 } mediacontrol_RGBPicture;
100 * A simple list of strings.
105 } mediacontrol_PlaylistSeq;
110 } mediacontrol_Exception;
115 #define mediacontrol_PositionKeyNotSupported 1
116 #define mediacontrol_PositionOriginNotSupported 2
117 #define mediacontrol_InvalidPosition 3
118 #define mediacontrol_PlaylistException 4
119 #define mediacontrol_InternalException 5
123 * This structure allows to quickly get various informations about the stream.
126 mediacontrol_PlayerStatus streamstatus;
127 char *url; /* The URL of the current media stream */
128 int64_t position; /* actual location in the stream (in ms) */
129 int64_t length; /* total length of the stream (in ms) */
130 } mediacontrol_StreamInformation;