]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc.h
Removes trailing spaces. Removes tabs.
[vlc] / include / vlc / libvlc.h
index a39971576291a454053505d7889f5329841c40f5..85b2b0dbfc9a737a4026a37d781346aa1952c02b 100644 (file)
@@ -121,7 +121,6 @@ VLC_PUBLIC_API void libvlc_destroy( libvlc_instance_t *, libvlc_exception_t * );
 
 /** @}*/
 
-
 /*****************************************************************************
  * Media descriptor
  *****************************************************************************/
@@ -160,6 +159,36 @@ VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
                                    libvlc_meta_t e_meta,
                                    libvlc_exception_t *p_e );
 
+/* Tags */
+VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
+                                                     const char * key,
+                                                     const libvlc_tag_t tag,
+                                                     libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
+                                                         const char * key,
+                                                         const libvlc_tag_t tag,
+                                                         libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API int
+    libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
+                                                const char * key,
+                                                libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API libvlc_tag_t
+    libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
+                                                  int i,
+                                                  const char * key,
+                                                  libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API libvlc_media_list_t *
+    libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
+                                      libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API libvlc_event_manager_t *
+    libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
+                                           libvlc_exception_t * p_e );
+
 /** @}*/
 
 /*****************************************************************************
@@ -327,7 +356,7 @@ VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
 
 /** Set the media descriptor that will be used by the media_instance. If any,
  * previous md will be released.
- * \param p_mi the Media Instance 
+ * \param p_mi the Media Instance
  * \param p_md the Media Descriptor. Afterwards the p_md can safely be
  * destroyed.
  */
@@ -335,12 +364,12 @@ VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_ins
 
 /** Get the media descriptor used by the media_instance (if any). A copy of
  * the md is returned. NULL is returned if no media instance is associated.
- * \param p_mi the Media Instance 
+ * \param p_mi the Media Instance
  */
 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
 
 /** Get the Event Manager from which the media instance send event.
- * \param p_mi the Media Instance 
+ * \param p_mi the Media Instance
  */
 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
 
@@ -348,6 +377,8 @@ VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libv
 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
 
+VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
+
 /// \bug This might go away ... to be replaced by a broader system
 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
@@ -378,16 +409,22 @@ VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_
  * LibVLC Tag query
  * @{
  */
-VLC_PUBLIC_API libvlc_tag_query_t * 
+VLC_PUBLIC_API libvlc_tag_query_t *
     libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
 
-VLC_PUBLIC_API void 
+VLC_PUBLIC_API void
     libvlc_tag_query_release( libvlc_tag_query_t * );
 
-VLC_PUBLIC_API void 
+VLC_PUBLIC_API void
     libvlc_tag_query_retain( libvlc_tag_query_t * );
 
-VLC_PUBLIC_API vlc_bool_t 
+VLC_PUBLIC_API void
+    libvlc_tag_query_set_match_tag_and_key( libvlc_tag_query_t * p_q,
+                                            libvlc_tag_t tag,
+                                            char * psz_tag_key,
+                                            libvlc_exception_t * );
+
+VLC_PUBLIC_API vlc_bool_t
     libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
                             libvlc_exception_t * );
 
@@ -410,6 +447,20 @@ VLC_PUBLIC_API void
 VLC_PUBLIC_API void
     libvlc_media_list_retain( libvlc_media_list_t * );
 
+VLC_PUBLIC_API void
+    libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
+                                        const char * psz_uri,
+                                        libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+    libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
+                                            libvlc_media_descriptor_t *,
+                                            libvlc_exception_t *);
+
+VLC_PUBLIC_API libvlc_media_descriptor_t *
+    libvlc_media_list_media_descriptor( libvlc_media_list_t *,
+                                        libvlc_exception_t *);
+
 VLC_PUBLIC_API void
     libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
                                             libvlc_media_descriptor_t *,
@@ -440,14 +491,69 @@ VLC_PUBLIC_API void
 VLC_PUBLIC_API void
     libvlc_media_list_unlock( libvlc_media_list_t * );
 
+VLC_PUBLIC_API libvlc_media_list_t *
+    libvlc_media_list_flat_media_list( libvlc_media_list_t *,
+                                       libvlc_exception_t * );
+
 VLC_PUBLIC_API libvlc_event_manager_t *
     libvlc_media_list_event_manager( libvlc_media_list_t *,
                                     libvlc_exception_t * );
