foobar2000 SDK  2015-08-03
Public Member Functions
autoplaylist_managerabstract

#include <autoplaylist.h>

+ Inheritance diagram for autoplaylist_manager:

Public Member Functions

virtual void add_client (autoplaylist_client_ptr p_client, t_size p_playlist, t_uint32 p_flags)=0
 
virtual void add_client_simple (const char *p_query, const char *p_sort, 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
 
virtual void remove_client (t_size p_playlist)=0
 
- Public Member Functions inherited from service_base
template<typename outPtr_t >
bool cast (outPtr_t &outPtr)
 
virtual int service_add_ref ()=0 throw ()
 
virtual bool service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
 
template<class T >
bool service_query_t (service_ptr_t< T > &p_out)
 
virtual int service_release ()=0 throw ()
 

Additional Inherited Members

- Public Types inherited from service_base
typedef service_base t_interface
 
- Protected Member Functions inherited from service_base
 service_base ()
 
 ~service_base ()
 

Detailed Description

Primary class for managing autoplaylists. Implemented by core, do not reimplement; instantiate using static_api_ptr_t<autoplaylist_manager>.

Definition at line 73 of file autoplaylist.h.

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_flagsSee autoplaylist_flag_* constants.
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_flagsSee 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

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