autoplaylist_manager Class Reference
[Autoplaylists]
#include <autoplaylist.h>
Inheritance diagram for autoplaylist_manager:
Public Types | |
| typedef autoplaylist_manager | t_interface_entrypoint |
| typedef autoplaylist_manager | t_interface |
| typedef service_base | t_interface_parent |
Public Member Functions | |
| virtual void | add_client (autoplaylist_client_ptr p_client, t_size p_playlist, t_uint32 p_flags)=0 |
| virtual bool | is_client_present (t_size p_playlist)=0 |
| virtual autoplaylist_client_ptr | query_client (t_size p_playlist)=0 |
| Throws exception_autoplaylist or one of its subclasses on failure (eg. not an autoplaylist). | |
| virtual void | remove_client (t_size p_playlist)=0 |
| virtual void | add_client_simple (const char *p_query, const char *p_sort, t_size p_playlist, t_uint32 p_flags)=0 |
Static Public Attributes | |
| static const GUID | class_guid = { 0x1571d0d, 0xc1e1, 0x44bf, { 0xb5, 0x29, 0x7a, 0xe, 0x4e, 0x89, 0x15, 0xbc } } |
Detailed Description
Primary class for managing autoplaylists. Implemented by core, do not reimplement; instantiate using static_api_ptr_t<autoplaylist_manager>.
- Since:
- 0.9.5
Member Typedef Documentation
Reimplemented from service_base.
Member Function Documentation
| virtual void autoplaylist_manager::add_client | ( | autoplaylist_client_ptr | p_client, | |
| t_size | p_playlist, | |||
| t_uint32 | p_flags | |||
| ) | [pure virtual] |
Throws exception_autoplaylist or one of its subclasses on failure.
- Parameters:
-
p_flags See autoplaylist_flag_* constants.
| virtual bool autoplaylist_manager::is_client_present | ( | t_size | p_playlist | ) | [pure virtual] |
| virtual autoplaylist_client_ptr autoplaylist_manager::query_client | ( | t_size | p_playlist | ) | [pure virtual] |
Throws exception_autoplaylist or one of its subclasses on failure (eg. not an autoplaylist).
| virtual void autoplaylist_manager::remove_client | ( | t_size | p_playlist | ) | [pure virtual] |
| virtual void autoplaylist_manager::add_client_simple | ( | const char * | p_query, | |
| const char * | p_sort, | |||
| t_size | p_playlist, | |||
| t_uint32 | p_flags | |||
| ) | [pure virtual] |
Helper; sets up an autoplaylist using standard autoplaylist_client implementation based on simple query/sort strings. When using this, you don't need to maintain own autoplaylist_client/autoplaylist_client_factory implementations, and autoplaylists that you create will not be lost when your DLL is removed, as opposed to using add_client() directly. Throws exception_autoplaylist or one of its subclasses on failure.
- Parameters:
-
p_flags See autoplaylist_flag_* constants.
Member Data Documentation
const GUID autoplaylist_manager::class_guid = { 0x1571d0d, 0xc1e1, 0x44bf, { 0xb5, 0x29, 0x7a, 0xe, 0x4e, 0x89, 0x15, 0xbc } } [static] |
The documentation for this class was generated from the following files:
- foobar2000/SDK/autoplaylist.h
- foobar2000/SDK/guids.cpp
