rhythmdb_import_job_new ()

RhythmDBImportJob *
rhythmdb_import_job_new (RhythmDB *db,
                         RhythmDBEntryType *entry_type,
                         RhythmDBEntryType *ignore_type,
                         RhythmDBEntryType *error_type);

Creates a new import job with the specified entry types. Before starting the job, the caller must add one or more paths to import.

rhythmdb_import_job_add_uri ()

void
rhythmdb_import_job_add_uri (RhythmDBImportJob *job,
                             const char *uri);

Adds a URI to import. All files under the specified URI will be imported.

rhythmdb_import_job_start ()

void
rhythmdb_import_job_start (RhythmDBImportJob *job);

Starts the import job. After this method has been called, no more URIs may be added to the import job. May only be called once for a given import job.

rhythmdb_import_job_cancel ()

void
rhythmdb_import_job_cancel (RhythmDBImportJob *job);

Cancels the import job. The job will cease as soon as possible. More directories may be scanned and more files may be imported before the job actually ceases.

rhythmdb_import_job_complete ()

gboolean
rhythmdb_import_job_complete (RhythmDBImportJob *job);

Returns whether the import job is complete.

rhythmdb_import_job_scan_complete ()

gboolean
rhythmdb_import_job_scan_complete (RhythmDBImportJob *job);

Returns whether the directory scan phase of the import job is complete.

rhythmdb_import_job_get_total ()

int
rhythmdb_import_job_get_total (RhythmDBImportJob *job);

Returns the total number of files that will be processed by this import job. This increases as the import directories are scanned.

rhythmdb_import_job_get_imported ()

int
rhythmdb_import_job_get_imported (RhythmDBImportJob *job);

Returns the number of files successfully imported by the import job so far.

rhythmdb_import_job_get_processed ()

int
rhythmdb_import_job_get_processed (RhythmDBImportJob *job);

Returns the number of files processed by the import job so far.

struct RhythmDBImportJob

struct RhythmDBImportJob;

struct RhythmDBImportJobClass

struct RhythmDBImportJobClass {
	GObjectClass parent_class;

	/* signals */
	void (*entry_added) (RhythmDBImportJob *job, RhythmDBEntry *entry);
	void (*status_changed) (RhythmDBImportJob *job, int total, int imported);
	void (*scan_complete) (RhythmDBImportJob *job, int total);
	void (*complete) (RhythmDBImportJob *job, int total);
};

The “db” property

  “db”                       RhythmDB *

RhythmDB object.

Flags: Read / Write / Construct Only

The “entry-type” property

  “entry-type”               RhythmDBEntryType *

Entry type to use for entries added by this job.

Flags: Read / Write / Construct Only

The “error-type” property

  “error-type”               RhythmDBEntryType *

Entry type to use for import error entries added by this job.

Flags: Read / Write / Construct Only

The “ignore-type” property

  “ignore-type”              RhythmDBEntryType *

Entry type to use for ignored entries added by this job.

Flags: Read / Write / Construct Only

The “complete” signal

void
user_function (RhythmDBImportJob *job,
               gint               total,
               gpointer           user_data)

Emitted when the whole import job is complete.

Flags: Run Last

The “entry-added” signal

void
user_function (RhythmDBImportJob *job,
               RhythmDBEntry     *entry,
               gpointer           user_data)

Emitted when an entry has been added to the database by the import job.

Flags: Run Last

The “scan-complete” signal

void
user_function (RhythmDBImportJob *job,
               gint               total,
               gpointer           user_data)

Emitted when the directory scan is complete. Once the scan is complete, the total number of files to be processed will not change.

Flags: Run Last

The “status-changed” signal

void
user_function (RhythmDBImportJob *job,
               gint               total,
               gint               imported,
               gpointer           user_data)

Emitted when the status of the import job has changed.

Flags: Run Last