More VLM API stuff
[vlc.git] / include / vlc / libvlc.h
index 210760c..ada485e 100644 (file)
@@ -4,7 +4,7 @@
  * Copyright (C) 1998-2005 the VideoLAN team
  * $Id: vlc.h 13701 2005-12-12 17:58:56Z zorglub $
  *
- * Authors: Clément Stenac <zorglub@videolan.org>
+ * Authors: Clément Stenac <zorglub@videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,7 +18,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /**
@@ -68,6 +68,20 @@ void libvlc_exception_init( libvlc_exception_t *p_exception );
  */
 int libvlc_exception_raised( libvlc_exception_t *p_exception );
 
+/**
+ * Raise an exception
+ * \param p_exception the exception to raise
+ * \param psz_message the exception message
+ */
+void libvlc_exception_raise( libvlc_exception_t *p_exception, char *psz_format, ... );
+
+/**
+ * Clear an exception object so it can be reused.
+ * The exception object must be initialized
+ * \param p_exception the exception to clear
+ */
+void libvlc_exception_clear( libvlc_exception_t * );
+
 /**
  * Get exception message
  * \param p_exception the exception to query
@@ -122,16 +136,117 @@ void libvlc_destroy( libvlc_instance_t *);
  * Start playing. You can give some additionnal playlist item options
  * that will be added to the item before playing it.
  * \param p_instance the instance
+ * \param i_id the item to play. If this is a negative number, the next
+ * item will be selected. Else, the item with the given ID will be played
  * \param i_options the number of options to add to the item
  * \param ppsz_options the options to add to the item
  * \param p_exception an initialized exception
  */
-void libvlc_playlist_play( libvlc_instance_t*, int, char **,
+void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
                            libvlc_exception_t * );
 
+/**
+ * Pause a running playlist, resume if it was stopped
+ * \param p_instance the instance to pause
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Checks if the playlist is running
+ * \param p_instance the instance
+ * \param p_exception an initialized exception
+ * \return 0 if the playlist is stopped or paused, 1 if it is running
+ */
+int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Get the number of items in the playlist
+ * \param p_instance the instance
+ * \param p_exception an initialized exception
+ * \return the number of items
+ */
+int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
+
+
+
+
+
+/**
+ * Stop playing
+ * \param p_instance the instance to stop
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Go to next playlist item (starts playback if it was stopped)
+ * \param p_instance the instance to use
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Go to previous playlist item (starts playback if it was stopped)
+ * \param p_instance the instance to use
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Remove all playlist items
+ * \param p_instance the instance
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Go to next playlist item
+ * \param p_instance the instance
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Go to Previous playlist item
+ * \param p_instance the instance
+ * \param p_exception an initialized exception
+ */
+void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Add an item at the end of the playlist
+ * If you need more advanced options, \see libvlc_playlist_add_extended
+ * \param p_instance the instance
+ * \param psz_uri the URI to open, using VLC format
+ * \param psz_name a name that you might want to give or NULL
+ * \return the identifier of the new item
+ */
+int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
+                         libvlc_exception_t * );
+
+/**
+ * Add an item at the end of the playlist, with additional input options
+ * \param p_instance the instance
+ * \param psz_uri the URI to open, using VLC format
+ * \param psz_name a name that you might want to give or NULL
+ * \param i_options the number of options to add
+ * \param ppsz_options strings representing the options to add
+ * \return the identifier of the new item
+ */
+int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
+                                  const char *, int, const char **,
+                                  libvlc_exception_t * );
+
+
+
 typedef struct libvlc_input_t libvlc_input_t;
 
-///\todo document me
+/* Get the input that is currently being played by the playlist
+ * \param p_instance the instance to use
+ * \param p_exception an initialized excecption
+ * \return an input object
+ */
 libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
                                            libvlc_exception_t * );
 
@@ -158,12 +273,136 @@ vlc_int64_t libvlc_input_get_length( libvlc_input_t *, libvlc_exception_t *);
 vlc_int64_t libvlc_input_get_time( libvlc_input_t *, libvlc_exception_t *);
 float libvlc_input_get_position( libvlc_input_t *, libvlc_exception_t *);
 
+
 /** @} */
 
+/** defgroup libvlc_video Video
+ * \ingroup libvlc
+ * LibVLC Video handling
+ * @{
+ */
+
+/**
+ * Toggle fullscreen status on video output
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ */
+void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * );
+
+/**
+ * Enable or disable fullscreen on a video output
+ * \param p_input the input
+ * \param b_fullscreen boolean for fullscreen status
+ * \param p_exception an initialized exception
+ */
+void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * );
+
+/**
+ * Get current fullscreen status
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ * \return the fullscreen status (boolean)
+ */
+int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
+
+/** @}
+ * defgroup libvlc_vlm VLM
+ * \ingroup libvlc
+ * LibVLC VLM handling
+ * @{
+ */
+
+
+/**
+ * Add a broadcast, with one input
+ * \param p_instance the instance
+ * \param psz_name the name of the new broadcast
+ * \param psz_input the input MRL
+ * \param psz_output the output MRL (the parameter to the "sout" variable)
+ * \param i_options number of additional options
+ * \param ppsz_options additional options
+ * \param b_enabled boolean for enabling the new broadcast
+ * \param b_loop Should this broadcast be played in loop ?
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
+                               int, char **, int, int, libvlc_exception_t * );
+
+/**
+ * Delete a media (vod or broadcast)
+ * \param p_instance the instance
+ * \param psz_name the media to delete
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
+
+/**
+ * Enable or disable a media (vod or broadcast)
+ * \param p_instance the instance
+ * \param psz_name the media to work on
+ * \param b_enabled the new status
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
+                             libvlc_exception_t *);
+
+/**
+ * Set the output for a media
+ * \param p_instance the instance
+ * \param psz_name the media to work on
+ * \param psz_output the output MRL (the parameter to the "sout" variable)
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
+                            libvlc_exception_t *);
+
+/**
+ * Set a media's input MRL. This will delete all existing inputs and
+ * add the specified one.
+ * \param p_instance the instance
+ * \param psz_name the media to work on
+ * \param psz_input the input MRL
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
+                           libvlc_exception_t *);
+
+
 
+/**
+ * Set output for a media
+ * \param p_instance the instance
+ * \param psz_name the media to work on
+ * \param b_loop the new status
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
+                          libvlc_exception_t *);
+
+
+
+
+/**
+ * Edit the parameters of a media. This will delete all existing inputs and
+ * add the specified one.
+ * \param p_instance the instance
+ * \param psz_name the name of the new broadcast
+ * \param psz_input the input MRL
+ * \param psz_output the output MRL (the parameter to the "sout" variable)
+ * \param i_options number of additional options
+ * \param ppsz_options additional options
+ * \param b_enabled boolean for enabling the new broadcast
+ * \param b_loop Should this broadcast be played in loop ?
+ * \param p_exception an initialized exception
+ */
+void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
+                              int, char **, int, int, libvlc_exception_t * );
+
+
+/** @} */
 
 # ifdef __cplusplus
 }
 # endif
 
-#endif /* <vlc/vlc_control.h> */
+#endif /* <vlc/libvlc.h> */