album_art_manager_instance Class Reference

#include <album_art.h>

Inheritance diagram for album_art_manager_instance:

List of all members.

Public Types
typedef album_art_manager_instance	t_interface
typedef service_base	t_interface_parent
Public Member Functions
virtual bool	open (const char *p_file, abort_callback &p_abort)=0
virtual void	close ()=0
	Resets internal data.
virtual album_art_data_ptr	query (const GUID &p_what, abort_callback &p_abort)=0
	Queries album art data for currently open media file. Throws exception_album_art_not_found when the requested album art entry isn't present.
virtual album_art_data_ptr	query_stub_image (abort_callback &p_abort)=0
Static Public Attributes
static const GUID	class_guid = { 0x3c7b403b, 0xff99, 0x4d86, { 0x84, 0x4a, 0xd3, 0xea, 0xbb, 0xd6, 0x1f, 0x66 } }

---

Detailed Description

Primary API for interfacing with foobar2000 core's album art extraction functionality.
Use static_api_ptr_t<album_art_manager>()->instantiate() to obtain a pointer to album_art_manager_instance.
The main difference between using album_art_manager_instance and calling album_art_extractor methods directly is that album_art_manager_instance will fall back to returning pictures found in the folder containing the specified media file in case requested album art entries can't be extracted from the media file itself.

Since:

0.9.5

---

Member Typedef Documentation

typedef album_art_manager_instance album_art_manager_instance::t_interface

Reimplemented from service_base.

typedef service_base album_art_manager_instance::t_interface_parent

---

Member Function Documentation

virtual bool album_art_manager_instance::open	(	const char *	p_file,
		abort_callback &	p_abort
	)			[pure virtual]

Returns:

True when the newly requested file has different album art than the old one, false when album art we're referencing is the same as before.

virtual void album_art_manager_instance::close

(

)

[pure virtual]

Resets internal data.

virtual album_art_data_ptr album_art_manager_instance::query	(	const GUID &	p_what,
		abort_callback &	p_abort
	)			[pure virtual]

Queries album art data for currently open media file. Throws exception_album_art_not_found when the requested album art entry isn't present.

virtual album_art_data_ptr album_art_manager_instance::query_stub_image

(

abort_callback &

p_abort

)

[pure virtual]

Queries for stub image to display when there's no album art to show.
May fail with exception_album_art_not_found as well when we have no stub image configured.

---

Member Data Documentation

const GUID album_art_manager_instance::class_guid = { 0x3c7b403b, 0xff99, 0x4d86, { 0x84, 0x4a, 0xd3, 0xea, 0xbb, 0xd6, 0x1f, 0x66 } } [static]

---

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

• foobar2000/SDK/album_art.h
• foobar2000/SDK/guids.cpp