foobar2000 SDK  2015-01-14
Public Member Functions | Private Member Functions
autoplaylist_client_v2abstract

#include <autoplaylist.h>

+ Inheritance diagram for autoplaylist_client_v2:

Public Member Functions

virtual void get_display_name (pfc::string_base &out)=0
 
virtual void set_full_refresh_notify (completion_notify::ptr notify)=0
 
virtual bool show_ui_available ()=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 ()
 

Private Member Functions

 FB2K_MAKE_SERVICE_INTERFACE (autoplaylist_client_v2, autoplaylist_client)
 

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

Since
0.9.5.3

Definition at line 39 of file autoplaylist.h.

Member Function Documentation

autoplaylist_client_v2::FB2K_MAKE_SERVICE_INTERFACE ( autoplaylist_client_v2  ,
autoplaylist_client   
)
private
virtual void autoplaylist_client_v2::get_display_name ( pfc::string_base out)
pure virtual

Returns a human-readable autoplaylist implementer's label to display in playlist's context menu / description / etc.

virtual void autoplaylist_client_v2::set_full_refresh_notify ( completion_notify::ptr  notify)
pure virtual

Sets a completion_notify object that the autoplaylist_client implementation should call when its filtering behaviors have changed so the whole playlist needs to be rebuilt.
completion_notify::on_completion() status parameter meaning:
0.9.5.3 : ignored.
0.9.5.4 and newer: set to 1 to indicate that your configuration has changed as well (for an example as a result of user edits) to get a get_configuration() call as well as cause the playlist to be rebuilt; set to zero otherwise - when the configuration hasn't changed but the playlist needs to be rebuilt as a result of some other event.

virtual bool autoplaylist_client_v2::show_ui_available ( )
pure virtual

Returns whether the show_ui() method is available / does anything useful with our implementation (not everyone implements show_ui).


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