X11 pixmaps will not work as drawable

[vlc] / include / vlc / libvlc.h

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index f6fc51942a9ab7fab4280aa608df61ce6cd73f45..57c88b24a047357585a0928a6cec51643fc48e88 100644 (file)
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -555,19 +555,18 @@ VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_e
  * no effects.
  *
  * The specified identifier must correspond to an existing Input/Output class
- * X11 drawable. The caller shall ensure that the X11 server is the same as the
- * one the VLC instance has been configured with.
- * If XVideo is <b>not</b> supported or usable, it is assumed that the drawable
- * has the following properties in common with the default X11 screen:
- * depth, scan line pad, black pixel. This is a bug.
- * Using a pixmap rather than a window might not work as VLC might try to
- * get window properties and subscribe to window events.
+ * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
+ * the X11 server is the same as the one the VLC instance has been configured
+ * with.
+ * If XVideo is <b>not</b> used, it is assumed that the drawable has the
+ * following properties in common with the default X11 screen: depth, scan line
+ * pad, black pixel. This is a bug.
  *
  * \param p_mi the Media Player
- * \param drawable the ID of the X drawable
+ * \param drawable the ID of the X window
  * \param p_e an initialized exception pointer
  */
-VLC_PUBLIC_API void libvlc_media_player_set_xid ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
+VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
 
 /**
  * Set a Win32/Win64 API window handle (HWND) where the media player should