foobar2000 SDK  2015-08-03
Public Types | Public Member Functions | Data Fields
metadb_ioabstract

#include <metadb.h>

+ Inheritance diagram for metadb_io:

Public Types

enum  t_load_info_state { load_info_success, load_info_aborted, load_info_errors }
 
enum  t_load_info_type { load_info_default, load_info_force, load_info_check_if_changed }
 
enum  t_update_info_state { update_info_success, update_info_aborted, update_info_errors }
 
- Public Types inherited from service_base
typedef service_base t_interface
 

Public Member Functions

 __declspec (deprecated) virtual bool is_busy()=0
 
 __declspec (deprecated) virtual bool is_updating_disabled()=0
 
 __declspec (deprecated) virtual bool is_file_updating_blocked()=0
 
 __declspec (deprecated) virtual void highlight_running_process()=0
 
 __declspec (deprecated) virtual t_load_info_state load_info_multi(metadb_handle_list_cref p_list
 
 __declspec (deprecated) virtual t_update_info_state update_info_multi(metadb_handle_list_cref p_list
 
 __declspec (deprecated) virtual t_update_info_state rewrite_info_multi(metadb_handle_list_cref p_list
 
 __declspec (deprecated) virtual t_update_info_state remove_info_multi(metadb_handle_list_cref p_list
 
 __declspec (deprecated) t_load_info_state load_info(metadb_handle_ptr p_item
 
 __declspec (deprecated) t_update_info_state update_info(metadb_handle_ptr p_item
 
virtual void dispatch_refresh (metadb_handle_list_cref p_list)=0
 
void dispatch_refresh (metadb_handle_ptr const &handle)
 
 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (metadb_io)
 
void hint_async (metadb_handle_ptr p_item, const file_info &p_info, const t_filestats &p_stats, bool p_fresh)
 
virtual void hint_multi (metadb_handle_list_cref p_list, const pfc::list_base_const_t< const file_info * > &p_infos, const pfc::list_base_const_t< t_filestats > &p_stats, const bit_array &p_fresh_mask)=0
 
virtual void hint_multi_async (metadb_handle_list_cref p_list, const pfc::list_base_const_t< const file_info * > &p_infos, const pfc::list_base_const_t< t_filestats > &p_stats, const bit_array &p_fresh_mask)=0
 
virtual void hint_reader (service_ptr_t< class input_info_reader > p_reader, const char *p_path, abort_callback &p_abort)=0
 
virtual void path_to_handles_simple (const char *p_path, metadb_handle_list_ref p_out)=0
 
- Public Member Functions inherited from service_base
template<typename outPtr_t >
bool cast (outPtr_t &outPtr)
 
virtual int service_add_ref ()=0 throw ()
 
virtual bool service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
 
template<class T >
bool service_query_t (service_ptr_t< T > &p_out)
 
virtual int service_release ()=0 throw ()
 

Data Fields

file_infop_info
 
const pfc::list_base_const_t< file_info * > & p_new_info
 
t_load_info_type HWND p_parent_window
 
const pfc::list_base_const_t< file_info * > HWND p_parent_window
 
HWND p_parent_window
 
file_info HWND p_parent_window
 
t_load_info_type HWND bool p_show_errors = 0
 
const pfc::list_base_const_t< file_info * > HWND bool p_show_errors = 0
 
HWND bool p_show_errors = 0
 
file_info HWND bool p_show_errors
 
t_load_info_type p_type
 

Additional Inherited Members

- Protected Member Functions inherited from service_base
 service_base ()
 
 ~service_base ()
 

Detailed Description

API for tag read/write operations. Legal to call from main thread only, except for hint_multi_async() / hint_async() / hint_reader().
Implemented only by core, do not reimplement.
Use static_api_ptr_t template to access metadb_io methods.
WARNING: Methods that perform file access (tag reads/writes) run a modal message loop. They SHOULD NOT be called from global callbacks and such.

Definition at line 5 of file metadb.h.

Member Enumeration Documentation

Enumerator
load_info_success 
load_info_aborted 
load_info_errors 

Definition at line 20 of file metadb.h.

Enumerator
load_info_default 
load_info_force 
load_info_check_if_changed 

Definition at line 8 of file metadb.h.

Enumerator
update_info_success 
update_info_aborted 
update_info_errors 

Definition at line 14 of file metadb.h.

Member Function Documentation

metadb_io::__declspec ( deprecated  )
pure virtual

No longer used - returns false always.

metadb_io::__declspec ( deprecated  )
pure virtual

No longer used - returns false always.

metadb_io::__declspec ( deprecated  )
pure virtual

No longer used - returns false always.

metadb_io::__declspec ( deprecated  )
pure virtual

No longer used.

metadb_io::__declspec ( deprecated  )

Loads tags from multiple items. Use the async version in metadb_io_v2 instead if possible.

metadb_io::__declspec ( deprecated  )

Updates tags on multiple items. Use the async version in metadb_io_v2 instead if possible.

metadb_io::__declspec ( deprecated  )

Rewrites tags on multiple items. Use the async version in metadb_io_v2 instead if possible.

metadb_io::__declspec ( deprecated  )

Removes tags from multiple items. Use the async version in metadb_io_v2 instead if possible.

metadb_io::__declspec ( deprecated  )
metadb_io::__declspec ( deprecated  )
virtual void metadb_io::dispatch_refresh ( metadb_handle_list_cref  p_list)
pure virtual

Dispatches metadb_io_callback calls with specified items. To be used with metadb_display_field_provider when your component needs specified items refreshed.

void metadb_io::dispatch_refresh ( metadb_handle_ptr const &  handle)
inline

Definition at line 55 of file metadb.h.

virtual void dispatch_refresh(metadb_handle_list_cref p_list)=0
Dispatches metadb_io_callback calls with specified items. To be used with metadb_display_field_provid...
metadb_io::FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT ( metadb_io  )
void metadb_io::hint_async ( metadb_handle_ptr  p_item,
const file_info p_info,
const t_filestats &  p_stats,
bool  p_fresh 
)

Definition at line 32 of file metadb.cpp.

33 {
34  const file_info * blargh = &p_info;
36 }
Main interface class for information about some playable object.
Definition: file_info.h:73
file_info & p_info
Definition: metadb.h:60
virtual void hint_multi_async(metadb_handle_list_cref p_list, const pfc::list_base_const_t< const file_info * > &p_infos, const pfc::list_base_const_t< t_filestats > &p_stats, const bit_array &p_fresh_mask)=0
virtual void metadb_io::hint_multi ( metadb_handle_list_cref  p_list,
const pfc::list_base_const_t< const file_info * > &  p_infos,
const pfc::list_base_const_t< t_filestats > &  p_stats,
const bit_array p_fresh_mask 
)
pure virtual
virtual void metadb_io::hint_multi_async ( metadb_handle_list_cref  p_list,
const pfc::list_base_const_t< const file_info * > &  p_infos,
const pfc::list_base_const_t< t_filestats > &  p_stats,
const bit_array p_fresh_mask 
)
pure virtual
virtual void metadb_io::hint_reader ( service_ptr_t< class input_info_reader p_reader,
const char *  p_path,
abort_callback p_abort 
)
pure virtual
virtual void metadb_io::path_to_handles_simple ( const char *  p_path,
metadb_handle_list_ref  p_out 
)
pure virtual

For internal use only.

Field Documentation

file_info& metadb_io::p_info

Definition at line 60 of file metadb.h.

const pfc::list_base_const_t<file_info*>& metadb_io::p_new_info

Definition at line 37 of file metadb.h.

t_load_info_type HWND metadb_io::p_parent_window

Definition at line 35 of file metadb.h.

const pfc::list_base_const_t<file_info*> HWND metadb_io::p_parent_window

Definition at line 37 of file metadb.h.

HWND metadb_io::p_parent_window

Definition at line 39 of file metadb.h.

file_info HWND metadb_io::p_parent_window

Definition at line 60 of file metadb.h.

t_load_info_type HWND bool metadb_io::p_show_errors = 0

Definition at line 35 of file metadb.h.

const pfc::list_base_const_t<file_info*> HWND bool metadb_io::p_show_errors = 0

Definition at line 37 of file metadb.h.

HWND bool metadb_io::p_show_errors = 0

Definition at line 39 of file metadb.h.

file_info HWND bool metadb_io::p_show_errors

Definition at line 60 of file metadb.h.

t_load_info_type metadb_io::p_type

Definition at line 35 of file metadb.h.


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