autoplaylist_client Class Reference
[Autoplaylists]
#include <autoplaylist.h>
Inheritance diagram for autoplaylist_client:
Public Types | |
| typedef autoplaylist_client | t_interface |
| typedef service_base | t_interface_parent |
Public Member Functions | |
| virtual GUID | get_guid ()=0 |
| virtual void | filter (metadb_handle_list_cref data, bool *out)=0 |
| Called only inside a metadb lock for performance reasons. | |
| virtual bool | sort (metadb_handle_list_cref p_items, t_size *p_orderbuffer)=0 |
| Return true when you have filled p_orderbuffer with a permutation to apply to p_items, false when you don't support sorting (core's own sort scheme will be applied). | |
| virtual void | get_configuration (stream_writer *p_stream, abort_callback &p_abort)=0 |
| Retrieves your configuration data to be used later when re-instantiating your autoplaylist_client after a restart. | |
| virtual void | show_ui (t_size p_source_playlist)=0 |
| template<typename t_array> | |
| void | get_configuration (t_array &p_out) |
| Helper. | |
Static Public Attributes | |
| static const GUID | class_guid = { 0x7c90bda0, 0xf93d, 0x4a73, { 0x98, 0x51, 0xa0, 0x33, 0x6, 0x7, 0xcb, 0x28 } } |
Detailed Description
Main class controlling autoplaylist behaviors. Implemented by autoplaylist client in scenarios where simple query/sort strings are not enough (core provides a standard implementation for simple queries).
- Since:
- 0.9.5
Member Typedef Documentation
Reimplemented in autoplaylist_client_v2.
Member Function Documentation
| virtual GUID autoplaylist_client::get_guid | ( | ) | [pure virtual] |
| virtual void autoplaylist_client::filter | ( | metadb_handle_list_cref | data, | |
| bool * | out | |||
| ) | [pure virtual] |
Called only inside a metadb lock for performance reasons.
| virtual bool autoplaylist_client::sort | ( | metadb_handle_list_cref | p_items, | |
| t_size * | p_orderbuffer | |||
| ) | [pure virtual] |
Return true when you have filled p_orderbuffer with a permutation to apply to p_items, false when you don't support sorting (core's own sort scheme will be applied).
| virtual void autoplaylist_client::get_configuration | ( | stream_writer * | p_stream, | |
| abort_callback & | p_abort | |||
| ) | [pure virtual] |
Retrieves your configuration data to be used later when re-instantiating your autoplaylist_client after a restart.
| virtual void autoplaylist_client::show_ui | ( | t_size | p_source_playlist | ) | [pure virtual] |
template<typename t_array>
| void autoplaylist_client::get_configuration | ( | t_array & | p_out | ) | [inline] |
Helper.
Member Data Documentation
const GUID autoplaylist_client::class_guid = { 0x7c90bda0, 0xf93d, 0x4a73, { 0x98, 0x51, 0xa0, 0x33, 0x6, 0x7, 0xcb, 0x28 } } [static] |
Reimplemented in autoplaylist_client_v2.
The documentation for this class was generated from the following files:
- foobar2000/SDK/autoplaylist.h
- foobar2000/SDK/guids.cpp
