album_art_editor Class Reference
#include <album_art.h>
Inheritance diagram for album_art_editor:
Public Types | |
| typedef album_art_editor | t_interface_entrypoint |
| typedef album_art_editor | 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_editor_instance_ptr | open (file_ptr p_filehint, const char *p_path, abort_callback &p_abort)=0 |
Static Public Member Functions | |
| static bool | g_get_interface (service_ptr_t< album_art_editor > &out, const char *path) |
| static bool | g_is_supported_path (const char *path) |
| Helper; returns whether one of registered album_art_editor implementations is capable of opening the specified file. | |
Static Public Attributes | |
| static const GUID | class_guid = { 0x36b34487, 0xd7b9, 0x4533, { 0xa7, 0x3f, 0x39, 0x6e, 0x2d, 0x9f, 0x41, 0x5e } } |
Detailed Description
Entrypoint class for accessing album art editing functionality. Register your own implementation to allow album art editing on your media file format.- Since:
- 0.9.5
Member Typedef Documentation
Reimplemented from service_base.
Member Function Documentation
| virtual bool album_art_editor::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_editor 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.
| virtual album_art_editor_instance_ptr album_art_editor::open | ( | file_ptr | p_filehint, | |
| const char * | p_path, | |||
| abort_callback & | p_abort | |||
| ) | [pure virtual] |
Instantiates album_art_editor_instance providing access to album art stored in a specified media file.
- 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.
| static bool album_art_editor::g_get_interface | ( | service_ptr_t< album_art_editor > & | out, | |
| const char * | path | |||
| ) | [static] |
Helper; attempts to retrieve an album_art_editor service pointer that supports the specified file.
- Returns:
- True on success, false on failure (no registered album_art_editor supports this file type).
| static bool album_art_editor::g_is_supported_path | ( | const char * | path | ) | [static] |
Helper; returns whether one of registered album_art_editor implementations is capable of opening the specified file.
Member Data Documentation
const GUID album_art_editor::class_guid = { 0x36b34487, 0xd7b9, 0x4533, { 0xa7, 0x3f, 0x39, 0x6e, 0x2d, 0x9f, 0x41, 0x5e } } [static] |
The documentation for this class was generated from the following files:
- foobar2000/SDK/album_art.h
- foobar2000/SDK/guids.cpp
