X-Git-Url: https://vcs.maemo.org/git/?a=blobdiff_plain;f=www%2Fapi%2Flightmediascanner_8h.html;h=f7abd369f28913cf23dca32a8d73719b4014426e;hb=7436eda8879f146fa50e342a134db80a9e6db58d;hp=b2a382ea5befd04cf3f319c5e1cc7e46a14dbb66;hpb=ac03e6ebd87457463f0d6facf3a810c24f3c8226;p=lms diff --git a/www/api/lightmediascanner_8h.html b/www/api/lightmediascanner_8h.html index b2a382e..f7abd36 100644 --- a/www/api/lightmediascanner_8h.html +++ b/www/api/lightmediascanner_8h.html @@ -4,26 +4,27 @@ - -
- -
-
- -
+ + +

src/lib/lightmediascanner.h File Reference

-This graph shows which files directly or indirectly include this file:

+
+This graph shows which files directly or indirectly include this file:
+
+

- + +

Go to the source code of this file. @@ -48,9 +49,25 @@ This graph shows which files directly or indirectly include this file:

- + + + - + + + + + + @@ -59,10 +76,16 @@ This graph shows which files directly or indirectly include this file:

- + + + - + + + + + @@ -74,18 +97,22 @@ char *  + + - + - + - + - +
#define GNUC_NON_NULL(...)

Typedefs

typedef lms lms_t
typedef struct lms lms_t
typedef struct lms_plugin lms_plugin_t
typedef lms_plugin lms_plugin_t
typedef void(* lms_free_callback_t )(void *data)
typedef void(* lms_progress_callback_t )(lms_t *lms, const char *path, int path_len, lms_progress_status_t status, void *data)

Enumerations

enum  lms_progress_status_t {
+  LMS_PROGRESS_STATUS_UP_TO_DATE, +LMS_PROGRESS_STATUS_PROCESSED, +LMS_PROGRESS_STATUS_DELETED, +LMS_PROGRESS_STATUS_KILLED, +
+  LMS_PROGRESS_STATUS_ERROR_PARSE, +LMS_PROGRESS_STATUS_ERROR_COMM +
+ }

Functions

API lms_t * lms_new (const char *db_path) GNUC_MALLOC GNUC_WARN_UNUSED_RESULT
API int lms_process (lms_t *lms, const char *top_path) GNUC_NON_NULL(1
API int API int lms_check (lms_t *lms, const char *top_path) GNUC_NON_NULL(1
API int API int lms_process_single_process (lms_t *lms, const char *top_path) GNUC_NON_NULL(1
API int API int API int lms_check (lms_t *lms, const char *top_path) GNUC_NON_NULL(1
API int API int API const
-char * 		lms_get_db_path (const lms_t *lms) GNUC_NON_NULL(1)
API int API int API int API int lms_check_single_process (lms_t *lms, const char *top_path) GNUC_NON_NULL(1
API int API int API int API
+int API void 		lms_stop_processing (lms_t *lms) GNUC_NON_NULL(1)
API const char * lms_get_db_path (const lms_t *lms) GNUC_NON_NULL(1)
API int lms_is_processing (const lms_t *lms) GNUC_PURE GNUC_NON_NULL(1)
API void lms_set_commit_interval (lms_t *lms, unsigned int transactions) GNUC_NON_NULL(1)
API void lms_set_progress_callback (lms_t *lms, lms_progress_callback_t cb, const void *data, lms_free_callback_t free_data) GNUC_NON_NULL(1)
API lms_plugin_t * lms_parser_add (lms_t *lms, const char *so_path) GNUC_NON_NULL(1
API lms_plugin_t *API lms_plugin_t * lms_parser_find_and_add (lms_t *lms, const char *name) GNUC_NON_NULL(1
API lms_plugin_t *API
+lms_plugin_t * 		lms_parser_find_and_add (lms_t *lms, const char *name) GNUC_NON_NULL(1
API lms_plugin_t *API lms_plugin_t
-*API int 		lms_parser_del (lms_t *lms, lms_plugin_t *handle) GNUC_NON_NULL(1
API lms_plugin_t *API
+lms_plugin_t *API int 		lms_parser_del (lms_t *lms, lms_plugin_t *handle) GNUC_NON_NULL(1
API lms_plugin_t *API lms_plugin_t
-*API int API int 		lms_charset_add (lms_t *lms, const char *charset) GNUC_NON_NULL(1
API lms_plugin_t *API
+lms_plugin_t *API int API int 		lms_charset_add (lms_t *lms, const char *charset) GNUC_NON_NULL(1
API lms_plugin_t *API lms_plugin_t
-*API int API int API int 		lms_charset_del (lms_t *lms, const char *charset) GNUC_NON_NULL(1
API lms_plugin_t *API
+lms_plugin_t *API int API int
+API int 		lms_charset_del (lms_t *lms, const char *charset) GNUC_NON_NULL(1

Define Documentation

@@ -102,8 +129,8 @@ char * 108 of file lightmediascanner.h. +

Definition at line 111 of file lightmediascanner.h.

+

@@ -119,8 +146,8 @@ Definition at line

-

-Definition at line 142 of file lightmediascanner.h. +

Definition at line 145 of file lightmediascanner.h.

+

@@ -136,8 +163,8 @@ Definition at line

-

-Definition at line 146 of file lightmediascanner.h. +

Definition at line 149 of file lightmediascanner.h.

+

@@ -153,8 +180,8 @@ Definition at line

-

-Definition at line 145 of file lightmediascanner.h. +

Definition at line 148 of file lightmediascanner.h.

+

@@ -167,7 +194,7 @@ Definition at line ...   )  - + @@ -175,8 +202,8 @@ Definition at line

-

-Definition at line 149 of file lightmediascanner.h. +

Definition at line 152 of file lightmediascanner.h.

+

@@ -192,8 +219,8 @@ Definition at line

-

-Definition at line 143 of file lightmediascanner.h. +

Definition at line 146 of file lightmediascanner.h.

+

@@ -209,8 +236,8 @@ Definition at line

-

-Definition at line 144 of file lightmediascanner.h. +

Definition at line 147 of file lightmediascanner.h.

+

@@ -226,8 +253,8 @@ Definition at line

-

-Definition at line 147 of file lightmediascanner.h. +

Definition at line 150 of file lightmediascanner.h.

+

@@ -243,11 +270,28 @@ Definition at line

-

-Definition at line 148 of file lightmediascanner.h. +

Definition at line 151 of file lightmediascanner.h.

+

Typedef Documentation

+ +
+
+ + + + +
typedef void(* lms_free_callback_t)(void *data)
+
+
+ +

+ +

Definition at line 176 of file lightmediascanner.h.

+ +
+

@@ -261,8 +305,25 @@ Definition at line

+

Definition at line 165 of file lightmediascanner.h.

+ +
+

+ +

+
+ + + + +
typedef void(* lms_progress_callback_t)(lms_t *lms, const char *path, int path_len, lms_progress_status_t status, void *data)
+
+
+

-Definition at line 162 of file lightmediascanner.h. + +

Definition at line 177 of file lightmediascanner.h.

+

@@ -278,8 +339,42 @@ Definition at line

+

Definition at line 164 of file lightmediascanner.h.

+ + +

+

Enumeration Type Documentation

+ +
+
+ + + + +
enum lms_progress_status_t
+
+
+

-Definition at line 161 of file lightmediascanner.h. +

Enumerator:
+ + + + + + + +
LMS_PROGRESS_STATUS_UP_TO_DATE  +
LMS_PROGRESS_STATUS_PROCESSED  +
LMS_PROGRESS_STATUS_DELETED  +
LMS_PROGRESS_STATUS_KILLED  +
LMS_PROGRESS_STATUS_ERROR_PARSE  +
LMS_PROGRESS_STATUS_ERROR_COMM  +
+
+ +

Definition at line 167 of file lightmediascanner.h.

+

Function Documentation

@@ -302,7 +397,7 @@ Definition at line ) - + @@ -331,7 +426,7 @@ Definition at line ) - + @@ -341,12 +436,12 @@ Definition at line

- +

- + @@ -360,7 +455,36 @@ Definition at line - + + +
API int API int lms_check API int API int API int lms_check ( lms_t *  lms,
)
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + +
API int API int API int API int lms_check_single_process (lms_t *  lms,
const char *  top_path 
)
@@ -389,7 +513,7 @@ Definition at line ) - +
@@ -418,7 +542,7 @@ Definition at line ) - + @@ -447,7 +571,7 @@ Definition at line ) - + @@ -476,18 +600,126 @@ Definition at line ) - + + + + +
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
API int API int lms_process_single_process (lms_t *  lms,
const char *  top_path 
)
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
API void lms_set_progress_callback (lms_t *  lms,
lms_progress_callback_t  cb,
const void *  data,
lms_free_callback_t  free_data 
)

+Set callback to be used to report progress (check and process).

+

Parameters:
+ + + + + +
lms previously allocated Light Media Scanner instance.
cb function to call when files are processed or NULL to unset.
data data to give to cb when it's called, may be NULL.
free_data function to call to free data when lms is freed or new progress data is set.
+
+ +

Definition at line 193 of file lightmediascanner.c.

+ +

References lms::cb, lms::data, lms::free_data, and lms::progress.

+ +
+

+ +

+
+ + + + + + + + + +
API int API int API int API int API void lms_stop_processing (lms_t *  lms  ) 
+
+
+ +

+ +

Definition at line 1079 of file lightmediascanner_process.c.

+ +

References lms::is_processing, and lms::stop_processing.

-

Generated on Thu Dec 13 02:04:03 2007 for Light Media Scanner by  + +
Generated on Sun Oct 5 12:24:54 2008 for Light Media Scanner by  -doxygen 1.5.2
+doxygen 1.5.6