Debian Codegraph @

src/core/capabilities/StreamInfoCapability.h

raw
1 /****************************************************************************************
2 * Copyright (c) 2008 Dan Meltzer <[email protected]> *
3 * *
4 * This program is free software; you can redistribute it and/or modify it under *
5 * the terms of the GNU General Public License as published by the Free Software *
6 * Foundation; either version 2 of the License, or (at your option) any later *
7 * version. *
8 * *
9 * This program is distributed in the hope that it will be useful, but WITHOUT ANY *
10 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A *
11 * PARTICULAR PURPOSE. See the GNU General Public License for more details. *
12 * *
13 * You should have received a copy of the GNU General Public License along with *
14 * this program. If not, see <http://www.gnu.org/licenses/>. *
15 ****************************************************************************************/
16
17 #ifndef STREAMINFOCAPABILITY_H
18 #define STREAMINFOCAPABILITY_H
19
20 #include "core/amarokcore_export.h"
21 #include "core/capabilities/Capability.h"
22
23 #include <QString>
24 namespace Capabilities
25 {
26
27 /**
28 * This capability is designed to provide additional information
29 * about streaming metadata. For meta types that provide multiple
30 * tracks within the same stream (lastfm, shoutcast, etc )
31 * this capability is designed to return stream metadata,
32 * where the properties in the Meta::Track class refers to the track
33 * being played within the stream.
34
35 @author Dan Meltzer <[email protected]>
36 */
37 class AMAROKCORE_EXPORT StreamInfoCapability : public Capabilities::Capability
38 {
39 Q_OBJECT
40 public:
41 StreamInfoCapability() {}
42 ~StreamInfoCapability() override {}
43
44 /**
45 * The human readable name of this stream
46 * @return A string representing the name of this stream.
47 */
48 virtual QString streamName() const = 0;
49 /**
50 * The source this stream belongs to.
51 * @return The name of the owning source.
52 */
53 virtual QString streamSource() const { return QString(); }
54 static Type capabilityInterfaceType() { return Capabilities::Capability::StreamInfo; }
55
56 };
57
58 }
59
60 #endif