+/** @} */
+
+/*****************************************************************************
+ * Dynamic Media List
+ *****************************************************************************/
+/** defgroup libvlc_media_list MediaList
+ * \ingroup libvlc
+ * LibVLC Media List
+ * @{ */
+
+VLC_PUBLIC_API libvlc_dynamic_media_list_t *
+    libvlc_dynamic_media_list_new(  libvlc_media_list_t * p_mlist,
+                                    libvlc_tag_query_t * p_query,
+                                    libvlc_tag_t tag,
+                                    libvlc_exception_t * p_e );
+VLC_PUBLIC_API void
+    libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
+
+VLC_PUBLIC_API void
+    libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
+
+libvlc_media_list_t *
+    libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
+                                          libvlc_exception_t * p_e );
+
+/** @} */
+
+/*****************************************************************************
+ * Media Library
+ *****************************************************************************/
+/** defgroup libvlc_media_library Media Library
+ * \ingroup libvlc
+ * LibVLC Media Library
+ * @{
+ */
+VLC_PUBLIC_API libvlc_media_library_t *
+    libvlc_media_library_new( libvlc_instance_t * p_inst,
+                              libvlc_exception_t * p_e );
+VLC_PUBLIC_API void
+    libvlc_media_library_release( libvlc_media_library_t * p_mlib );
+VLC_PUBLIC_API void
+    libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
+
+
+VLC_PUBLIC_API void
+    libvlc_media_library_load( libvlc_media_library_t * p_mlib,
+                               libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+    libvlc_media_library_save( libvlc_media_library_t * p_mlib,
+                               libvlc_exception_t * p_e );
 
 VLC_PUBLIC_API libvlc_media_list_t *
-    libvlc_media_list_dynamic_sublist( libvlc_media_list_t *,
-                                       libvlc_tag_query_t *,
-                                       libvlc_exception_t * );
+    libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
+                                     libvlc_exception_t * p_e );
+
 
 /** @} */
 
@@ -481,6 +587,18 @@ VLC_PUBLIC_API void
     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
                                    libvlc_exception_t * p_e );
 
+VLC_PUBLIC_API void
+    libvlc_media_list_player_play_item_at_index(
+                                   libvlc_media_list_player_t * p_mlp,
+                                   int i_index,
+                                   libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+    libvlc_media_list_player_play_item(
+                                   libvlc_media_list_player_t * p_mlp,
+                                   libvlc_media_descriptor_t * p_md,
+                                   libvlc_exception_t * p_e );
+
 VLC_PUBLIC_API void
     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
                                    libvlc_exception_t * p_e );
@@ -684,13 +802,6 @@ VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc
 
 /** @} */
 
-/**
- * defgroup libvlc_vlm VLM
- * \ingroup libvlc
- * LibVLC VLM handling
- * @{
- */
-
 /** defgroup libvlc_audio Audio
  * \ingroup libvlc
  * LibVLC Audio handling
@@ -772,6 +883,34 @@ VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_e
 
 /** @} */
 
+/*****************************************************************************
+ * Services/Media Discovery
+ *****************************************************************************/
+/** defgroup libvlc_media_discoverer Media Discoverer
+ * \ingroup libvlc
+ * LibVLC Media Discoverer
+ * @{
+ */
+
+VLC_PUBLIC_API libvlc_media_discoverer_t *
+libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
+                                       const char * psz_name,
+                                       libvlc_exception_t * p_e );
+VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
+VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
+
+VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
+
+/**@} */
+
+/*****************************************************************************
+ * VLM
+ *****************************************************************************/
+/** defgroup libvlc_vlm VLM
+ * \ingroup libvlc
+ * LibVLC VLM
+ * @{
+ */
 
 /**
  * Add a broadcast, with one input
@@ -875,7 +1014,7 @@ VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_
  * \param p_instance the instance
  * \param psz_name the name of the broadcast
  * \param p_exception an initialized exception
- */ 
+ */
 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 
 /**
@@ -883,25 +1022,25 @@ VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_
  * \param p_instance the instance
  * \param psz_name the name of the broadcast
  * \param p_exception an initialized exception
- */ 
+ */
 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
-    
 /**
  * Seeks in the named broadcast.
  * \param p_instance the instance
  * \param psz_name the name of the broadcast
  * \param f_percentage the percentage to seek to
  * \param p_exception an initialized exception
- */ 
+ */
 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
                                            float, libvlc_exception_t * );
-   
 /**
  * Return information of the named broadcast.
  * \param p_instance the instance
  * \param psz_name the name of the broadcast
  * \param p_exception an initialized exception
- */ 
+ */
 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 
 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
@@ -918,7 +1057,6 @@ VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
 
 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
 
-/** @} */
 /** @} */
 
 /*****************************************************************************
@@ -948,14 +1086,14 @@ VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, uns
                                               libvlc_exception_t *p_e );
 
 /**
- * Open an instance to VLC message log 
+ * Open an instance to VLC message log
  * \param p_instance libvlc instance
  * \param exception an initialized exception pointer
  */
 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
 
 /**
- * Close an instance of VLC message log 
+ * Close an instance of VLC message log
  * \param p_log libvlc log instance
  * \param exception an initialized exception pointer
  */
@@ -985,13 +1123,13 @@ VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_
 
 /**
  * Releases a previoulsy allocated iterator
- * \param p_log libvlc log iterator 
+ * \param p_log libvlc log iterator
  * \param exception an initialized exception pointer
  */
 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 
 /**
- * Returns whether log iterator has more messages 
+ * Returns whether log iterator has more messages
  * \param p_log libvlc log iterator
  * \param exception an initialized exception pointer
  */
@@ -1048,9 +1186,8 @@ VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager
                                          void *p_user_data,
                                          libvlc_exception_t *p_e );
 
-
 /**
- * Get an event type name 
+ * Get an event type name
  * \param i_event_type the desired event
  */
 #define libvlc_event_type_name(a) #a