metadb_hint_list Class Reference

Advanced interface for passing infos read from files to metadb backend. Use metadb_io_v2::create_hint_list() to instantiate. More...

#include <metadb.h>

Inheritance diagram for metadb_hint_list:

service_base

List of all members.

Public Types

typedef metadb_hint_list t_interface
typedef service_base t_interface_parent

Public Member Functions

virtual void add_hint (metadb_handle_ptr const &p_location, const file_info &p_info, const t_filestats &p_stats, bool p_freshflag)=0
virtual void add_hint_reader (const char *p_path, service_ptr_t< input_info_reader > const &p_reader, abort_callback &p_abort)=0
 Reads info from specified info reader instance and adds hints. May throw an exception in case info read has failed.
virtual void on_done ()=0
 Call this when you're done working with this metadb_hint_list instance, to apply hints and dispatch callbacks. If you don't call this, all added hints will be ignored.

Static Public Attributes

static const GUID class_guid = { 0x719dc072, 0x8d4d, 0x4aa6, { 0xa6, 0xf3, 0x90, 0x73, 0x7, 0xe5, 0xbc, 0xee } }


Detailed Description

Advanced interface for passing infos read from files to metadb backend. Use metadb_io_v2::create_hint_list() to instantiate.

Member Typedef Documentation

Reimplemented from service_base.


Member Function Documentation

virtual void metadb_hint_list::add_hint ( metadb_handle_ptr const &  p_location,
const file_info p_info,
const t_filestats &  p_stats,
bool  p_freshflag 
) [pure virtual]

Adds a hint to the list.

Parameters:
p_location Location of the item the hint applies to.
p_info file_info object describing the item.
p_stats Information about the file containing item the hint applies to.
p_freshflag Set to true if the info has been directly read from the file, false if it comes from another source such as a playlist file.

virtual void metadb_hint_list::add_hint_reader ( const char *  p_path,
service_ptr_t< input_info_reader > const &  p_reader,
abort_callback &  p_abort 
) [pure virtual]

Reads info from specified info reader instance and adds hints. May throw an exception in case info read has failed.

virtual void metadb_hint_list::on_done (  )  [pure virtual]

Call this when you're done working with this metadb_hint_list instance, to apply hints and dispatch callbacks. If you don't call this, all added hints will be ignored.


Member Data Documentation

const GUID metadb_hint_list::class_guid = { 0x719dc072, 0x8d4d, 0x4aa6, { 0xa6, 0xf3, 0x90, 0x73, 0x7, 0xe5, 0xbc, 0xee } } [static]


The documentation for this class was generated from the following files:

Generated on Thu Aug 28 21:15:54 2008 for foobar2000 SDK by  doxygen 1.5.5