src/playlist.h File Reference

#include "queue.h"
#include <stdbool.h>
#include <stdio.h>

Define Documentation

#define PLAYLIST_COMMENT '#'

Definition at line 28 of file playlist.h.

Enumeration Type Documentation

enum playlist_result

Enumerator:

PLAYLIST_RESULT_SUCCESS
PLAYLIST_RESULT_ERRNO
PLAYLIST_RESULT_DENIED
PLAYLIST_RESULT_NO_SUCH_SONG
PLAYLIST_RESULT_NO_SUCH_LIST
PLAYLIST_RESULT_LIST_EXISTS
PLAYLIST_RESULT_BAD_NAME
PLAYLIST_RESULT_BAD_RANGE
PLAYLIST_RESULT_NOT_PLAYING
PLAYLIST_RESULT_TOO_LARGE
PLAYLIST_RESULT_DISABLED

Definition at line 30 of file playlist.h.

Function Documentation

enum playlist_result addSongToPlaylist	(	struct playlist *	playlist,
		struct song *	song,
		unsigned *	added_id
	)

enum playlist_result addToPlaylist	(	struct playlist *	playlist,
		const char *	file,
		unsigned *	added_id
	)

void clearPlaylist ( struct playlist * playlist )

void deleteASongFromPlaylist	(	struct playlist *	playlist,
		const struct song *	song
	)

enum playlist_result deleteFromPlaylist	(	struct playlist *	playlist,
		unsigned	song
	)

enum playlist_result deleteFromPlaylistById	(	struct playlist *	playlist,
		unsigned	song
	)

void finishPlaylist ( void )

bool getPlaylistConsumeStatus ( const struct playlist * playlist )

int getPlaylistCurrentSong ( const struct playlist * playlist )

int getPlaylistLength ( const struct playlist * playlist )

int getPlaylistNextSong ( const struct playlist * playlist )

bool getPlaylistRandomStatus ( const struct playlist * playlist )

bool getPlaylistRepeatStatus ( const struct playlist * playlist )

bool getPlaylistSingleStatus ( const struct playlist * playlist )

unsigned getPlaylistSongId	(	const struct playlist *	playlist,
		unsigned	song
	)

unsigned long getPlaylistVersion ( const struct playlist * playlist )

void initPlaylist ( void )

int is_valid_playlist_name ( const char * utf8path )

enum playlist_result moveSongInPlaylistById	(	struct playlist *	playlist,
		unsigned	id,
		int	to
	)

enum playlist_result moveSongRangeInPlaylist	(	struct playlist *	playlist,
		unsigned	start,
		unsigned	end,
		int	to
	)

void nextSongInPlaylist ( struct playlist * playlist )

enum playlist_result playlist_append_file	(	struct playlist *	playlist,
		const char *	path,
		int	uid,
		unsigned *	added_id
	)

Appends a local file (outside the music database) to the playlist, but only if the file's owner is equal to the specified uid.

void playlist_finish ( struct playlist * playlist )

static struct queue* playlist_get_queue ( const struct playlist * playlist ) [static, read]

Returns the "queue" object of the global playlist instance.

Definition at line 114 of file playlist.h.

void playlist_init ( struct playlist * playlist )

void playlist_tag_changed ( struct playlist * playlist )

void playlistVersionChange ( struct playlist * playlist )

enum playlist_result playPlaylist	(	struct playlist *	playlist,
		int	song
	)

enum playlist_result playPlaylistById	(	struct playlist *	playlist,
		int	song
	)

void previousSongInPlaylist ( struct playlist * playlist )

void readPlaylistState ( FILE * )

void savePlaylistState ( FILE * )

enum playlist_result seekSongInPlaylist	(	struct playlist *	playlist,
		unsigned	song,
		float	seek_time
	)

enum playlist_result seekSongInPlaylistById	(	struct playlist *	playlist,
		unsigned	id,
		float	seek_time
	)

void setPlaylistConsumeStatus	(	struct playlist *	playlist,
		bool	status
	)

void setPlaylistRandomStatus	(	struct playlist *	playlist,
		bool	status
	)

void setPlaylistRepeatStatus	(	struct playlist *	playlist,
		bool	status
	)

void setPlaylistSingleStatus	(	struct playlist *	playlist,
		bool	status
	)

void shufflePlaylist	(	struct playlist *	playlist,
		unsigned	start,
		unsigned	end
	)

void stopPlaylist ( struct playlist * playlist )

enum playlist_result swapSongsInPlaylist	(	struct playlist *	playlist,
		unsigned	song1,
		unsigned	song2
	)

