preparser message api

Collaboration diagram for preparser message api:

Data Structures
struct	vlc_preparser_msg_req
	Preparser request. More...
struct	vlc_preparser_msg_res
	Preparser Response. More...
struct	vlc_preparser_msg
	Preparser message. More...

Enumerations
enum	vlc_preparser_msg_req_type { VLC_PREPARSER_MSG_REQ_TYPE_PARSE , VLC_PREPARSER_MSG_REQ_TYPE_THUMBNAIL , VLC_PREPARSER_MSG_REQ_TYPE_THUMBNAIL_TO_FILES }
	Request types. More...

Functions
void	vlc_preparser_msg_Init (struct vlc_preparser_msg *msg, int msg_type, enum vlc_preparser_msg_req_type req_type)
	Initialize a preparser message.
void	vlc_preparser_msg_Clean (struct vlc_preparser_msg *msg)
	Clean all memory used by a message.

Detailed Description

Enumeration Type Documentation

vlc_preparser_msg_req_type

enum vlc_preparser_msg_req_type

Request types.

Enumerator
VLC_PREPARSER_MSG_REQ_TYPE_PARSE	Type of the request emitted by a vlc_preparser_Push call.
VLC_PREPARSER_MSG_REQ_TYPE_THUMBNAIL	Type of the request emitted by a vlc_preparser_GenerateThumbnail call.
VLC_PREPARSER_MSG_REQ_TYPE_THUMBNAIL_TO_FILES	Type of the request emitted by a vlc_preparser_GenerateThumbnailToFiles call.

Function Documentation

vlc_preparser_msg_Clean()

void vlc_preparser_msg_Clean

(

struct vlc_preparser_msg *

msg

)

Clean all memory used by a message.

@info This function don't free the msg pointer.

Parameters

msg	message to release.

References vlc_preparser_msg_res::attachments, input_item_node_Delete(), input_item_Release(), vlc_preparser_msg_res::item, vlc_preparser_msg_req::outputs, vlc_preparser_msg_req::outputs_path, vlc_preparser_msg_res::pic, picture_Release(), vlc_preparser_msg::req, vlc_preparser_msg::res, vlc_preparser_msg_res::result, vlc_preparser_msg_res::subtree, vlc_preparser_msg::type, vlc_preparser_msg_req::uri, vlc_input_attachment_Release(), vlc_vector_clear, and vlc_vector_foreach.

Referenced by preparser_task_Delete(), preparser_task_New(), and preparser_task_req_Release().

vlc_preparser_msg_Init()

void vlc_preparser_msg_Init	(	struct vlc_preparser_msg *	msg,
		int	msg_type,
		enum vlc_preparser_msg_req_type	req_type
	)

Initialize a preparser message.

@info All data specific to each request/response have to be initialized by hand.

Parameters

msg	message to initialize.
msg_type	message type (request or response).
req_type	request/response type (see enum vlc_preparser_req_type for more information).

References vlc_preparser_msg_req::arg, vlc_preparser_msg_res::attachments, vlc_thumbnailer_arg::hw_dec, msg_type, vlc_preparser_msg_req::options, vlc_preparser_msg_req::outputs, vlc_preparser_msg_req::outputs_path, vlc_preparser_msg_res::pic, vlc_preparser_msg::req, vlc_preparser_msg::req_type, vlc_preparser_msg::res, vlc_preparser_msg_res::result, vlc_thumbnailer_arg::seek, vlc_thumbnailer_arg::seek::speed, vlc_preparser_msg_res::status, vlc_preparser_msg_res::subtree, vlc_thumbnailer_arg::seek::type, vlc_preparser_msg_req::type, vlc_preparser_msg_res::type, vlc_preparser_msg::type, vlc_preparser_msg_req::uri, VLC_PREPARSER_MSG_REQ_TYPE_PARSE, VLC_PREPARSER_MSG_REQ_TYPE_THUMBNAIL, VLC_PREPARSER_MSG_REQ_TYPE_THUMBNAIL_TO_FILES, and vlc_vector_init.

Referenced by preparser_task_ExecCallback(), and preparser_task_New().