Usefull coment instead of "Gruik" (evenif I like the previous one...)

[vlc] / include / vlc / libvlc_structures.h

diff --git a/include/vlc/libvlc_structures.h b/include/vlc/libvlc_structures.h
index 3ab440d8b5cb35a2aeda57f39cdc25c241921e4d..f2eebd9c6390cb21cd709e9911549d3eb8f62f49 100644 (file)
--- a/include/vlc/libvlc_structures.h
+++ b/include/vlc/libvlc_structures.h
@@ -24,6 +24,8 @@
 #ifndef _LIBVLC_STRUCTURES_H
 #define _LIBVLC_STRUCTURES_H 1
 
+#include <stdint.h>
+
 # ifdef __cplusplus
 extern "C" {
 # endif
@@ -36,7 +38,7 @@ typedef struct libvlc_instance_t libvlc_instance_t;
  *****************************************************************************/
 
 /** \defgroup libvlc_exception libvlc_exception
- * \ingroup libvlc
+ * \ingroup libvlc_core
  * LibVLC Exceptions handling
  * @{
  */
@@ -54,19 +56,19 @@ typedef struct libvlc_exception_t
  * Time
  *****************************************************************************/
 /** \defgroup libvlc_time libvlc_time
- * \ingroup libvlc
+ * \ingroup libvlc_core
  * LibVLC Time support in libvlc
  * @{
  */
 
-typedef vlc_int64_t libvlc_time_t;
+typedef int64_t libvlc_time_t;
 
 /**@} */
 
 /*****************************************************************************
  * Media Descriptor
  *****************************************************************************/
-/** \defgroup libvlc_media_descriptor libvlc_media_descriptor
+/** \defgroup libvlc_media libvlc_media
  * \ingroup libvlc
  * LibVLC Media Descriptor handling
  * @{
@@ -74,7 +76,7 @@ typedef vlc_int64_t libvlc_time_t;
 
 /* Meta Handling */
 /** defgroup libvlc_meta libvlc_meta
- * \ingroup libvlc_media_descriptor
+ * \ingroup libvlc_media
  * LibVLC Media Meta
  * @{
  */
@@ -101,7 +103,7 @@ typedef enum libvlc_meta_t {
 
 /**@} */
 
-typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
+typedef struct libvlc_media_t libvlc_media_t;
 
 /**@} */
 
@@ -109,24 +111,34 @@ typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
 /*****************************************************************************
  * Media Instance
  *****************************************************************************/
-/** \defgroup libvlc_media_instance libvlc_media_instance
+/** \defgroup libvlc_media_player libvlc_media_player
  * \ingroup libvlc
  * LibVLC Media Instance handling
  * @{
  */
 
-typedef struct libvlc_media_instance_t libvlc_media_instance_t;
+typedef struct libvlc_media_player_t libvlc_media_player_t;
 
+/**
+ * Note the order of libvlc_state_t enum must match exactly the order of
+ * @see mediacontrol_PlayerStatus and @see input_state_e enums.
+ *
+ * Expected states by web plugins are:
+ * IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4,
+ * STOPPING=5, FORWARD=6, BACKWARD=7, ENDED=8, ERROR=9
+ */
 typedef enum libvlc_state_t
 {
-    libvlc_NothingSpecial,
-    libvlc_Stopped,
+    libvlc_NothingSpecial=0,
     libvlc_Opening,
     libvlc_Buffering,
-    libvlc_Ended,
-    libvlc_Error,
     libvlc_Playing,
-    libvlc_Paused
+    libvlc_Paused,
+    libvlc_Stopped,
+    libvlc_Forward,
+    libvlc_Backward,
+    libvlc_Ended,
+    libvlc_Error
 } libvlc_state_t;
 
 /**@} */
@@ -197,7 +209,7 @@ typedef struct libvlc_playlist_item_t
  * Video
  *****************************************************************************/
 /** \defgroup libvlc_video libvlc_video
- * \ingroup libvlc_media_instance
+ * \ingroup libvlc_media_player
  * LibVLC Video handling
  * @{
  */
@@ -241,7 +253,7 @@ typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
  *****************************************************************************/
 
 /** \defgroup libvlc_log libvlc_log
- * \ingroup libvlc
+ * \ingroup libvlc_core
  * LibVLC Message Logging
  * @{
  */