Documentation
¶
Index ¶
- type Collector
- func (d *Collector) Description() string
- func (d *Collector) Disable()
- func (d *Collector) Enable()
- func (d *Collector) Execute(pluginName string, update soundtouch.Update, speaker soundtouch.Speaker)
- func (d *Collector) IsEnabled() bool
- func (d *Collector) Name() string
- func (d *Collector) SampleConfig() string
- func (d *Collector) Terminate() bool
- type Config
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Collector ¶
type Collector struct {
Config
Plugin soundtouch.PluginFunc
// contains filtered or unexported fields
}
Collector describes the plugin. It has a Config to store the configuration Plugin the plugin function suspended indicates that the plugin is temporarely suspended
func NewCollector ¶
NewCollector creates a new Collector plugin with the configuration
func (*Collector) Description ¶
Description returns a string explaining the purpose of this plugin
func (*Collector) Disable ¶
func (d *Collector) Disable()
Disable temporarely the execution of the plugin
func (*Collector) Enable ¶
func (d *Collector) Enable()
Enable temporarely the execution of the plugin
func (*Collector) Execute ¶
func (d *Collector) Execute(pluginName string, update soundtouch.Update, speaker soundtouch.Speaker)
Execute runs the plugin with the given parameter
func (*Collector) SampleConfig ¶
SampleConfig returns text explaining how plugin should be configured
type Config ¶
type Config struct {
Speakers []string `toml:"speakers"`
Artists []string `toml:"artists"`
Database string `toml:"database"`
}
Config contains the configuration of the plugin Speakers list of SpeakerNames the handler is added. All if empty Artists a list of artists for which episodes should be collected
Source Files