Document media descriptor, media library, media service discover, vlm and message...

[vlc] / include / vlc / libvlc_vlm.h

diff --git a/include/vlc/libvlc_vlm.h b/include/vlc/libvlc_vlm.h
index 6f09f04daee60565165f3ff12188ee17b1fc9a78..aff9bcb81136ce22ede2e7d90f5793dce55f83bc 100644 (file)
--- a/include/vlc/libvlc_vlm.h
+++ b/include/vlc/libvlc_vlm.h
@@ -32,12 +32,21 @@ extern "C" {
 /*****************************************************************************
  * VLM
  *****************************************************************************/
-/** \defgroup libvlc_vlm VLM
+/** \defgroup libvlc_vlm libvlc_vlm
  * \ingroup libvlc
  * LibVLC VLM
  * @{
  */
 
+
+/**
+ * Release the vlm instance related to the given libvlc_instance_t
+ *
+ * \param p_instance the instance
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_vlm_release( libvlc_instance_t *, libvlc_exception_t * );
+
 /**
  * Add a broadcast, with one input.
  *
@@ -54,6 +63,21 @@ extern "C" {
 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
                                               int, char **, int, int, libvlc_exception_t * );
 
+/**
+ * Add a vod, with one input.
+ *
+ * \param p_instance the instance
+ * \param psz_name the name of the new vod media
+ * \param psz_input the input MRL
+ * \param i_options number of additional options
+ * \param ppsz_options additional options
+ * \param b_enabled boolean for enabling the new vod
+ * \param psz_mux the muxer of the vod media
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_vlm_add_vod( libvlc_instance_t *, char *, char *, int, char **,
+                                        int, char *, libvlc_exception_t * );
+
 /**
  * Delete a media (VOD or broadcast).
  *
@@ -118,6 +142,17 @@ VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
                                          libvlc_exception_t *);
 
+/**
+ * Set a media's vod muxer.
+ *
+ * \param p_instance the instance
+ * \param psz_name the media to work on
+ * \param psz_mux the new muxer
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_vlm_set_mux( libvlc_instance_t *p_instance, char *psz_name,
+                                        char *psz_mux, libvlc_exception_t *p_exception );
+
 /**
  * Edit the parameters of a media. This will delete all existing inputs and
  * add the specified one.
@@ -179,11 +214,20 @@ VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
  * \param p_instance the instance
  * \param psz_name the name of the broadcast
  * \param p_e an initialized exception pointer
+ * \return string with information about named media
  */
 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 
+/**
+ * Get information about media attribute from vlm.
+ *
+ * \param libvlc instance
+ * \param type of information
+ * \param default value
+ * \return value of media attribute
+ */
 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
-returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
+returnType libvlc_vlm_get_media_instance_## attr( libvlc_instance_t *, \
                         char *, int , libvlc_exception_t * );
 
 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
@@ -202,4 +246,4 @@ VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
 }
 # endif
 
-#endif /* <vlc/libvlc.h> */
+#endif /* <vlc/libvlc_vlm.h> */