MPD client library. More...

#include "tag.h"
#include "compiler.h"
#include <stdbool.h>
#include <time.h>

Include dependency graph for song.h:

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

Functions
void	mpd_song_free (struct mpd_song *song)

struct mpd_song *	mpd_song_dup (const struct mpd_song *song)

const char *	mpd_song_get_uri (const struct mpd_song *song)

const char *	mpd_song_get_tag (const struct mpd_song *song, enum mpd_tag_type type, unsigned idx)

unsigned	mpd_song_get_duration (const struct mpd_song *song)

unsigned	mpd_song_get_duration_ms (const struct mpd_song *song)

unsigned	mpd_song_get_start (const struct mpd_song *song)

unsigned	mpd_song_get_end (const struct mpd_song *song)

time_t	mpd_song_get_last_modified (const struct mpd_song *song)

time_t	mpd_song_get_added (const struct mpd_song *song)

void	mpd_song_set_pos (struct mpd_song *song, unsigned pos)

unsigned	mpd_song_get_pos (const struct mpd_song *song)

unsigned	mpd_song_get_id (const struct mpd_song *song)

unsigned	mpd_song_get_prio (const struct mpd_song *song)

const struct mpd_audio_format *	mpd_song_get_audio_format (const struct mpd_song *song)

struct mpd_song *	mpd_song_begin (const struct mpd_pair *pair)

bool	mpd_song_feed (struct mpd_song song, const struct mpd_pair pair)

struct mpd_song *	mpd_recv_song (struct mpd_connection *connection)

Detailed Description

MPD client library.

Do not include this header directly. Use mpd/client.h instead.

Definition in file song.h.

Function Documentation

◆ mpd_song_free()

void mpd_song_free ( struct mpd_song * song )

Free memory allocated by the mpd_song object.

◆ mpd_song_dup()

struct mpd_song * mpd_song_dup ( const struct mpd_song * song )

Duplicates the specified mpd_song object.

Returns: the copy, or NULL if out of memory

◆ mpd_song_get_uri()

const char * mpd_song_get_uri ( const struct mpd_song * song )

Returns the URI of the song. This is either a path relative to the MPD music directory (without leading slash), or an URL with a scheme, e.g. a HTTP URL for a radio stream.

◆ mpd_song_get_tag()

const char * mpd_song_get_tag	(	const struct mpd_song *	song,
		enum mpd_tag_type	type,
		unsigned	idx
	)

Queries a tag value.

Parameters

song	the song object
type	the tag type
idx	pass 0 to get the first value for this tag type. This argument may be used to iterate all values, until this function returns NULL

Returns: the tag value, or NULL if this tag type (or this index) does not exist

◆ mpd_song_get_duration()

unsigned mpd_song_get_duration ( const struct mpd_song * song )

Returns the duration of this song in seconds. 0 means the duration is unknown.

◆ mpd_song_get_duration_ms()

unsigned mpd_song_get_duration_ms ( const struct mpd_song * song )

Returns the duration of this song in milliseconds. 0 means the duration is unknown.

Since: libmpdclient 2.10

◆ mpd_song_get_start()

unsigned mpd_song_get_start ( const struct mpd_song * song )

Returns the start of the virtual song within the physical file in seconds.

Since: libmpdclient 2.3

◆ mpd_song_get_end()

unsigned mpd_song_get_end ( const struct mpd_song * song )

Returns the end of the virtual song within the physical file in seconds. 0 means that the physical song file is played to the end.

Since: libmpdclient 2.3

◆ mpd_song_get_last_modified()

time_t mpd_song_get_last_modified ( const struct mpd_song * song )

Returns: the POSIX UTC time stamp of the last modification, or 0 if that is unknown

◆ mpd_song_get_added()

time_t mpd_song_get_added ( const struct mpd_song * song )

Returns: the POSIX UTC time stamp of database addition, or 0 if that is unknown.

Since: libmpdclient 2.21, MPD 0.24

◆ mpd_song_set_pos()

void mpd_song_set_pos	(	struct mpd_song *	song,
		unsigned	pos
	)

Sets the position within the queue. This value is not used for songs which are not in the queue.

This function is useful when applying the values returned by mpd_recv_queue_change_brief().

◆ mpd_song_get_pos()

unsigned mpd_song_get_pos ( const struct mpd_song * song )

Returns the position of this song in the queue. The value is undefined if you did not obtain this song from the queue.

◆ mpd_song_get_id()

unsigned mpd_song_get_id ( const struct mpd_song * song )

Returns the id of this song in the playlist. The value is undefined if you did not obtain this song from the queue.

◆ mpd_song_get_prio()

unsigned mpd_song_get_prio ( const struct mpd_song * song )

Returns the priority of this song in the playlist. The value is undefined if you did not obtain this song from the queue.

Since: libmpdclient 2.8

◆ mpd_song_get_audio_format()

const struct mpd_audio_format * mpd_song_get_audio_format ( const struct mpd_song * song )

Returns audio format as determined by MPD's decoder plugin. May return NULL if the format is not available or unknown.

Since: libmpdclient 2.15

◆ mpd_song_begin()

struct mpd_song * mpd_song_begin ( const struct mpd_pair * pair )

Begins parsing a new song.