enum playlist_result swapSongsInPlaylistById	(	struct playlist *	playlist,
		unsigned	id1,
		unsigned	id2
	)

void syncPlayerAndPlaylist ( struct playlist * playlist )

Variable Documentation

struct playlist g_playlist

the global playlist object


Data Structures
struct	playlist
Defines
#define	PLAYLIST_COMMENT '#'
Enumerations
enum	playlist_result { PLAYLIST_RESULT_SUCCESS, PLAYLIST_RESULT_ERRNO, PLAYLIST_RESULT_DENIED, PLAYLIST_RESULT_NO_SUCH_SONG, PLAYLIST_RESULT_NO_SUCH_LIST, PLAYLIST_RESULT_LIST_EXISTS, PLAYLIST_RESULT_BAD_NAME, PLAYLIST_RESULT_BAD_RANGE, PLAYLIST_RESULT_NOT_PLAYING, PLAYLIST_RESULT_TOO_LARGE, PLAYLIST_RESULT_DISABLED }
Functions
void	initPlaylist (void)
void	finishPlaylist (void)
void	playlist_init (struct playlist *playlist)
void	playlist_finish (struct playlist *playlist)
void	playlist_tag_changed (struct playlist *playlist)
static struct queue *	playlist_get_queue (const struct playlist *playlist)
	Returns the "queue" object of the global playlist instance.
void	readPlaylistState (FILE *)
void	savePlaylistState (FILE *)
void	clearPlaylist (struct playlist *playlist)
enum playlist_result	playlist_append_file (struct playlist playlist, const char path, int uid, unsigned *added_id)
	Appends a local file (outside the music database) to the playlist, but only if the file's owner is equal to the specified uid.
enum playlist_result	addToPlaylist (struct playlist playlist, const char file, unsigned *added_id)
enum playlist_result	addSongToPlaylist (struct playlist playlist, struct song song, unsigned *added_id)
enum playlist_result	deleteFromPlaylist (struct playlist *playlist, unsigned song)
enum playlist_result	deleteFromPlaylistById (struct playlist *playlist, unsigned song)
void	stopPlaylist (struct playlist *playlist)
enum playlist_result	playPlaylist (struct playlist *playlist, int song)
enum playlist_result	playPlaylistById (struct playlist *playlist, int song)
void	nextSongInPlaylist (struct playlist *playlist)
void	syncPlayerAndPlaylist (struct playlist *playlist)
void	previousSongInPlaylist (struct playlist *playlist)
void	shufflePlaylist (struct playlist *playlist, unsigned start, unsigned end)
void	deleteASongFromPlaylist (struct playlist playlist, const struct song song)
enum playlist_result	moveSongRangeInPlaylist (struct playlist *playlist, unsigned start, unsigned end, int to)
enum playlist_result	moveSongInPlaylistById (struct playlist *playlist, unsigned id, int to)
enum playlist_result	swapSongsInPlaylist (struct playlist *playlist, unsigned song1, unsigned song2)
enum playlist_result	swapSongsInPlaylistById (struct playlist *playlist, unsigned id1, unsigned id2)
bool	getPlaylistRepeatStatus (const struct playlist *playlist)
void	setPlaylistRepeatStatus (struct playlist *playlist, bool status)
bool	getPlaylistRandomStatus (const struct playlist *playlist)
void	setPlaylistRandomStatus (struct playlist *playlist, bool status)
bool	getPlaylistSingleStatus (const struct playlist *playlist)
void	setPlaylistSingleStatus (struct playlist *playlist, bool status)
bool	getPlaylistConsumeStatus (const struct playlist *playlist)
void	setPlaylistConsumeStatus (struct playlist *playlist, bool status)
int	getPlaylistCurrentSong (const struct playlist *playlist)
int	getPlaylistNextSong (const struct playlist *playlist)
unsigned	getPlaylistSongId (const struct playlist *playlist, unsigned song)
int	getPlaylistLength (const struct playlist *playlist)
unsigned long	getPlaylistVersion (const struct playlist *playlist)
enum playlist_result	seekSongInPlaylist (struct playlist *playlist, unsigned song, float seek_time)
enum playlist_result	seekSongInPlaylistById (struct playlist *playlist, unsigned id, float seek_time)
void	playlistVersionChange (struct playlist *playlist)
int	is_valid_playlist_name (const char *utf8path)
Variables
struct playlist	g_playlist
	the global playlist object

src/playlist.h File Reference

Data Structures

Defines

Enumerations

Functions

Variables

Define Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation