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
38 * A position may have different origins:
39 * - absolute counts from the movie start
40 * - relative counts from the current position
41 * - modulo counts from the current position and wraps at the end of the movie
44 mediacontrol_AbsolutePosition,
45 mediacontrol_RelativePosition,
46 mediacontrol_ModuloPosition
47 } mediacontrol_PositionOrigin;
50 * Units available in mediacontrol Positions
51 * - ByteCount number of bytes
52 * - SampleCount number of frames
53 * - MediaTime time in milliseconds
56 mediacontrol_ByteCount,
57 mediacontrol_SampleCount,
58 mediacontrol_MediaTime
59 } mediacontrol_PositionKey;
62 * Possible player status
65 mediacontrol_PlayingStatus, mediacontrol_PauseStatus,
66 mediacontrol_ForwardStatus, mediacontrol_BackwardStatus,
67 mediacontrol_InitStatus, mediacontrol_EndStatus,
68 mediacontrol_UndefinedStatus
69 } mediacontrol_PlayerStatus;
72 * MediaControl Position
75 mediacontrol_PositionOrigin origin;
76 mediacontrol_PositionKey key;
78 } mediacontrol_Position;
81 * RGBPicture structure
82 * This generic structure holds a picture in an encoding specified by type.
91 } mediacontrol_RGBPicture;
95 * A simple list of strings.
100 } mediacontrol_PlaylistSeq;
105 } mediacontrol_Exception;
110 #define mediacontrol_PositionKeyNotSupported 1
111 #define mediacontrol_PositionOriginNotSupported 2
112 #define mediacontrol_InvalidPosition 3
113 #define mediacontrol_PlaylistException 4
114 #define mediacontrol_InternalException 5
118 * This structure allows to quickly get various informations about the stream.
121 mediacontrol_PlayerStatus streamstatus;
122 char *url; /* The URL of the current media stream */
123 vlc_int64_t position; /* actual location in the stream (in ms) */
124 vlc_int64_t length; /* total length of the stream (in ms) */
125 } mediacontrol_StreamInformation;