libvlc_meta_Publisher,
libvlc_meta_EncodedBy,
libvlc_meta_ArtworkURL,
- libvlc_meta_TrackID,
+ libvlc_meta_TrackID
/* Add new meta types HERE */
} libvlc_meta_t;
/**
* 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).
*
* Expected states by web plugins are:
libvlc_track_unknown = -1,
libvlc_track_audio = 0,
libvlc_track_video = 1,
- libvlc_track_text = 2,
+ libvlc_track_text = 2
} libvlc_track_type_t;
/** defgroup libvlc_media_stats_t LibVLC media statistics
int i_profile;
int i_level;
- /* Audio specific */
- unsigned i_channels;
- unsigned i_rate;
-
- /* Video specific */
- unsigned i_height;
- unsigned i_width;
+ union {
+ struct {
+ /* Audio specific */
+ unsigned i_channels;
+ unsigned i_rate;
+ } audio;
+ struct {
+ /* Video specific */
+ unsigned i_height;
+ unsigned i_width;
+ } video;
+ } u;
} libvlc_media_track_info_t;
/**
- * Create a media with a certain given media resource location.
+ * Create a media with a certain given media resource location,
+ * for instance a valid URL.
+ *
+ * \note To refer to a local file with this function,
+ * the file://... URI syntax <b>must</b> be used (see IETF RFC3986).
+ * We recommend using libvlc_media_new_path() instead when dealing with
+ * local files.
*
* \see libvlc_media_release
*
* \param p_instance the instance
- * \param psz_mrl the MRL to read
+ * \param psz_mrl the media location
* \return the newly created media or NULL on error
*/
VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_location(
const char * psz_mrl );
/**
- * Create a media with a certain file path.
+ * Create a media for a certain file path.
*
* \see libvlc_media_release
*
libvlc_instance_t *p_instance,
const char *path );
+/**
+ * Create a media for an already open file descriptor.
+ * The file descriptor shall be open for reading (or reading and writing).
+ *
+ * Regular file descriptors, pipe read descriptors and character device
+ * descriptors (including TTYs) are supported on all platforms.
+ * Block device descriptors are supported where available.
+ * Directory descriptors are supported on systems that provide fdopendir().
+ * Sockets are supported on all platforms where they are file descriptors,
+ * i.e. all except Windows.
+ *
+ * \note This library will <b>not</b> automatically close the file descriptor
+ * under any circumstance. Nevertheless, a file descriptor can usually only be
+ * rendered once in a media player. To render it a second time, the file
+ * descriptor should probably be rewound to the beginning with lseek().
+ *
+ * \see libvlc_media_release
+ *
+ * \version LibVLC 1.1.5 and later.
+ *
+ * \param p_instance the instance
+ * \param fd open file descriptor
+ * \return the newly created media or NULL on error
+ */
+VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_fd(
+ libvlc_instance_t *p_instance,
+ int fd );
+
+
/**
* Create a media as an empty node with a given name.
*
* \param psz_name the name of the node
* \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,
const char * psz_name );
* \param ppsz_options the options (as a string)
*/
VLC_PUBLIC_API void libvlc_media_add_option(
- libvlc_media_t * p_md,
+ libvlc_media_t *p_md,
const char * ppsz_options );
/**
* \param i_flags the flags for this option
*/
VLC_PUBLIC_API void libvlc_media_add_option_flag(
- libvlc_media_t * p_md,
+ libvlc_media_t *p_md,
const char * ppsz_options,
unsigned i_flags );
* \param p_md a 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.
*
* \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.
* \param e_meta the meta to read
* \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_Stopped, libvlc_Ended,
* libvlc_Error).
*
- * @see libvlc_state_t
- * \param p_meta_desc a media descriptor object
+ * \see libvlc_state_t
+ * \param p_md a media descriptor object
* \return state of media descriptor object
*/
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
- * @param p_md: media descriptor object
- * @param p_stats: structure that contain the statistics about the media
+ * Get the current statistics about the media
+ * \param p_md: media descriptor object
+ * \param p_stats: structure that contain the statistics about the media
* (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,
libvlc_media_stats_t *p_stats );
* \return event manager object
*/
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.
* \return duration of media item or -1 on error
*/
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.
* \see libvlc_media_get_meta
* \see libvlc_media_get_tracks_info
*
- * \param media media descriptor object
+ * \param p_md media descriptor object
*/
VLC_PUBLIC_API void
-libvlc_media_parse(libvlc_media_t *media);
+libvlc_media_parse( libvlc_media_t *p_md );
/**
* Parse a media.
*
* This fetches (local) meta data and tracks information.
- * The method is the asynchronous of libvlc_media_parse_async().
+ * The method is the asynchronous of libvlc_media_parse().
*
* To track when this is over you can listen to libvlc_MediaParsedChanged
* event. However if the media was already parsed you will not receive this
* \see libvlc_media_get_meta
* \see libvlc_media_get_tracks_info
*
- * \param media media descriptor object
+ * \param p_md media descriptor object
*/
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.
* \return true if media object has been parsed otherwise it returns false
*/
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
* \param p_new_user_data pointer to user data
*/
VLC_PUBLIC_API void
- libvlc_media_set_user_data( libvlc_media_t * p_md,
- void * p_new_user_data );
+ libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
/**
* Get media descriptor's user_data. user_data is specialized data
*
* \param p_md media descriptor object
*/
-VLC_PUBLIC_API void *
- libvlc_media_get_user_data( libvlc_media_t * p_md );
+VLC_PUBLIC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
/**
* Get media descriptor's elementary streams description
*
- * Note, you need to play the media _one_ time with --sout="#description"
- * Not doing this will result in an empty array, and doing it more than once
- * will duplicate the entries in the array each time. Something like this:
- *
- * @begincode
- * libvlc_media_player_t *player = libvlc_media_player_new_from_media(media);
- * libvlc_media_add_option_flag(media, "sout=\"#description\"");
- * libvlc_media_player_play(player);
- * // ... wait until playing
- * libvlc_media_player_release(player);
- * @endcode
+ * Note, you need to call libvlc_media_parse() or play the media at least once
+ * before calling this function.
+ * Not doing this will result in an empty array.
*
- * This is very likely to change in next release, and be done at the parsing
- * phase.
- *
- * \param media media descriptor object
+ * \param p_md media descriptor object
* \param tracks address to store an allocated array of Elementary Streams
* descriptions (must be freed by the caller)
*
* return the number of Elementary Streams
*/
VLC_PUBLIC_API
-int libvlc_media_get_tracks_info(libvlc_media_t *media,
- libvlc_media_track_info_t **tracks );
+int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
+ libvlc_media_track_info_t **tracks );
/** @}*/
projects / vlc / blobdiff