/usr/include/xmms2/xmmsclient/xmmsclient++/playback.h is in libxmmsclient++-dev 0.8+dfsg-18.1build3.
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 | /* 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_PLAYBACK_H
#define XMMSCLIENTPP_PLAYBACK_H
#include <xmmsclient/xmmsclient.h>
#include <xmmsclient/xmmsclient++/mainloop.h>
#include <xmmsclient/xmmsclient++/typedefs.h>
#include <xmmsclient/xmmsclient++/dict.h>
#include <xmmsclient/xmmsclient++/result.h>
#include <string>
namespace Xmms
{
class Client;
/** @class Playback playback.h "xmmsclient/xmmsclient++/playback.h"
* @brief This class controls the playback.
*/
class Playback
{
public:
typedef xmms_playback_status_t Status;
static const Status STOPPED = XMMS_PLAYBACK_STATUS_STOP;
static const Status PLAYING = XMMS_PLAYBACK_STATUS_PLAY;
static const Status PAUSED = XMMS_PLAYBACK_STATUS_PAUSE;
/** Destructor.
*/
virtual ~Playback();
/** Stop decoding of current song.
*
* This will start decoding of the song set with
* Playlist::setNext, or the current song again if no
* Playlist::setNext was executed.
*
* @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 tickle() const;
/** Stops the current playback.
*
* This will make the server idle.
*
* @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 stop() const;
/** Pause the current playback,
* will tell the output to not read nor write.
*
* @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 pause() const;
/** Starts playback if server is idle.
*
* @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 start() const;
/** Seek to a absolute time in the current playback.
*
* @param milliseconds The total number of ms where
* playback should continue.
*
* @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 seekMs(int milliseconds) const;
/** Seek to a time relative to the current position
* in the current playback.
*
* @param milliseconds The offset in ms from the current
* position to where playback should continue.
*
* @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 seekMsRel(int milliseconds) const;
/** Seek to a absolute number of samples in the current playback.
*
* @param samples The total number of samples where
* playback should continue.
*
* @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 seekSamples(int samples) const;
/** Seek to a number of samples relative to the current
* position in the current playback.
*
* @param samples The offset in number of samples from the current
* position to where playback should continue.
*
* @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 seekSamplesRel(int samples) const;
/** Make server emit the current id.
*
* @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 The currently playing ID.
*/
IntResult currentID() const;
/** Make server emit the playback status.
*
* @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 Playback status, compare with
* Playback::[STOPPED|PLAYING|PAUSED]
*/
StatusResult getStatus() const;
/** Make server emit the current playtime.
*
* @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 The playtime in milliseconds.
*/
IntResult getPlaytime() const;
/** Set the volume of a channel.
*
* @param channel Name of the channel.
* @param volume Volume within range [0-100].
*
* @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 volumeSet(const std::string& channel,
int volume) const;
/** Get a channel<->volume list from the server.
*
* @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 A Dict containing channel<->volume pairs.
*/
DictResult volumeGet() const;
IntSignal broadcastCurrentID() const;
StatusSignal broadcastStatus() const;
DictSignal broadcastVolumeChanged() const;
IntSignal signalPlaytime() const;
/** @cond */
private:
// Constructor, only to be called by Xmms::Client
friend class Client;
Playback( xmmsc_connection_t*& conn, bool& connected,
MainloopInterface*& ml );
// Copy-constructor / operator=
Playback( const Playback& src );
Playback operator=( const Playback& src ) const;
xmmsc_connection_t*& conn_;
bool& connected_;
MainloopInterface*& ml_;
/** @endcond */
};
}
#endif // XMMSCLIENTPP_PLAYBACK_H
|