libvlc_media.h: fix documentation

[vlc] / include / vlc / mediacontrol_structures.h

diff --git a/include/vlc/mediacontrol_structures.h b/include/vlc/mediacontrol_structures.h
index 82c621e2a190a5491f05006fdb6dde737fcf091e..6a3748276664ddd6c649cda61bc1dd308b65bb97 100644 (file)
--- a/include/vlc/mediacontrol_structures.h
+++ b/include/vlc/mediacontrol_structures.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * control_structures.h: global header for mediacontrol
+ * mediacontrol_structures.h: global header for mediacontrol
  *****************************************************************************
- * Copyright (C) 2005 the VideoLAN team
+ * Copyright (C) 2005-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
@@ -20,6 +20,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
+
+/**
+ * \file
+ * This file defines libvlc mediacontrol_* data structures
+ */
+
 /**
  * \defgroup mediacontrol_structures MediaControl Structures
  * Data structures used in the MediaControl API.
@@ -27,13 +33,15 @@
  * @{
  */
 
-#ifndef _VLC_CONTROL_STRUCTURES_H
-#define _VLC_CONTROL_STRUCTURES_H 1
+#ifndef VLC_CONTROL_STRUCTURES_H
+#define VLC_CONTROL_STRUCTURES_H 1
 
 # ifdef __cplusplus
 extern "C" {
 # endif
 
+#include <stdint.h>
+
 /**
  * A position may have different origins:
  *  - absolute counts from the movie start
@@ -60,12 +68,14 @@ typedef enum {
 
 /**
  * Possible player status
+ * Note the order of these enums must match exactly the order of
+ * libvlc_state_t and input_state_e enums.
  */
 typedef enum {
-    mediacontrol_PlayingStatus, mediacontrol_PauseStatus,
-    mediacontrol_ForwardStatus, mediacontrol_BackwardStatus,
-    mediacontrol_InitStatus,    mediacontrol_EndStatus,
-    mediacontrol_UndefinedStatus
+    mediacontrol_UndefinedStatus=0, mediacontrol_InitStatus,
+    mediacontrol_BufferingStatus, mediacontrol_PlayingStatus,
+    mediacontrol_PauseStatus,     mediacontrol_StopStatus,
+    mediacontrol_EndStatus,       mediacontrol_ErrorStatus,
 } mediacontrol_PlayerStatus;
 
 /**
@@ -74,7 +84,7 @@ typedef enum {
 typedef struct {
     mediacontrol_PositionOrigin origin;
     mediacontrol_PositionKey key;
-    long value;
+    int64_t value;
 } mediacontrol_Position;
 
 /**
@@ -84,8 +94,8 @@ typedef struct {
 typedef struct {
     int  width;
     int  height;
-    long type;
-    vlc_int64_t date;
+    uint32_t type;
+    int64_t date;
     int  size;
     char *data;
 } mediacontrol_RGBPicture;
@@ -120,8 +130,8 @@ typedef struct {
 typedef struct {
     mediacontrol_PlayerStatus streamstatus;
     char *url;         /* The URL of the current media stream */
-    vlc_int64_t position;     /* actual location in the stream (in ms) */
-    vlc_int64_t length;         /* total length of the stream (in ms) */
+    int64_t position;  /* actual location in the stream (in ms) */
+    int64_t length;    /* total length of the stream (in ms) */
 } mediacontrol_StreamInformation;