vlc_preparser.h File Reference

VLC Preparser API. More...

Include dependency graph for vlc_preparser.h:

Go to the source code of this file.

Data Structures
struct	vlc_preparser_cbs
struct	vlc_thumbnailer_cbs
	Preparser thumbnailer callbacks. More...
struct	vlc_thumbnailer_to_files_cbs
	Preparser thumbnailer to file callbacks. More...
struct	vlc_thumbnailer_arg
	Thumbnailer argument. More...
struct	vlc_thumbnailer_arg::seek
	Seek argument. More...
struct	vlc_thumbnailer_output
	Thumbnailer output argument. More...
struct	vlc_preparser_cfg
	Preparser creation configuration. More...

Macros
#define	VLC_PREPARSER_TYPE_PARSE   0x01
#define	VLC_PREPARSER_TYPE_FETCHMETA_LOCAL   0x02
#define	VLC_PREPARSER_TYPE_FETCHMETA_NET   0x04
#define	VLC_PREPARSER_TYPE_THUMBNAIL   0x08
#define	VLC_PREPARSER_TYPE_THUMBNAIL_TO_FILES   0x10
#define	VLC_PREPARSER_TYPE_FETCHMETA_ALL    (VLC_PREPARSER_TYPE_FETCHMETA_LOCAL|VLC_PREPARSER_TYPE_FETCHMETA_NET)
#define	VLC_PREPARSER_OPTION_INTERACT   0x1000
#define	VLC_PREPARSER_OPTION_SUBITEMS   0x2000

Typedefs
typedef struct vlc_preparser_t	vlc_preparser_t
	Preparser opaque structure.
typedef struct vlc_preparser_req	vlc_preparser_req
	Preparser request opaque handle.

Enumerations
enum	vlc_thumbnailer_format {   VLC_THUMBNAILER_FORMAT_PNG , VLC_THUMBNAILER_FORMAT_WEBP , VLC_THUMBNAILER_FORMAT_JPEG , VLC_THUMBNAILER_FORMAT_RGBA ,   VLC_THUMBNAILER_FORMAT_ARGB }
	Thumbnailer output format. More...

Functions
vlc_preparser_t *	vlc_preparser_New (vlc_object_t *obj, const struct vlc_preparser_cfg *cfg)
	This function creates the preparser object and thread.
vlc_preparser_req *	vlc_preparser_Push (vlc_preparser_t *preparser, input_item_t *item, int type_option, const struct vlc_preparser_cbs *cbs, void *cbs_userdata)
	This function enqueues the provided item to be preparsed or fetched.
vlc_preparser_req *	vlc_preparser_GenerateThumbnail (vlc_preparser_t *preparser, input_item_t *item, const struct vlc_thumbnailer_arg *arg, const struct vlc_thumbnailer_cbs *cbs, void *cbs_userdata)
	This function enqueues the provided item for generating a thumbnail.
int	vlc_preparser_GetBestThumbnailerFormat (enum vlc_thumbnailer_format *format, const char **out_ext)
	Get the best possible format.
int	vlc_preparser_CheckThumbnailerFormat (enum vlc_thumbnailer_format format)
	Check if the format is handled by VLC.
vlc_preparser_req *	vlc_preparser_GenerateThumbnailToFiles (vlc_preparser_t *preparser, input_item_t *item, const struct vlc_thumbnailer_arg *arg, const struct vlc_thumbnailer_output *outputs, size_t output_count, const struct vlc_thumbnailer_to_files_cbs *cbs, void *cbs_userdata)
	This function generates a thumbnail to one or several files.
size_t	vlc_preparser_Cancel (vlc_preparser_t *preparser, vlc_preparser_req *req)
	This function cancels ongoing or queued preparsing/thumbnail generation for a given request handle.
input_item_t *	vlc_preparser_req_GetItem (vlc_preparser_req *req)
	Fetch the input item associated with the request.
void	vlc_preparser_req_Release (vlc_preparser_req *req)
	Release a preparser request handle.
void	vlc_preparser_Delete (vlc_preparser_t *preparser)
	This function destroys the preparser object and thread.
void	vlc_preparser_SetTimeout (vlc_preparser_t *preparser, vlc_tick_t timeout)
	Do not use, libVLC only fonction, will be removed soon.

Detailed Description

VLC Preparser API.