Commit 2c4f04e2 authored by Rémi Duraffort's avatar Rémi Duraffort

libvlc headers: try to be consistent (cosmetics).

parent ff23d0ea
...@@ -96,14 +96,14 @@ VLC_PUBLIC_API void libvlc_clearerr (void); ...@@ -96,14 +96,14 @@ VLC_PUBLIC_API void libvlc_clearerr (void);
/** /**
* Sets the LibVLC error status and message for the current thread. * Sets the LibVLC error status and message for the current thread.
* Any previous error is overriden. * Any previous error is overriden.
* @return a nul terminated string in any case * \return a nul terminated string in any case
*/ */
const char *libvlc_vprinterr (const char *fmt, va_list ap); const char *libvlc_vprinterr (const char *fmt, va_list ap);
/** /**
* Sets the LibVLC error status and message for the current thread. * Sets the LibVLC error status and message for the current thread.
* Any previous error is overriden. * Any previous error is overriden.
* @return a nul terminated string in any case * \return a nul terminated string in any case
*/ */
const char *libvlc_printerr (const char *fmt, ...); const char *libvlc_printerr (const char *fmt, ...);
......
...@@ -75,7 +75,7 @@ typedef enum libvlc_meta_t { ...@@ -75,7 +75,7 @@ typedef enum libvlc_meta_t {
/** /**
* Note the order of libvlc_state_t enum must match exactly the order of * Note the order of libvlc_state_t enum must match exactly the order of
* @see mediacontrol_PlayerStatus, @see input_state_e enums, * \see mediacontrol_PlayerStatus, \see input_state_e enums,
* and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs). * and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs).
* *
* Expected states by web plugins are: * Expected states by web plugins are:
...@@ -205,7 +205,7 @@ VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path( ...@@ -205,7 +205,7 @@ VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path(
* \param psz_name the name of the node * \param psz_name the name of the node
* \return the new empty media or NULL on error * \return the new empty media or NULL on error
*/ */
VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node( VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_as_node(
libvlc_instance_t *p_instance, libvlc_instance_t *p_instance,
const char * psz_name ); const char * psz_name );
...@@ -222,7 +222,7 @@ VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node( ...@@ -222,7 +222,7 @@ VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
* \param ppsz_options the options (as a string) * \param ppsz_options the options (as a string)
*/ */
VLC_PUBLIC_API void libvlc_media_add_option( VLC_PUBLIC_API void libvlc_media_add_option(
libvlc_media_t * p_md, libvlc_media_t *p_md,
const char * ppsz_options ); const char * ppsz_options );
/** /**
...@@ -239,7 +239,7 @@ VLC_PUBLIC_API void libvlc_media_add_option( ...@@ -239,7 +239,7 @@ VLC_PUBLIC_API void libvlc_media_add_option(
* \param i_flags the flags for this option * \param i_flags the flags for this option
*/ */
VLC_PUBLIC_API void libvlc_media_add_option_flag( VLC_PUBLIC_API void libvlc_media_add_option_flag(
libvlc_media_t * p_md, libvlc_media_t *p_md,
const char * ppsz_options, const char * ppsz_options,
unsigned i_flags ); unsigned i_flags );
...@@ -271,14 +271,14 @@ VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md ); ...@@ -271,14 +271,14 @@ VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
* \param p_md a media descriptor object * \param p_md a media descriptor object
* \return string with mrl of media descriptor object * \return string with mrl of media descriptor object
*/ */
VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md ); VLC_PUBLIC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
/** /**
* Duplicate a media descriptor object. * Duplicate a media descriptor object.
* *
* \param p_md a media descriptor object. * \param p_md a media descriptor object.
*/ */
VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md ); VLC_PUBLIC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
/** /**
* Read the meta of the media. * Read the meta of the media.
...@@ -297,7 +297,7 @@ VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md ); ...@@ -297,7 +297,7 @@ VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
* \param e_meta the meta to read * \param e_meta the meta to read
* \return the media's meta * \return the media's meta
*/ */
VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md, VLC_PUBLIC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
libvlc_meta_t e_meta ); libvlc_meta_t e_meta );
/** /**
...@@ -329,20 +329,20 @@ VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md ); ...@@ -329,20 +329,20 @@ VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
* libvlc_Stopped, libvlc_Ended, * libvlc_Stopped, libvlc_Ended,
* libvlc_Error). * libvlc_Error).
* *
* @see libvlc_state_t * \see libvlc_state_t
* \param p_meta_desc a media descriptor object * \param p_md a media descriptor object
* \return state of media descriptor object * \return state of media descriptor object
*/ */
VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state( VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
libvlc_media_t *p_meta_desc ); libvlc_media_t *p_md );
/** /**
* get the current statistics about the media * Get the current statistics about the media
* @param p_md: media descriptor object * \param p_md: media descriptor object
* @param p_stats: structure that contain the statistics about the media * \param p_stats: structure that contain the statistics about the media
* (this structure must be allocated by the caller) * (this structure must be allocated by the caller)
* @return true if the statistics are available, false otherwise * \return true if the statistics are available, false otherwise
*/ */
VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md, VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
libvlc_media_stats_t *p_stats ); libvlc_media_stats_t *p_stats );
...@@ -371,7 +371,7 @@ libvlc_media_subitems( libvlc_media_t *p_md ); ...@@ -371,7 +371,7 @@ libvlc_media_subitems( libvlc_media_t *p_md );
* \return event manager object * \return event manager object
*/ */
VLC_PUBLIC_API libvlc_event_manager_t * VLC_PUBLIC_API libvlc_event_manager_t *
libvlc_media_event_manager( libvlc_media_t * p_md ); libvlc_media_event_manager( libvlc_media_t *p_md );
/** /**
* Get duration (in ms) of media descriptor object item. * Get duration (in ms) of media descriptor object item.
...@@ -380,7 +380,7 @@ VLC_PUBLIC_API libvlc_event_manager_t * ...@@ -380,7 +380,7 @@ VLC_PUBLIC_API libvlc_event_manager_t *
* \return duration of media item or -1 on error * \return duration of media item or -1 on error
*/ */
VLC_PUBLIC_API libvlc_time_t VLC_PUBLIC_API libvlc_time_t
libvlc_media_get_duration( libvlc_media_t * p_md ); libvlc_media_get_duration( libvlc_media_t *p_md );
/** /**
* Parse a media. * Parse a media.
...@@ -392,10 +392,10 @@ VLC_PUBLIC_API libvlc_time_t ...@@ -392,10 +392,10 @@ VLC_PUBLIC_API libvlc_time_t
* \see libvlc_media_get_meta * \see libvlc_media_get_meta
* \see libvlc_media_get_tracks_info * \see libvlc_media_get_tracks_info
* *
* \param media media descriptor object * \param p_md media descriptor object
*/ */
VLC_PUBLIC_API void VLC_PUBLIC_API void
libvlc_media_parse(libvlc_media_t *media); libvlc_media_parse( libvlc_media_t *p_md );
/** /**
* Parse a media. * Parse a media.
...@@ -412,10 +412,10 @@ libvlc_media_parse(libvlc_media_t *media); ...@@ -412,10 +412,10 @@ libvlc_media_parse(libvlc_media_t *media);
* \see libvlc_media_get_meta * \see libvlc_media_get_meta
* \see libvlc_media_get_tracks_info * \see libvlc_media_get_tracks_info
* *
* \param media media descriptor object * \param p_md media descriptor object
*/ */
VLC_PUBLIC_API void VLC_PUBLIC_API void
libvlc_media_parse_async(libvlc_media_t *media); libvlc_media_parse_async( libvlc_media_t *p_md );
/** /**
* Get Parsed status for media descriptor object. * Get Parsed status for media descriptor object.
...@@ -426,7 +426,7 @@ libvlc_media_parse_async(libvlc_media_t *media); ...@@ -426,7 +426,7 @@ libvlc_media_parse_async(libvlc_media_t *media);
* \return true if media object has been parsed otherwise it returns false * \return true if media object has been parsed otherwise it returns false
*/ */
VLC_PUBLIC_API int VLC_PUBLIC_API int
libvlc_media_is_parsed( libvlc_media_t * p_md ); libvlc_media_is_parsed( libvlc_media_t *p_md );
/** /**
* Sets media descriptor's user_data. user_data is specialized data * Sets media descriptor's user_data. user_data is specialized data
...@@ -437,8 +437,7 @@ VLC_PUBLIC_API int ...@@ -437,8 +437,7 @@ VLC_PUBLIC_API int
* \param p_new_user_data pointer to user data * \param p_new_user_data pointer to user data
*/ */
VLC_PUBLIC_API void VLC_PUBLIC_API void
libvlc_media_set_user_data( libvlc_media_t * p_md, libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
void * p_new_user_data );
/** /**
* Get media descriptor's user_data. user_data is specialized data * Get media descriptor's user_data. user_data is specialized data
...@@ -447,8 +446,7 @@ VLC_PUBLIC_API void ...@@ -447,8 +446,7 @@ VLC_PUBLIC_API void
* *
* \param p_md media descriptor object * \param p_md media descriptor object
*/ */
VLC_PUBLIC_API void * VLC_PUBLIC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
libvlc_media_get_user_data( libvlc_media_t * p_md );
/** /**
* Get media descriptor's elementary streams description * Get media descriptor's elementary streams description
...@@ -468,14 +466,14 @@ VLC_PUBLIC_API void * ...@@ -468,14 +466,14 @@ VLC_PUBLIC_API void *
* This is very likely to change in next release, and be done at the parsing * This is very likely to change in next release, and be done at the parsing
* phase. * phase.
* *
* \param media media descriptor object * \param p_md media descriptor object
* \param tracks address to store an allocated array of Elementary Streams * \param tracks address to store an allocated array of Elementary Streams
* descriptions (must be freed by the caller) * descriptions (must be freed by the caller)
* *
* return the number of Elementary Streams * return the number of Elementary Streams
*/ */
VLC_PUBLIC_API VLC_PUBLIC_API
int libvlc_media_get_tracks_info(libvlc_media_t *media, int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
libvlc_media_track_info_t **tracks ); libvlc_media_track_info_t **tracks );
/** @}*/ /** @}*/
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment