Remove libvlc_get_vlc_id()
authorRémi Denis-Courmont <remi@remlab.net>
Sun, 9 Aug 2009 15:12:04 +0000 (18:12 +0300)
committerRémi Denis-Courmont <remi@remlab.net>
Sun, 9 Aug 2009 15:24:05 +0000 (18:24 +0300)
It did not really work since VLC 0.9. Also, it was meant for use with
vlc_object_get() and the antique VLC_*() functions which are gone.

include/vlc/libvlc.h
src/control/core.c
src/libvlc.sym

index 6a56774..3d81e21 100644 (file)
@@ -139,16 +139,6 @@ libvlc_exception_get_message( const libvlc_exception_t *p_exception );
 VLC_PUBLIC_API libvlc_instance_t *
 libvlc_new( int , const char *const *, libvlc_exception_t *);
 
-/**
- * Return 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
- * \return the instance identifier
- */
-VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
-
 /**
  * Decrement the reference count of a libvlc instance, and destroy it
  * if it reaches zero.
@@ -215,15 +205,18 @@ VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 struct vlc_object_t;
 
 /**
- * Return the libvlc internal object, the main object that all other depend on.
- * Any of of this function should be considered an ugly hack and avoided at all
- * cost. E.g. you need to expose some functionality that is not provided by the
- * libvlc API directly with libvlccore.
- * Remember to release the object with vlc_object_release( obj* )
+ * Get the internal main VLC object.
+ * Use of this function is usually a hack and should be avoided.
+ * @note
+ * You will need to link with libvlccore to make any use of the underlying VLC
+ * object. The libvlccore programming and binary interfaces are not stable.
+ * @warning
+ * Remember to release the object with vlc_object_release().
  *
  * \param p_instance the libvlc instance
+ * @return a VLC object of type "libvlc"
  */
-VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *);
+VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
 
 /**
  * Frees an heap allocation (char *) returned by a LibVLC API.
index 9f180ea..9aece4a 100644 (file)
@@ -197,12 +197,6 @@ void libvlc_wait( libvlc_instance_t *p_i )
     libvlc_InternalWait( p_libvlc );
 }
 
-int libvlc_get_vlc_id( libvlc_instance_t *p_instance )
-{
-    assert( p_instance );
-    return 1;
-}
-
 const char * libvlc_get_version(void)
 {
     return VLC_Version();
index 1583c31..7e5cbb8 100644 (file)
@@ -38,7 +38,6 @@ libvlc_get_fullscreen
 libvlc_get_input_thread
 libvlc_get_log_verbosity
 libvlc_get_version
-libvlc_get_vlc_id
 libvlc_get_vlc_instance
 libvlc_log_clear
 libvlc_log_close