playlist_loader_callback_impl Class Reference

Basic implementation of playlist_loader_callback. More...

#include <playlist_loader.h>

Inheritance diagram for playlist_loader_callback_impl:

List of all members.

Public Member Functions
	playlist_loader_callback_impl (abort_callback &p_abort)
bool	is_aborting () const
abort_callback_event	get_abort_event () const
const metadb_handle_ptr &	get_item (t_size idx) const
const metadb_handle_ptr &	operator[] (t_size idx) const
t_size	get_count () const
const metadb_handle_list &	get_data () const
void	on_progress (const char *path)
	Indicates specified path being processed; provided for updating GUI. Note that optimally GUI should not be updated every time this is called because that could introduce a bottleneck.
void	on_entry (const metadb_handle_ptr &ptr, t_entry_type type, const t_filestats &p_stats, bool p_fresh)
bool	want_info (const metadb_handle_ptr &ptr, t_entry_type type, const t_filestats &p_stats, bool p_fresh)
void	on_entry_info (const metadb_handle_ptr &ptr, t_entry_type type, const t_filestats &p_stats, const file_info &p_info, bool p_fresh)
void	handle_create (metadb_handle_ptr &p_out, const playable_location &p_location)
	Same as metadb::handle_create(); provided here to avoid repeated metadb instantiation bottleneck since calling code will need this function often.
bool	is_path_wanted (const char *path, t_entry_type type)

---

Detailed Description

Basic implementation of playlist_loader_callback.

---

Constructor & Destructor Documentation

playlist_loader_callback_impl::playlist_loader_callback_impl

(

abort_callback &

p_abort

)

[inline]

---

Member Function Documentation

bool playlist_loader_callback_impl::is_aborting

(

)

const [inline]

abort_callback_event playlist_loader_callback_impl::get_abort_event

(

)

const [inline]

const metadb_handle_ptr& playlist_loader_callback_impl::get_item

(

t_size

idx

)

const [inline]

const metadb_handle_ptr& playlist_loader_callback_impl::operator[]

(

t_size

idx

)

const [inline]

t_size playlist_loader_callback_impl::get_count

(

)

const [inline]

const metadb_handle_list& playlist_loader_callback_impl::get_data

(

)

const [inline]

void playlist_loader_callback_impl::on_progress

(

const char *

p_path

)

[inline, virtual]

Indicates specified path being processed; provided for updating GUI. Note that optimally GUI should not be updated every time this is called because that could introduce a bottleneck.

Implements playlist_loader_callback.

void playlist_loader_callback_impl::on_entry	(	const metadb_handle_ptr &	p_item,
		t_entry_type	p_type,
		const t_filestats &	p_stats,
		bool	p_fresh
	)			[inline, virtual]

Receives an item from one of playlist_loader functions.

Parameters:

	p_item	Item location, in form of metadb_handle pointer.
	p_type	Origin of this item - see t_entry_type for more info.
	p_stats	File stats of this item; set to filestats_invalid if not available.
	p_fresh	Fresh flag; indicates whether stats are directly from filesystem (true) or as stored earlier in a playlist file (false).

Implements playlist_loader_callback.

bool playlist_loader_callback_impl::want_info	(	const metadb_handle_ptr &	p_item,
		t_entry_type	p_type,
		const t_filestats &	p_stats,
		bool	p_fresh
	)			[inline, virtual]

Queries whether file_info for specified item is requested. In typical scenario, if want_info() returns false, on_entry() will be called with same parameters; otherwise caller will attempt to read info from the item and call on_entry_info() with same parameters and file_info read from the item.

Parameters:

	p_item	Item location, in form of metadb_handle pointer.
	p_type	Origin of this item - see t_entry_type for more info.
	p_stats	File stats of this item; set to filestats_invalid if not available.
	p_fresh	Fresh flag; indicates whether stats are directly from filesystem (true) or as stored earlier in a playlist file (false).

Implements playlist_loader_callback.

void playlist_loader_callback_impl::on_entry_info	(	const metadb_handle_ptr &	p_item,
		t_entry_type	p_type,
		const t_filestats &	p_stats,
		const file_info &	p_info,
		bool	p_fresh
	)			[inline, virtual]

Receives an item from one of playlist_loader functions; including file_info data. Except for file_info to be typically used as hint for metadb backend, behavior of this method is same as on_entry().

Parameters:

	p_item	Item location, in form of metadb_handle pointer.
	p_type	Origin of this item - see t_entry_type for more info.
	p_stats	File stats of this item; set to filestats_invalid if not available.
	p_info	Information about the item, read from the file directly (if p_fresh is set to true) or from e.g. playlist file (if p_fresh is set to false).
	p_fresh	Fresh flag; indicates whether stats are directly from filesystem (true) or as stored earlier in a playlist file (false).

Implements playlist_loader_callback.

void playlist_loader_callback_impl::handle_create	(	metadb_handle_ptr &	p_out,
		const playable_location &	p_location
	)			[inline, virtual]

Same as metadb::handle_create(); provided here to avoid repeated metadb instantiation bottleneck since calling code will need this function often.

Implements playlist_loader_callback.

bool playlist_loader_callback_impl::is_path_wanted	(	const char *	path,
		t_entry_type	type
	)			[inline, virtual]

Returns whether further on_entry() calls for this file are wanted. Typically always returns true, can be used to optimize cases when directories are searched for files matching specific pattern only so unwanted files aren't parsed unnecessarily.

Parameters:

path

Canonical path to the media file being processed.

Implements playlist_loader_callback_v2.

---

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

• foobar2000/SDK/playlist_loader.h