timer_handlers.h File Reference

myMPD timer handlers More...

#include "src/lib/config/mympd_state.h"

Include dependency graph for timer_handlers.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	timer_ids {   TIMER_ID_DISK_CACHE_CROP = 1 , TIMER_ID_SMARTPLS_UPDATE , TIMER_ID_CACHES_CREATE , TIMER_ID_WEBRADIODB_UPDATE ,   TIMER_ID_STATE_SAVE }

Functions
const char *	get_timer_name (unsigned timer_id)
void	timer_handler_by_id (enum timer_ids timer_id, struct t_timer_definition *definition, struct t_mympd_state *mympd_state)
void	timer_handler_select (unsigned timer_id, struct t_timer_definition *definition, struct t_mympd_state *mympd_state)
bool	mympd_api_timer_startplay (struct t_partition_state *partition_state, unsigned volume, sds playlist, sds preset)

Detailed Description

myMPD timer handlers

Enumeration Type Documentation

timer_ids

enum timer_ids

Internal timer ids

Function Documentation

get_timer_name()

const char * get_timer_name

(

unsigned

timer_id

)

Public functions Return the timer name for a timer_id

Parameters

timer_id

Timer ID

Returns

const char* Timer name

mympd_api_timer_startplay()

bool mympd_api_timer_startplay	(	struct t_partition_state *	partition_state,
		unsigned	volume,
		sds	playlist,
		sds	preset )

This function is used by INTERNAL_API_TIMER_STARTPLAY and is called from the mympd_api_handler

Parameters

partition_state	pointer to the partition_state
volume	mpd volume to set
playlist	the mpd playlist to load
preset	the preset to load

Returns

true on success else false

timer_handler_by_id()

void timer_handler_by_id	(	enum timer_ids	timer_id,
		struct t_timer_definition *	definition,
		struct t_mympd_state *	mympd_state )

Handles timer by timer_id, this is only used for internal timers

Parameters

timer_id	the internal timer_id from enum timer_ids
definition	the timer definition - not used
mympd_state	Pointer to mympd_state

timer_handler_select()

void timer_handler_select	(	unsigned	timer_id,
		struct t_timer_definition *	definition,
		struct t_mympd_state *	mympd_state )

Handles user defined timers

Parameters

timer_id	the timer id
definition	the timer definition
mympd_state	Pointer to mympd_state