]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc.h
src/control: a bit of cleanup here and there
[vlc] / include / vlc / libvlc.h
index 73ed6872e012be1658d559058652b5351ed23cce..28f73c17e3eff899853cfa6b6b6b3815bb144938 100644 (file)
@@ -113,6 +113,14 @@ typedef struct libvlc_instance_t libvlc_instance_t;
  */
 libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
 
+/**
+ * Returns a libvlc instance identifier for legacy APIs. Use of this
+ * function is discouraged, you should convert your program to use the
+ * new API.
+ * \param p_instance the instance
+ */
+int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
+
 /**
  * Destroy a libvlc instance
  * \param p_instance the instance to destroy
@@ -194,20 +202,6 @@ void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
  */
 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
@@ -226,14 +220,23 @@ int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
  * \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
+ * \param p_exception an initialized exception
  * \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 * );
 
-
-
+/** 
+ * Delete the playlist item with the given ID.
+ * \param p_instance the instance
+ * \param i_id the id to remove
+ * \param p_exception an initialized exception
+ * \return
+ */
+int libvlc_playlist_delete_item( libvlc_instance_t *, int,
+                                 libvlc_exception_t * );
+    
 typedef struct libvlc_input_t libvlc_input_t;
 
 /* Get the input that is currently being played by the playlist
@@ -244,8 +247,6 @@ typedef struct libvlc_input_t libvlc_input_t;
 libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
                                            libvlc_exception_t * );
 
-
-
 /** @}*/
 
 /*****************************************************************************
@@ -263,11 +264,13 @@ libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
 void libvlc_input_free( libvlc_input_t * );
 
 /// \bug This might go away ... to be replaced by a broader system
-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 *);
-
-
+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 *);
+void        libvlc_input_set_time       ( libvlc_input_t *, vlc_int64_t, libvlc_exception_t *);
+float       libvlc_input_get_position   ( libvlc_input_t *, libvlc_exception_t *);
+void        libvlc_input_set_position   ( libvlc_input_t *, float, libvlc_exception_t *);
+vlc_bool_t  libvlc_input_will_play      ( libvlc_input_t *, libvlc_exception_t *);
+        
 /** @} */
 
 /** defgroup libvlc_video Video
@@ -276,6 +279,14 @@ float libvlc_input_get_position( libvlc_input_t *, libvlc_exception_t *);
  * @{
  */
 
+/**
+ * Does this input have a video output ?
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ */
+vlc_bool_t  libvlc_input_has_vout       ( libvlc_input_t *, libvlc_exception_t *);
+float       libvlc_input_get_fps        ( libvlc_input_t *, libvlc_exception_t *);
+
 /**
  * Toggle fullscreen status on video output
  * \param p_input the input
@@ -298,6 +309,61 @@ void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * );
  * \return the fullscreen status (boolean)
  */
 int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
+    
+/**
+ * Get current video height
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ * \return the video height
+ */
+int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * );
+
+/**
+ * Get current video width
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ * \return the video width
+ */
+int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * );
+
+/**
+ * Take a snapshot of the current video window
+ * \param p_input the input
+ * \param psz_filepath the path where to save the screenshot to
+ * \param p_exception an initialized exception
+ */
+void libvlc_video_take_snapshot( libvlc_input_t *, char *, libvlc_exception_t * );
+    
+int libvlc_video_destroy( libvlc_input_t *, libvlc_exception_t *);
+
+    
+/**
+ * Resize the video output window
+ * \param p_instance libvlc instance
+ * \param width new width for video output window
+ * \param height new height for video output window
+ * \param p_exception an initialized exception
+ * \return the mute status (boolean)
+ */
+void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *);
+    
+/**
+* Downcast to this general type as placeholder for a platform specific one, such as:
+*  Drawable on X11,
+*  CGrafPort on MacOSX,
+*  HWND on win32
+*/
+typedef int libvlc_drawable_t;
+
+/**
+ * Get current mute status
+ * \param p_instance libvlc instance
+ * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
+ * \param p_exception an initialized exception
+ * \return the mute status (boolean)
+ */
+int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * );
+
 
 /** @} */
 
@@ -308,6 +374,50 @@ int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
  * @{
  */
 
+/** defgroup libvlc_audio Audio
+ * \ingroup libvlc
+ * LibVLC Audio handling
+ * @{
+ */
+
+/**
+ * Get current mute status
+ * \param p_instance libvlc instance
+ * \param p_exception an initialized exception
+ * \return the mute status (boolean)
+ */
+vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Set mute status
+ * \param p_instance libvlc instance
+ * \param status If status is VLC_TRUE then mute, otherwise unmute
+ * \param p_exception an initialized exception
+ * \return void
+ */
+void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
+
+
+/**
+ * Get current audio level
+ * \param p_instance libvlc instance
+ * \param p_exception an initialized exception
+ * \return the audio level (int)
+ */
+int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
+
+
+/**
+ * Set current audio level
+ * \param p_instance libvlc instance
+ * \param i_volume the volume (int)
+ * \param p_exception an initialized exception
+ * \return void
+ */
+void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *);
+
+/** @} */
+
 
 /**
  * Add a broadcast, with one input
@@ -363,8 +473,6 @@ void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
                            libvlc_exception_t *);
 
-
-
 /**
  * Set output for a media
  * \param p_instance the instance
@@ -394,6 +502,32 @@ void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
                               int, char **, int, int, libvlc_exception_t * );
 
+/**
+ * Plays the named broadcast.
+ * \param p_instance the instance
+ * \param psz_name the name of the broadcast
+ * \param p_exception an initialized exception
+ */ 
+void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
+
+/**
+ * Stops the named broadcast.
+ * \param p_instance the instance
+ * \param psz_name the name of the broadcast
+ * \param p_exception an initialized exception
+ */ 
+void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
+
+    
+/**
+ * Pauses the named broadcast.
+ * \param p_instance the instance
+ * \param psz_name the name of the broadcast
+ * \param p_exception an initialized exception
+ */ 
+void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
+    
+    
 
 /** @} */
 /** @} */