album_art_extractor Class Reference
#include <album_art.h>
Inheritance diagram for album_art_extractor:
Public Types | |
| typedef album_art_extractor | t_interface_entrypoint |
| typedef album_art_extractor | t_interface |
| typedef service_base | t_interface_parent |
Public Member Functions | |
| virtual bool | is_our_path (const char *p_path, const char *p_extension)=0 |
| virtual album_art_extractor_instance_ptr | open (file_ptr p_filehint, const char *p_path, abort_callback &p_abort)=0 |
Static Public Attributes | |
| static const GUID | class_guid = { 0xe19ca3d3, 0x6267, 0x4271, { 0xb7, 0x89, 0x6a, 0x3f, 0x87, 0xfb, 0x3e, 0xbf } } |
Detailed Description
Entrypoint class for accessing album art extraction functionality. Register your own implementation to allow album art extraction from your media file format.If you want to extract album art from a media file, it's recommended that you use album_art_manager API instead of calling album_art_extractor directly.
- Since:
- 0.9.5
Member Typedef Documentation
Reimplemented from service_base.
Member Function Documentation
| virtual bool album_art_extractor::is_our_path | ( | const char * | p_path, | |
| const char * | p_extension | |||
| ) | [pure virtual] |
Returns whether the specified file is one of formats supported by our album_art_extractor implementation.
- Parameters:
-
p_path Path to file being queried. p_extension Extension of file being queried (also present in p_path parameter) - provided as a separate parameter for performance reasons.
Implemented in album_art_extractor_impl_stdtags.
| virtual album_art_extractor_instance_ptr album_art_extractor::open | ( | file_ptr | p_filehint, | |
| const char * | p_path, | |||
| abort_callback & | p_abort | |||
| ) | [pure virtual] |
Instantiates album_art_extractor_instance providing access to album art stored in a specified media file.
Throws one of I/O exceptions on failure; exception_album_art_not_found when the file has no album art record at all.
- Parameters:
-
p_filehint Optional; specifies a file interface to use for accessing the specified file; can be null - in that case, the implementation will open and close the file internally.
Implemented in album_art_extractor_impl_stdtags.
Member Data Documentation
const GUID album_art_extractor::class_guid = { 0xe19ca3d3, 0x6267, 0x4271, { 0xb7, 0x89, 0x6a, 0x3f, 0x87, 0xfb, 0x3e, 0xbf } } [static] |
The documentation for this class was generated from the following files:
- foobar2000/SDK/album_art.h
- foobar2000/SDK/guids.cpp
