/usr/include/mpd/playlist.h is in libmpdclient-dev 2.9-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | /* libmpdclient
(c) 2003-2010 The Music Player Daemon Project
This project's homepage is: http://www.musicpd.org
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of the Music Player Daemon nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*! \file
* \brief MPD client library
*
* Manipulate stored playlists.
*
* Do not include this header directly. Use mpd/client.h instead.
*/
#ifndef LIBMPDCLIENT_PLAYLIST_H
#define LIBMPDCLIENT_PLAYLIST_H
#include <mpd/compiler.h>
#include <stdbool.h>
#include <time.h>
struct mpd_pair;
struct mpd_connection;
/**
* \struct mpd_playlist
*
* An opaque representation for a playlist stored in MPD's
* playlist directory. Use the functions provided by this header to
* access the object's attributes.
*/
struct mpd_playlist;
#ifdef __cplusplus
extern "C" {
#endif
/**
* Free memory allocated by the #mpd_playlist object.
*/
void
mpd_playlist_free(struct mpd_playlist *playlist);
/**
* Duplicates a #mpd_playlist object.
*
* @return the new object, or NULL on out of memory
*/
mpd_malloc
struct mpd_playlist *
mpd_playlist_dup(const struct mpd_playlist *playlist);
/**
* Returns the path name of this playlist file. It does not begin
* with a slash.
*/
mpd_pure
const char *
mpd_playlist_get_path(const struct mpd_playlist *playlist);
/**
* @return the POSIX UTC time stamp of the last modification, or 0 if
* that is unknown
*/
mpd_pure
time_t
mpd_playlist_get_last_modified(const struct mpd_playlist *playlist);
/**
* Begins parsing a new playlist.
*
* @param pair the first pair in this playlist (name must be
* "playlist")
* @return the new #mpd_entity object, or NULL on error (out of
* memory, or pair name is not "playlist")
*/
mpd_malloc
struct mpd_playlist *
mpd_playlist_begin(const struct mpd_pair *pair);
/**
* Parses the pair, adding its information to the specified
* #mpd_playlist object.
*
* @return true if the pair was parsed and added to the playlist (or if
* the pair was not understood and ignored), false if this pair is the
* beginning of the next playlist
*/
bool
mpd_playlist_feed(struct mpd_playlist *playlist, const struct mpd_pair *pair);
/**
* Obtain a list of stored playlists.
*
* @param connection the connection to MPD
* @return true on success, false on error
*/
bool
mpd_send_list_playlists(struct mpd_connection *connection);
/**
* Receives the next playlist from the MPD server.
*
* @return a #mpd_playlist object, or NULL on error or if the playlist list is
* finished
*/
mpd_malloc
struct mpd_playlist *
mpd_recv_playlist(struct mpd_connection *connection);
/**
* List the content of a stored playlist.
*
* @param connection the connection to MPD
* @param name the name of the playlist
* @return true on success, false on error
*/
bool
mpd_send_list_playlist(struct mpd_connection *connection, const char *name);
/**
* List the content, with full metadata, of a stored playlist.
*
* @param connection the connection to MPD
* @param name the name of the playlist
* @return true on success, false on error
*/
bool
mpd_send_list_playlist_meta(struct mpd_connection *connection, const char *name);
bool
mpd_send_playlist_clear(struct mpd_connection *connection, const char *name);
bool
mpd_run_playlist_clear(struct mpd_connection *connection, const char *name);
bool
mpd_send_playlist_add(struct mpd_connection *connection, const char *name,
const char *path);
bool
mpd_run_playlist_add(struct mpd_connection *connection,
const char *name, const char *path);
bool
mpd_send_playlist_move(struct mpd_connection *connection, const char *name,
unsigned from, unsigned to);
bool
mpd_send_playlist_delete(struct mpd_connection *connection, const char *name,
unsigned pos);
bool
mpd_run_playlist_delete(struct mpd_connection *connection,
const char *name, unsigned pos);
bool
mpd_send_save(struct mpd_connection *connection, const char *name);
bool
mpd_run_save(struct mpd_connection *connection, const char *name);
bool
mpd_send_load(struct mpd_connection *connection, const char *name);
bool
mpd_run_load(struct mpd_connection *connection, const char *name);
bool
mpd_send_rename(struct mpd_connection *connection,
const char *from, const char *to);
bool
mpd_run_rename(struct mpd_connection *connection,
const char *from, const char *to);
bool
mpd_send_rm(struct mpd_connection *connection, const char *name);
bool
mpd_run_rm(struct mpd_connection *connection, const char *name);
#ifdef __cplusplus
}
#endif
#endif
|