/*****************************************************************************
- * control.h: global header for mediacontrol
+ * mediacontrol.h: global header for mediacontrol
*****************************************************************************
- * Copyright (C) 2005 the VideoLAN team
+ * Copyright (C) 2005-2008 the VideoLAN team
* $Id$
*
* Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+/**
+ * \file
+ * This file defines libvlc mediacontrol_* external API
+ */
+
/**
* \defgroup mediacontrol MediaControl
* This is the MediaControl API, * intended to provide a generic API to movie players.
*/
-#ifndef _VLC_CONTROL_H
-#define _VLC_CONTROL_H 1
+#ifndef VLC_CONTROL_H
+#define VLC_CONTROL_H 1
# ifdef __cplusplus
extern "C" {
#if defined( WIN32 )
#include <windows.h>
-#define WINDOWHANDLE HWND
+typedef HWND WINDOWHANDLE;
#else
-#define WINDOWHANDLE int
+typedef int WINDOWHANDLE;
#endif
#include <vlc/libvlc.h>
/**
* Free an exception structure created with mediacontrol_exception_create().
- * \return the exception
+ * \param p_exception the exception to free.
*/
VLC_PUBLIC_API void mediacontrol_exception_free(mediacontrol_Exception *exception);
* \param exception an initialized exception pointer
*/
VLC_PUBLIC_API char * mediacontrol_get_mrl( mediacontrol_Instance *self,
- mediacontrol_Exception *exception );
+ mediacontrol_Exception *exception );
/*****************************************************************************
* A/V functions
* \param visual_id the Xid or HWND, depending on the platform
* \param exception an initialized exception pointer
*/
-VLC_PUBLIC_API bool mediacontrol_set_visual( mediacontrol_Instance *self,
+VLC_PUBLIC_API int mediacontrol_set_visual( mediacontrol_Instance *self,
WINDOWHANDLE visual_id,
mediacontrol_Exception *exception );