/usr/include/xmms2/xmmsclient/xmmsclient++/medialib.h is in libxmmsclient++-dev 0.8+dfsg-2.
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | /* XMMS2 - X Music Multiplexer System
* Copyright (C) 2003-2011 XMMS2 Team
*
* PLUGINS ARE NOT CONSIDERED TO BE DERIVED WORK !!!
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
#ifndef XMMSCLIENTPP_MEDIALIB_H
#define XMMSCLIENTPP_MEDIALIB_H
#include <xmmsclient/xmmsclient.h>
#include <xmmsclient/xmmsclient++/mainloop.h>
#include <xmmsclient/xmmsclient++/result.h>
#include <string>
#include <list>
namespace Xmms
{
class Client;
/** @class Medialib medialib.h "xmmsclient/xmmsclient++/medialib.h"
* @brief This class controls the medialib.
*/
class Medialib
{
public:
struct Entry {
typedef xmmsc_medialib_entry_status_t Status;
static const Status STATUS_OK = XMMS_MEDIALIB_ENTRY_STATUS_OK;
static const Status STATUS_NEW = XMMS_MEDIALIB_ENTRY_STATUS_NEW;
static const Status STATUS_RESOLVING = XMMS_MEDIALIB_ENTRY_STATUS_RESOLVING;
static const Status STATUS_NOT_AVAILABLE = XMMS_MEDIALIB_ENTRY_STATUS_NOT_AVAILABLE;
static const Status STATUS_REHASH = XMMS_MEDIALIB_ENTRY_STATUS_REHASH;
};
/** Destructor. */
~Medialib();
/** Add a URL to the medialib.
* If you want to add multiple files you should call pathImport.
*
* @param url URL to add to the medialib.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addEntry( const std::string& url ) const;
/** Add a URL with arguments to the medialib.
* If you want to add multiple files you should call pathImport.
*
* @param url URL to add to the medialib.
* @param args Pairs of key-value strings used as arguments.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addEntry( const std::string& url,
const std::list< std::string >& args ) const;
/** Add a URL to the medialib.
* Same as #addEntry but takes a encoded URL instead.
*
* @param url URL to add to the medialib.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult addEntryEncoded( const std::string& url ) const;
/** Remove a custom field in the medialib associated with an entry.
*
* The optional @c source parameter will default to
* client/@<clientname@> if not provided.
*
* @param id Entry ID.
* @param key Field key to remove.
* @param source Source for the entry. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult entryPropertyRemove( int id,
const std::string& key,
const std::string& source = "" ) const;
/** Associate a value with a medialib entry.
*
* The optional @c source parameter will default to
* client/@<clientname@> if not provided.
*
* @param id Entry ID.
* @param key Field key to set.
* @param value to set.
* @param source Source for the value. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult entryPropertySet( int id,
const std::string& key,
const std::string& value,
const std::string& source = "" ) const;
/**
* @overload
* @note It takes a int instead of string
*/
VoidResult entryPropertySet( int id,
const std::string& key,
int32_t value,
const std::string& source = "" ) const;
/** Search for a entry (URL) in the medialib db
* and return its ID number.
*
* @param url The URL to search for.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*
* @return ID number
*/
IntResult getID( const std::string& url ) const;
/** Retrieve information about a entry from the medialib.
*
* @param id ID of the entry.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
PropDictResult getInfo( int id ) const;
/** Import all files recursively from the
* directory passed as argument.
*
* @param path Directory to import.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult pathImport( const std::string& path ) const;
/** Import all files recursively from the
* directory passed as argument.
*
* same as #pathImport but takes a encoded path instead.
*
* @param path Directory to import.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult pathImportEncoded( const std::string& path ) const;
/** Rehash the medialib.
* This will check data in the medialib still
* is the same as the data in files.
*
* @param id The ID to rehash. (<b>optional</b>,
* default is to rehash all)
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult rehash( int id = 0 ) const;
/** Remove an entry from the medialib.
*
* @param id ID of the entry to remove.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult removeEntry( int id ) const;
/** Change the url property of an entry in the media library. Note
* that you need to handle the actual file move yourself.
*
* @param id ID of the entry to move.
* @param path New location of the entry.
*
* @throw connection_error If the client isn't connected.
* @throw mainloop_running_error If a mainloop is running -
* sync functions can't be called when mainloop is running. This
* is only thrown if the programmer is careless or doesn't know
* what he/she's doing. (logic_error)
* @throw result_error If the operation failed.
*/
VoidResult moveEntry( int id,
const std::string& path ) const;
/** Request the medialib entry added broadcast.
*
* This will be called if a new entry is added to
* the medialib serverside.
*
* @param slot Function pointer to a function taking a
* const int& and returning a bool.
* @param error Function pointer to an error callback
* function. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
*/
IntSignal broadcastEntryAdded() const;
/** Request the medialib entry changed broadcast.
*
* This will be called if a entry changes on the serverside.
* The argument will be an medialib id.
*
* @param slot Function pointer to a function taking a
* const int& and returning a bool.
* @param error Function pointer to an error callback
* function. (<b>optional</b>)
*
* @throw connection_error If the client isn't connected.
*/
IntSignal broadcastEntryChanged() const;
/** @cond */
private:
friend class Client;
Medialib( xmmsc_connection_t*& conn, bool& connected,
MainloopInterface*& ml );
Medialib( const Medialib& src );
Medialib& operator=( const Medialib& src );
xmmsc_connection_t*& conn_;
bool& connected_;
MainloopInterface*& ml_;
/** @endcond */
};
}
#endif // XMMSCLIENTPP_MEDIALIB_H
|