X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Fmediacontrol.h;h=5f1c8aeafe49a49ebd6721004bca8467acdef46a;hb=48f7ca7f70c7228ce8863813aabe89e0f0ae848c;hp=7263f43fe3a393a4566ae12e3339d4cc437fc015;hpb=70bb5bccb040d4bf7870177f2c83bad8008bc9e1;p=vlc diff --git a/include/vlc/mediacontrol.h b/include/vlc/mediacontrol.h index 7263f43fe3..5f1c8aeafe 100644 --- a/include/vlc/mediacontrol.h +++ b/include/vlc/mediacontrol.h @@ -22,7 +22,7 @@ *****************************************************************************/ /** - * \defgroup mediacontrol MediaControl + * \defgroup mediacontrol MediaControl * This is the MediaControl API, * intended to provide a generic API to movie players. * * @{ @@ -43,95 +43,25 @@ extern "C" { #define WINDOWHANDLE int #endif +#include #include -/** - * RGBPicture structure - * This generic structure holds a picture in an encoding specified by type. - */ -typedef struct { - int width; - int height; - long type; - vlc_int64_t date; - int size; - char *data; -} mediacontrol_RGBPicture; - -/** - * Playlist sequence - * A simple list of strings. - */ -typedef struct { - int size; - char **data; -} mediacontrol_PlaylistSeq; - -typedef struct { - int code; - char *message; -} mediacontrol_Exception; - -/** - * Exception codes - */ -#define mediacontrol_PositionKeyNotSupported 1 -#define mediacontrol_PositionOriginNotSupported 2 -#define mediacontrol_InvalidPosition 3 -#define mediacontrol_PlaylistException 4 -#define mediacontrol_InternalException 5 - /** * mediacontrol_Instance is an opaque structure, defined in - * mediacontrol_internal.h. API users do not have to mess with it. + * mediacontrol_internal.h. API users do not have to mess with it. */ typedef struct mediacontrol_Instance mediacontrol_Instance; -/** - * Possible player status - */ -enum mediacontrol_PlayerStatusList -{ - mediacontrol_PlayingStatus, mediacontrol_PauseStatus, - mediacontrol_ForwardStatus, mediacontrol_BackwardStatus, - mediacontrol_InitStatus, mediacontrol_EndStatus, - mediacontrol_UndefinedStatus -}; -typedef enum mediacontrol_PlayerStatusList mediacontrol_PlayerStatus; - -/** - * Stream information - * This structure allows to quickly get various informations about the stream. - */ -typedef struct { - mediacontrol_PlayerStatus streamstatus; - char *url; /* The URL of the current media stream */ - vlc_int64_t position; /* actual location in the stream (in ms) */ - vlc_int64_t length; /* total length of the stream (in ms) */ -} mediacontrol_StreamInformation; - /************************************************************************** * Helper functions ***************************************************************************/ -/** - * Allocate a RGBPicture structure. - * \param datasize: the size of the data - */ -VLC_PRIVATE_API mediacontrol_RGBPicture *mediacontrol_RGBPicture__alloc( int datasize ); - /** * Free a RGBPicture structure. * \param pic: the RGBPicture structure */ VLC_PUBLIC_API void mediacontrol_RGBPicture__free( mediacontrol_RGBPicture *pic ); -VLC_PRIVATE_API mediacontrol_RGBPicture * - _mediacontrol_createRGBPicture( int, int, long, vlc_int64_t l_date, - char *, int); - -VLC_PRIVATE_API mediacontrol_PlaylistSeq *mediacontrol_PlaylistSeq__alloc( int size ); - VLC_PUBLIC_API void mediacontrol_PlaylistSeq__free( mediacontrol_PlaylistSeq *ps ); /** @@ -156,7 +86,14 @@ VLC_PUBLIC_API void mediacontrol_exception_init( mediacontrol_Exception *exception ); /** - * Free an exception structure. + * Clean up an existing exception structure after use. + * \param p_exception the exception to clean up. + */ +VLC_PUBLIC_API void +mediacontrol_exception_cleanup( mediacontrol_Exception *exception ); + +/** + * Free an exception structure created with mediacontrol_exception_create(). * \return the exception */ VLC_PUBLIC_API void mediacontrol_exception_free(mediacontrol_Exception *exception); @@ -183,7 +120,7 @@ mediacontrol_new( int argc, char **argv, mediacontrol_Exception *exception ); */ VLC_PUBLIC_API mediacontrol_Instance * mediacontrol_new_from_instance( libvlc_instance_t* p_instance, - mediacontrol_Exception *exception ); + mediacontrol_Exception *exception ); /** * Get the associated libvlc instance @@ -386,7 +323,7 @@ VLC_PUBLIC_API vlc_bool_t mediacontrol_set_visual( mediacontrol_Instance *self, * \return the rate */ VLC_PUBLIC_API int mediacontrol_get_rate( mediacontrol_Instance *self, - mediacontrol_Exception *exception ); + mediacontrol_Exception *exception ); /** * Set the playing rate, in percent @@ -395,8 +332,8 @@ VLC_PUBLIC_API int mediacontrol_get_rate( mediacontrol_Instance *self, * \param exception an initialized exception pointer */ VLC_PUBLIC_API void mediacontrol_set_rate( mediacontrol_Instance *self, - const int rate, - mediacontrol_Exception *exception ); + const int rate, + mediacontrol_Exception *exception ); /** * Get current fullscreen status @@ -405,7 +342,7 @@ VLC_PUBLIC_API void mediacontrol_set_rate( mediacontrol_Instance *self, * \return the fullscreen status */ VLC_PUBLIC_API int mediacontrol_get_fullscreen( mediacontrol_Instance *self, - mediacontrol_Exception *exception ); + mediacontrol_Exception *exception ); /** * Set fullscreen status @@ -414,8 +351,8 @@ VLC_PUBLIC_API int mediacontrol_get_fullscreen( mediacontrol_Instance *self, * \param exception an initialized exception pointer */ VLC_PUBLIC_API void mediacontrol_set_fullscreen( mediacontrol_Instance *self, - const int b_fullscreen, - mediacontrol_Exception *exception ); + const int b_fullscreen, + mediacontrol_Exception *exception ); # ifdef __cplusplus }