myMPD
Internal API documentation
Loading...
Searching...
No Matches
sticker.h File Reference

MPD sticker helpers. More...

#include "dist/libmympdclient/include/mpd/client.h"
#include "src/lib/list.h"
Include dependency graph for sticker.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  t_sticker
 

Enumerations

enum  mympd_sticker_type {
  STICKER_TYPE_UNKNOWN = -1 , STICKER_TYPE_SONG , STICKER_TYPE_PLAYLIST , STICKER_TYPE_FILTER ,
  STICKER_TYPE_MYMPD_ALBUM , STICKER_TYPE_TAG_TITLE , STICKER_TYPE_TAG_ALBUM , STICKER_TYPE_TAG_ARTIST ,
  STICKER_TYPE_TAG_ALBUM_ARTIST , STICKER_TYPE_TAG_GENRE , STICKER_TYPE_TAG_COMPOSER , STICKER_TYPE_TAG_PERFORMER ,
  STICKER_TYPE_TAG_CONDUCTOR , STICKER_TYPE_TAG_WORK , STICKER_TYPE_TAG_ENSEMBLE , STICKER_TYPE_TAG_LOCATION ,
  STICKER_TYPE_TAG_LABEL , STICKER_TYPE_COUNT
}
 
enum  sticker_like { STICKER_LIKE_HATE = 0 , STICKER_LIKE_NEUTRAL = 1 , STICKER_LIKE_LOVE = 2 }
 
enum  mympd_sticker_names {
  STICKER_UNKNOWN = -1 , STICKER_PLAY_COUNT , STICKER_SKIP_COUNT , STICKER_LIKE ,
  STICKER_LAST_PLAYED , STICKER_LAST_SKIPPED , STICKER_ELAPSED , STICKER_RATING ,
  STICKER_COUNT
}
 
enum  mympd_feedback_type { FEEDBACK_LIKE , FEEDBACK_STAR }
 

Functions

const char * mympd_sticker_type_name_lookup (enum mympd_sticker_type sticker_type)
 
enum mympd_sticker_type mympd_sticker_type_name_parse (const char *name)
 
const char * sticker_name_lookup (enum mympd_sticker_names sticker)
 
enum mympd_sticker_names sticker_name_parse (const char *name)
 
void sticker_struct_init (struct t_sticker *sticker)
 
void sticker_struct_clear (struct t_sticker *sticker)
 
enum mpd_sticker_operator sticker_oper_parse (const char *str)
 
enum mpd_sticker_sort sticker_sort_parse (const char *str)
 

Detailed Description

MPD sticker helpers.

Enumeration Type Documentation

◆ mympd_feedback_type

myMPD feedback types

◆ mympd_sticker_names

myMPD sticker types

◆ mympd_sticker_type

MPD sticker types

◆ sticker_like

Valid values for like sticker

Function Documentation

◆ mympd_sticker_type_name_lookup()

const char * mympd_sticker_type_name_lookup ( enum mympd_sticker_type  sticker_type)

Returns the sticker name as string

Parameters
sticker_typeenum mpd_sticker_type
Returns
const char* the sticker name

◆ mympd_sticker_type_name_parse()

enum mympd_sticker_type mympd_sticker_type_name_parse ( const char *  name)

Parses the mpd sticker type string

Parameters
namesticker type string
Returns
enum mpd_tag_type the sticker enum

◆ sticker_name_lookup()

const char * sticker_name_lookup ( enum mympd_sticker_names  sticker)

Returns the sticker name as string

Parameters
stickerenum mympd_sticker_types
Returns
const char* the sticker name

◆ sticker_name_parse()

enum mympd_sticker_names sticker_name_parse ( const char *  name)

Parses the sticker name

Parameters
namesticker name
Returns
enum mpd_tag_type the sticker enum

◆ sticker_oper_parse()

enum mpd_sticker_operator sticker_oper_parse ( const char *  str)

Converts a string to a mpd sticker operator

Parameters
strstring to parse
Returns
mpd sticker operator

◆ sticker_sort_parse()

enum mpd_sticker_sort sticker_sort_parse ( const char *  str)

Converts a string to a mpd sticker sort enum

Parameters
strstring to parse
Returns
mpd sticker sort type

◆ sticker_struct_clear()

void sticker_struct_clear ( struct t_sticker sticker)

Clears the sticker struct

Parameters
sticker

◆ sticker_struct_init()

void sticker_struct_init ( struct t_sticker sticker)

Initializes the sticker struct

Parameters
stickerstruct to init