From 5129ba1232cd7a155bfb9f8bf1e85ab7c063b84c Mon Sep 17 00:00:00 2001 From: Sebastian Kaupper Date: Tue, 17 Dec 2019 22:52:05 +0100 Subject: [PATCH] Final make doc (#89) --- docs/html/ConfigHandler_8cpp.html | 10 +- docs/html/ConfigHandler_8h.html | 11 +- docs/html/ConfigHandler_8h_source.html | 60 +- docs/html/DataStore_8h.html | 102 +++ docs/html/DataStore_8h_source.html | 151 ++++ docs/html/GlobalTypes_8h.html | 8 +- docs/html/GlobalTypes_8h_source.html | 4 +- docs/html/JukeBox_8cpp.html | 15 +- docs/html/JukeBox_8h.html | 16 +- docs/html/JukeBox_8h_source.html | 117 +-- docs/html/LoggingHandler_8cpp.html | 25 +- docs/html/LoggingHandler_8h.html | 19 +- docs/html/LoggingHandler_8h_source.html | 28 +- docs/html/MusicBackend_8h.html | 13 +- docs/html/MusicBackend_8h_source.html | 69 +- docs/html/NetworkAPI_8h_source.html | 34 +- docs/html/NetworkListener_8h.html | 17 +- docs/html/NetworkListener_8h_source.html | 92 ++- docs/html/Queue_8h.html | 19 +- docs/html/Queue_8h_source.html | 29 +- docs/html/RAMDataStore_8h.html | 109 +++ docs/html/RAMDataStore_8h_source.html | 156 ++++ docs/html/RequestInformation_8h.html | 103 +++ docs/html/RequestInformation_8h_source.html | 105 +++ docs/html/RestAPI_8cpp.html | 8 +- docs/html/RestAPI_8h.html | 4 +- docs/html/RestAPI_8h_source.html | 14 +- docs/html/RestEndpointHandlers_8cpp.html | 344 +++++++++ docs/html/RestEndpointHandlers_8h.html | 127 ++++ docs/html/RestEndpointHandlers_8h_source.html | 122 ++++ docs/html/RestRequestHandler_8cpp.html | 103 +++ docs/html/RestRequestHandler_8h.html | 102 +++ docs/html/RestRequestHandler_8h_source.html | 121 ++++ docs/html/Result_8h.html | 45 +- docs/html/Result_8h_source.html | 120 ++-- docs/html/Serializer_8cpp.html | 98 +++ docs/html/Serializer_8h.html | 98 +++ docs/html/Serializer_8h_source.html | 95 +++ docs/html/SimpleScheduler_8cpp.html | 88 +++ docs/html/SimpleScheduler_8h.html | 104 +++ docs/html/SimpleScheduler_8h_source.html | 149 ++++ docs/html/SpotifyAPITypes_8cpp.html | 89 +++ docs/html/SpotifyAPITypes_8h.html | 141 ++++ docs/html/SpotifyAPITypes_8h_source.html | 318 +++++++++ docs/html/SpotifyAPI_8cpp.html | 90 +++ docs/html/SpotifyAPI_8h.html | 110 +++ docs/html/SpotifyAPI_8h_source.html | 198 ++++++ docs/html/SpotifyAuthorization_8cpp.html | 93 +++ docs/html/SpotifyAuthorization_8h.html | 103 +++ docs/html/SpotifyAuthorization_8h_source.html | 161 +++++ docs/html/SpotifyBackend_8cpp.html | 203 ++++++ docs/html/SpotifyBackend_8h.html | 16 +- docs/html/SpotifyBackend_8h_source.html | 93 ++- docs/html/Tracks_8h.html | 104 +++ docs/html/Tracks_8h_source.html | 127 ++++ docs/html/annotated.html | 49 +- docs/html/classBaseTrack-members.html | 87 +++ docs/html/classBaseTrack.html | 131 ++++ docs/html/classBaseTrack.png | Bin 0 -> 687 bytes docs/html/classConfigHandler-members.html | 5 +- docs/html/classConfigHandler.html | 16 +- docs/html/classDataStore-members.html | 93 +++ docs/html/classDataStore.html | 632 +++++++++++++++++ docs/html/classDataStore.png | Bin 0 -> 490 bytes docs/html/classError-members.html | 4 +- docs/html/classError.html | 14 +- docs/html/classJukeBox-members.html | 11 +- docs/html/classJukeBox.html | 160 ++++- docs/html/classMusicBackend-members.html | 18 +- docs/html/classMusicBackend.html | 337 ++++++++- docs/html/classNetworkAPI-members.html | 1 + docs/html/classNetworkListener-members.html | 11 +- docs/html/classNetworkListener.html | 112 ++- docs/html/classRAMDataStore-members.html | 93 +++ docs/html/classRAMDataStore.html | 633 +++++++++++++++++ docs/html/classRAMDataStore.png | Bin 0 -> 488 bytes docs/html/classRestAPI-members.html | 2 + docs/html/classRestAPI.html | 7 +- .../html/classRestRequestHandler-members.html | 83 +++ docs/html/classRestRequestHandler.html | 117 +++ docs/html/classRestRequestHandler.png | Bin 0 -> 530 bytes docs/html/classSerializer-members.html | 83 +++ docs/html/classSerializer.html | 110 +++ docs/html/classSimpleScheduler-members.html | 85 +++ docs/html/classSimpleScheduler.html | 171 +++++ .../classSpotifyApi_1_1Album-members.html | 94 +++ docs/html/classSpotifyApi_1_1Album.html | 128 ++++ .../classSpotifyApi_1_1Artist-members.html | 90 +++ docs/html/classSpotifyApi_1_1Artist.html | 116 +++ .../classSpotifyApi_1_1Device-members.html | 92 +++ docs/html/classSpotifyApi_1_1Device.html | 122 ++++ .../classSpotifyApi_1_1Devices-members.html | 86 +++ docs/html/classSpotifyApi_1_1Devices.html | 107 +++ .../classSpotifyApi_1_1Image-members.html | 88 +++ docs/html/classSpotifyApi_1_1Image.html | 110 +++ .../classSpotifyApi_1_1Playback-members.html | 93 +++ docs/html/classSpotifyApi_1_1Playback.html | 125 ++++ ...classSpotifyApi_1_1SpotifyAPI-members.html | 95 +++ docs/html/classSpotifyApi_1_1SpotifyAPI.html | 669 ++++++++++++++++++ ...fyApi_1_1SpotifyAuthorization-members.html | 92 +++ ...assSpotifyApi_1_1SpotifyAuthorization.html | 277 ++++++++ ...lassSpotifyApi_1_1SpotifyAuthorization.png | Bin 0 -> 655 bytes ...assSpotifyApi_1_1SpotifyDummy-members.html | 85 +++ .../html/classSpotifyApi_1_1SpotifyDummy.html | 100 +++ ...assSpotifyApi_1_1SpotifyError-members.html | 86 +++ .../html/classSpotifyApi_1_1SpotifyError.html | 107 +++ ...ssSpotifyApi_1_1SpotifyPaging-members.html | 94 +++ .../classSpotifyApi_1_1SpotifyPaging.html | 128 ++++ .../classSpotifyApi_1_1Token-members.html | 91 +++ docs/html/classSpotifyApi_1_1Token.html | 119 ++++ .../classSpotifyApi_1_1Track-members.html | 92 +++ docs/html/classSpotifyApi_1_1Track.html | 122 ++++ docs/html/classSpotifyBackend-members.html | 18 +- docs/html/classSpotifyBackend.html | 372 +++++++++- docs/html/classes.html | 83 ++- .../dir_03ba4c266e378ccffb87dd5fa6a12b43.html | 108 +++ .../dir_0c0333544ec44c57ec7d33d873fe36a2.html | 105 +++ .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 60 +- .../dir_a7363e98f9e0bdd87618633653859815.html | 108 +++ .../dir_a80ba6df1bafd3b08a3ea260be098349.html | 96 +++ .../dir_d5390e4c740f826103ce9bf0b50d1543.html | 87 +++ docs/html/files.html | 67 +- docs/html/functions.html | 209 +++++- docs/html/functions_func.html | 209 +++++- docs/html/globals.html | 8 +- docs/html/globals_func.html | 5 +- docs/html/globals_type.html | 3 - docs/html/hierarchy.html | 48 +- docs/html/main_8cpp.html | 22 +- docs/html/menudata.js | 30 +- docs/html/rest_interface.html | 11 +- docs/html/search/all_0.js | 6 +- docs/html/search/all_1.js | 7 +- docs/html/search/all_10.html | 30 + docs/html/search/all_10.js | 13 + docs/html/search/all_11.html | 30 + docs/html/search/all_11.js | 5 + docs/html/search/all_2.js | 10 +- docs/html/search/all_3.js | 8 +- docs/html/search/all_4.js | 5 +- docs/html/search/all_5.js | 21 +- docs/html/search/all_6.js | 6 +- docs/html/search/all_7.js | 8 +- docs/html/search/all_8.js | 5 +- docs/html/search/all_9.js | 8 +- docs/html/search/all_a.js | 14 +- docs/html/search/all_b.js | 9 +- docs/html/search/all_c.js | 14 +- docs/html/search/all_d.js | 8 +- docs/html/search/all_e.html | 30 + docs/html/search/all_e.js | 21 + docs/html/search/all_f.html | 30 + docs/html/search/all_f.js | 33 + docs/html/search/classes_0.js | 3 +- docs/html/search/classes_1.js | 2 +- docs/html/search/classes_2.js | 2 +- docs/html/search/classes_3.js | 4 +- docs/html/search/classes_4.js | 2 +- docs/html/search/classes_5.js | 3 +- docs/html/search/classes_6.js | 2 +- docs/html/search/classes_7.js | 2 +- docs/html/search/classes_8.js | 4 +- docs/html/search/classes_9.js | 3 +- docs/html/search/classes_a.js | 4 +- docs/html/search/classes_b.html | 30 + docs/html/search/classes_b.js | 8 + docs/html/search/classes_c.html | 30 + docs/html/search/classes_c.js | 11 + docs/html/search/classes_d.html | 30 + docs/html/search/classes_d.js | 5 + docs/html/search/enums_0.js | 2 +- docs/html/search/enums_1.js | 2 +- docs/html/search/enums_2.js | 2 +- docs/html/search/enums_3.html | 30 + docs/html/search/enums_3.js | 4 + docs/html/search/files_0.js | 4 +- docs/html/search/files_1.js | 2 +- docs/html/search/files_2.js | 3 +- docs/html/search/files_3.js | 4 +- docs/html/search/files_4.js | 4 +- docs/html/search/files_5.js | 5 +- docs/html/search/files_6.js | 5 +- docs/html/search/files_7.js | 7 +- docs/html/search/files_8.js | 10 +- docs/html/search/files_9.js | 14 +- docs/html/search/files_a.html | 30 + docs/html/search/files_a.js | 4 + docs/html/search/functions_0.js | 4 +- docs/html/search/functions_1.js | 6 +- docs/html/search/functions_2.js | 19 +- docs/html/search/functions_3.js | 3 +- docs/html/search/functions_4.js | 3 +- docs/html/search/functions_5.js | 2 +- docs/html/search/functions_6.js | 2 +- docs/html/search/functions_7.js | 3 +- docs/html/search/functions_8.html | 30 + docs/html/search/functions_8.js | 4 + docs/html/search/functions_9.html | 30 + docs/html/search/functions_9.js | 6 + docs/html/search/functions_a.html | 30 + docs/html/search/functions_a.js | 13 + docs/html/search/functions_b.html | 30 + docs/html/search/functions_b.js | 4 + docs/html/search/functions_c.html | 30 + docs/html/search/functions_c.js | 4 + docs/html/search/pages_0.js | 2 +- docs/html/search/pages_1.js | 2 +- docs/html/search/pages_2.js | 2 +- docs/html/search/searchdata.js | 12 +- docs/html/search/typedefs_0.js | 7 +- docs/html/structPlaybackTrack-members.html | 89 +++ docs/html/structPlaybackTrack.html | 137 ++++ docs/html/structPlaybackTrack.png | Bin 0 -> 481 bytes docs/html/structQueue-members.html | 80 +++ docs/html/structQueue.html | 96 +++ docs/html/structQueueStatus-members.html | 82 +++ docs/html/structQueueStatus.html | 102 +++ docs/html/structQueuedTrack-members.html | 91 +++ docs/html/structQueuedTrack.html | 144 ++++ docs/html/structQueuedTrack.png | Bin 0 -> 443 bytes .../structRequestInformation-members.html | 83 +++ docs/html/structRequestInformation.html | 105 +++ .../structResponseInformation-members.html | 81 +++ docs/html/structResponseInformation.html | 99 +++ 224 files changed, 14234 insertions(+), 823 deletions(-) create mode 100644 docs/html/DataStore_8h.html create mode 100644 docs/html/DataStore_8h_source.html create mode 100644 docs/html/RAMDataStore_8h.html create mode 100644 docs/html/RAMDataStore_8h_source.html create mode 100644 docs/html/RequestInformation_8h.html create mode 100644 docs/html/RequestInformation_8h_source.html create mode 100644 docs/html/RestEndpointHandlers_8cpp.html create mode 100644 docs/html/RestEndpointHandlers_8h.html create mode 100644 docs/html/RestEndpointHandlers_8h_source.html create mode 100644 docs/html/RestRequestHandler_8cpp.html create mode 100644 docs/html/RestRequestHandler_8h.html create mode 100644 docs/html/RestRequestHandler_8h_source.html create mode 100644 docs/html/Serializer_8cpp.html create mode 100644 docs/html/Serializer_8h.html create mode 100644 docs/html/Serializer_8h_source.html create mode 100644 docs/html/SimpleScheduler_8cpp.html create mode 100644 docs/html/SimpleScheduler_8h.html create mode 100644 docs/html/SimpleScheduler_8h_source.html create mode 100644 docs/html/SpotifyAPITypes_8cpp.html create mode 100644 docs/html/SpotifyAPITypes_8h.html create mode 100644 docs/html/SpotifyAPITypes_8h_source.html create mode 100644 docs/html/SpotifyAPI_8cpp.html create mode 100644 docs/html/SpotifyAPI_8h.html create mode 100644 docs/html/SpotifyAPI_8h_source.html create mode 100644 docs/html/SpotifyAuthorization_8cpp.html create mode 100644 docs/html/SpotifyAuthorization_8h.html create mode 100644 docs/html/SpotifyAuthorization_8h_source.html create mode 100644 docs/html/SpotifyBackend_8cpp.html create mode 100644 docs/html/Tracks_8h.html create mode 100644 docs/html/Tracks_8h_source.html create mode 100644 docs/html/classBaseTrack-members.html create mode 100644 docs/html/classBaseTrack.html create mode 100644 docs/html/classBaseTrack.png create mode 100644 docs/html/classDataStore-members.html create mode 100644 docs/html/classDataStore.html create mode 100644 docs/html/classDataStore.png create mode 100644 docs/html/classRAMDataStore-members.html create mode 100644 docs/html/classRAMDataStore.html create mode 100644 docs/html/classRAMDataStore.png create mode 100644 docs/html/classRestRequestHandler-members.html create mode 100644 docs/html/classRestRequestHandler.html create mode 100644 docs/html/classRestRequestHandler.png create mode 100644 docs/html/classSerializer-members.html create mode 100644 docs/html/classSerializer.html create mode 100644 docs/html/classSimpleScheduler-members.html create mode 100644 docs/html/classSimpleScheduler.html create mode 100644 docs/html/classSpotifyApi_1_1Album-members.html create mode 100644 docs/html/classSpotifyApi_1_1Album.html create mode 100644 docs/html/classSpotifyApi_1_1Artist-members.html create mode 100644 docs/html/classSpotifyApi_1_1Artist.html create mode 100644 docs/html/classSpotifyApi_1_1Device-members.html create mode 100644 docs/html/classSpotifyApi_1_1Device.html create mode 100644 docs/html/classSpotifyApi_1_1Devices-members.html create mode 100644 docs/html/classSpotifyApi_1_1Devices.html create mode 100644 docs/html/classSpotifyApi_1_1Image-members.html create mode 100644 docs/html/classSpotifyApi_1_1Image.html create mode 100644 docs/html/classSpotifyApi_1_1Playback-members.html create mode 100644 docs/html/classSpotifyApi_1_1Playback.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyAPI-members.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyAPI.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyAuthorization-members.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyAuthorization.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyAuthorization.png create mode 100644 docs/html/classSpotifyApi_1_1SpotifyDummy-members.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyDummy.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyError-members.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyError.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyPaging-members.html create mode 100644 docs/html/classSpotifyApi_1_1SpotifyPaging.html create mode 100644 docs/html/classSpotifyApi_1_1Token-members.html create mode 100644 docs/html/classSpotifyApi_1_1Token.html create mode 100644 docs/html/classSpotifyApi_1_1Track-members.html create mode 100644 docs/html/classSpotifyApi_1_1Track.html create mode 100644 docs/html/dir_03ba4c266e378ccffb87dd5fa6a12b43.html create mode 100644 docs/html/dir_0c0333544ec44c57ec7d33d873fe36a2.html create mode 100644 docs/html/dir_a7363e98f9e0bdd87618633653859815.html create mode 100644 docs/html/dir_a80ba6df1bafd3b08a3ea260be098349.html create mode 100644 docs/html/dir_d5390e4c740f826103ce9bf0b50d1543.html create mode 100644 docs/html/search/all_10.html create mode 100644 docs/html/search/all_10.js create mode 100644 docs/html/search/all_11.html create mode 100644 docs/html/search/all_11.js create mode 100644 docs/html/search/all_e.html create mode 100644 docs/html/search/all_e.js create mode 100644 docs/html/search/all_f.html create mode 100644 docs/html/search/all_f.js create mode 100644 docs/html/search/classes_b.html create mode 100644 docs/html/search/classes_b.js create mode 100644 docs/html/search/classes_c.html create mode 100644 docs/html/search/classes_c.js create mode 100644 docs/html/search/classes_d.html create mode 100644 docs/html/search/classes_d.js create mode 100644 docs/html/search/enums_3.html create mode 100644 docs/html/search/enums_3.js create mode 100644 docs/html/search/files_a.html create mode 100644 docs/html/search/files_a.js create mode 100644 docs/html/search/functions_8.html create mode 100644 docs/html/search/functions_8.js create mode 100644 docs/html/search/functions_9.html create mode 100644 docs/html/search/functions_9.js create mode 100644 docs/html/search/functions_a.html create mode 100644 docs/html/search/functions_a.js create mode 100644 docs/html/search/functions_b.html create mode 100644 docs/html/search/functions_b.js create mode 100644 docs/html/search/functions_c.html create mode 100644 docs/html/search/functions_c.js create mode 100644 docs/html/structPlaybackTrack-members.html create mode 100644 docs/html/structPlaybackTrack.html create mode 100644 docs/html/structPlaybackTrack.png create mode 100644 docs/html/structQueue-members.html create mode 100644 docs/html/structQueue.html create mode 100644 docs/html/structQueueStatus-members.html create mode 100644 docs/html/structQueueStatus.html create mode 100644 docs/html/structQueuedTrack-members.html create mode 100644 docs/html/structQueuedTrack.html create mode 100644 docs/html/structQueuedTrack.png create mode 100644 docs/html/structRequestInformation-members.html create mode 100644 docs/html/structRequestInformation.html create mode 100644 docs/html/structResponseInformation-members.html create mode 100644 docs/html/structResponseInformation.html diff --git a/docs/html/ConfigHandler_8cpp.html b/docs/html/ConfigHandler_8cpp.html index 6d0711f..7d3c598 100644 --- a/docs/html/ConfigHandler_8cpp.html +++ b/docs/html/ConfigHandler_8cpp.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/ConfigHandler.cpp File Reference +VirtualJukebox: src/Utils/ConfigHandler.cpp File Reference @@ -61,7 +61,7 @@
@@ -70,12 +70,12 @@
-

Class ConfigHandler implementation. +

Class ConfigHandler implementation. More...

-
#include "ConfigHandler.h"
+
#include "Utils/ConfigHandler.h"
#include <string>

Detailed Description

-

Class ConfigHandler implementation.

+

Class ConfigHandler implementation.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/ConfigHandler_8h.html b/docs/html/ConfigHandler_8h.html index e0e63a7..5257680 100644 --- a/docs/html/ConfigHandler_8h.html +++ b/docs/html/ConfigHandler_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/ConfigHandler.h File Reference +VirtualJukebox: src/Utils/ConfigHandler.h File Reference @@ -61,7 +61,7 @@
@@ -72,23 +72,24 @@
-

Class ConfigHandler definition. +

Class ConfigHandler definition. More...

#include <stdlib.h>
#include <memory>
#include <string>
#include "../lib/SimpleIni/SimpleIni.h"
-#include "Result.h"
+#include "Types/Result.h"

Go to the source code of this file.

+

Classes

class  ConfigHandler
 Singleton class which provides shared access to the configuration file used. More...
 

Detailed Description

-

Class ConfigHandler definition.

+

Class ConfigHandler definition.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/ConfigHandler_8h_source.html b/docs/html/ConfigHandler_8h_source.html index 86f7d01..8de1c02 100644 --- a/docs/html/ConfigHandler_8h_source.html +++ b/docs/html/ConfigHandler_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/ConfigHandler.h Source File +VirtualJukebox: src/Utils/ConfigHandler.h Source File @@ -61,7 +61,7 @@
@@ -81,38 +81,40 @@
15 #include <string>
16 
17 #include "../lib/SimpleIni/SimpleIni.h"
-
18 #include "Result.h"
+
18 #include "Types/Result.h"
19 
-
20 class ConfigHandler {
-
21  public:
-
22  ~ConfigHandler() = default;
-
23  static std::shared_ptr<ConfigHandler> const getInstance();
-
24 
-
25  TResultOpt setConfigFilePath(std::string const& filepath);
-
26  TResult<std::string> getValueString(std::string const& section,
-
27  std::string const& key);
-
28  TResult<int> getValueInt(std::string const& section, std::string const& key);
-
29 
-
30  private:
-
31  ConfigHandler() = default; // hide default ctor
-
32  ConfigHandler(ConfigHandler const&) = delete; // delete copy ctor
-
33  ConfigHandler& operator=(ConfigHandler const&) = delete; // assignment ctor
+
24 class ConfigHandler {
+
25  public:
+
26  ~ConfigHandler() = default;
+
27  static std::shared_ptr<ConfigHandler> const getInstance();
+
28 
+
29  TResultOpt setConfigFilePath(std::string const& filepath);
+
30  TResult<std::string> getValueString(std::string const& section,
+
31  std::string const& key);
+
32  TResult<int> getValueInt(std::string const& section, std::string const& key);
+
33  bool isInitialized();
34 
-
35  static std::shared_ptr<ConfigHandler> mInstance;
-
36  std::string mConfigFilePath;
-
37 
-
38  CSimpleIniA mIni;
-
39 };
-
40 
-
41 #endif /* _CONFIGHANDLER_H_ */
+
35  private:
+
36  ConfigHandler() = default; // hide default ctor
+
37  ConfigHandler(ConfigHandler const&) = delete; // delete copy ctor
+
38  ConfigHandler& operator=(ConfigHandler const&) = delete; // assignment ctor
+
39 
+
40  static std::shared_ptr<ConfigHandler> mInstance;
+
41  std::string mConfigFilePath;
+
42 
+
43  CSimpleIniA mIni;
+
44  bool mIsInitialized = false;
+
45 };
+
46 
+
47 #endif /* _CONFIGHANDLER_H_ */
-
ConfigHandler
Definition: ConfigHandler.h:20
-
ConfigHandler::getValueString
TResult< std::string > getValueString(std::string const &section, std::string const &key)
Returns value of a key as a string.
Definition: ConfigHandler.cpp:42
+
ConfigHandler
Singleton class which provides shared access to the configuration file used.
Definition: ConfigHandler.h:24
+
ConfigHandler::getValueString
TResult< std::string > getValueString(std::string const &section, std::string const &key)
Returns value of a key as a string.
Definition: ConfigHandler.cpp:45
Result.h
Defines function return values and types.
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
-
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
ConfigHandler::setConfigFilePath
TResultOpt setConfigFilePath(std::string const &filepath)
Configures file path to *.ini file, configures the SimpleIni reader and loads the ini-file.
Definition: ConfigHandler.cpp:27
-
ConfigHandler::getValueInt
TResult< int > getValueInt(std::string const &section, std::string const &key)
Returns value of a key as integer.
Definition: ConfigHandler.cpp:62
+
ConfigHandler::getValueInt
TResult< int > getValueInt(std::string const &section, std::string const &key)
Returns value of a key as integer.
Definition: ConfigHandler.cpp:70
Generated by   diff --git a/docs/html/DataStore_8h.html b/docs/html/DataStore_8h.html new file mode 100644 index 0000000..cb11ba7 --- /dev/null +++ b/docs/html/DataStore_8h.html @@ -0,0 +1,102 @@ + + + + + + + +VirtualJukebox: src/DataStore.h File Reference + + + + + + + + + + +
+
+Classes
+
+
DataStore.h File Reference
+
+
+ +

Class DataStore definition. +More...

+
#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+#include "Types/Result.h"
+#include "Types/Tracks.h"
+#include "Types/User.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  DataStore
 Interface for storing Data such as Tracks, Users, Votes, etc. More...
 
+

Detailed Description

+

Class DataStore definition.

+
Author
Samuel Hick samue.nosp@m.l.hi.nosp@m.ck@gm.nosp@m.x.at
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/DataStore_8h_source.html b/docs/html/DataStore_8h_source.html new file mode 100644 index 0000000..afebc90 --- /dev/null +++ b/docs/html/DataStore_8h_source.html @@ -0,0 +1,151 @@ + + + + + + + +VirtualJukebox: src/DataStore.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
DataStore.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef _DATASTORE_H_
+
10 #define _DATASTORE_H_
+
11 
+
12 #include "Types/GlobalTypes.h"
+
13 #include "Types/Queue.h"
+
14 #include "Types/Result.h"
+
15 #include "Types/Tracks.h"
+
16 #include "Types/User.h"
+
17 
+
22 class DataStore {
+
23  public:
+
24  virtual ~DataStore() {
+
25  }
+
26 
+
32  virtual TResultOpt addUser(User const &user) = 0;
+
33 
+
39  virtual TResult<User> getUser(TSessionID const &sID) = 0;
+
40 
+
47  virtual TResult<User> removeUser(TSessionID const &sID) = 0;
+
48 
+
55  virtual TResult<bool> isSessionExpired(TSessionID const &sID) = 0;
+
56 
+
64  virtual TResultOpt addTrack(BaseTrack const &track, QueueType q) = 0;
+
65 
+
73  virtual TResult<BaseTrack> removeTrack(TTrackID const &tID, QueueType q) = 0;
+
74 
+
82  virtual TResult<bool> hasTrack(TTrackID const &tID, QueueType q) = 0;
+
83 
+
92  virtual TResultOpt voteTrack(TSessionID const &sID,
+
93  TTrackID const &tID,
+
94  TVote vote) = 0;
+
95 
+
102  virtual TResult<Queue> getQueue(QueueType q) = 0;
+
103 
+
108  virtual TResult<std::optional<QueuedTrack>> getPlayingTrack() = 0;
+
109 
+
115  virtual bool hasUser(TSessionID const &sID) = 0;
+
116 
+
121  virtual TResultOpt nextTrack() = 0;
+
122 
+
123  static unsigned const cSessionTimeoutAfterSeconds = 3600;
+
124 };
+
125 
+
126 #endif /* _DATASTORE_H_ */
+
+
DataStore::nextTrack
virtual TResultOpt nextTrack()=0
Play next Track in Queue.
+
GlobalTypes.h
Defines types and constants that are used globally.
+
DataStore::removeTrack
virtual TResult< BaseTrack > removeTrack(TTrackID const &tID, QueueType q)=0
Remove Track from one of the internal Queues.
+
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
+
DataStore
Interface for storing Data such as Tracks, Users, Votes, etc.
Definition: DataStore.h:22
+
DataStore::addTrack
virtual TResultOpt addTrack(BaseTrack const &track, QueueType q)=0
Add Track to one of the internal Queues.
+
Result.h
Defines function return values and types.
+
DataStore::hasTrack
virtual TResult< bool > hasTrack(TTrackID const &tID, QueueType q)=0
Check for Track in one of the internal Queues.
+
TVote
bool TVote
Vote type.
Definition: GlobalTypes.h:27
+
QueueType
QueueType
Queue type enumerator.
Definition: GlobalTypes.h:17
+
TSessionID
std::string TSessionID
Session ID type.
Definition: GlobalTypes.h:32
+
Queue.h
Class Queue definition.
+
DataStore::hasUser
virtual bool hasUser(TSessionID const &sID)=0
Query the internal user list whether a certain user exists.
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
DataStore::voteTrack
virtual TResultOpt voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote)=0
Upvote/remove Upvote from a track.
+
DataStore::getQueue
virtual TResult< Queue > getQueue(QueueType q)=0
Get entire Queue.
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
DataStore::getPlayingTrack
virtual TResult< std::optional< QueuedTrack > > getPlayingTrack()=0
Get the currently playing track.
+
BaseTrack
The most basic representation of a track.
Definition: Tracks.h:17
+
DataStore::isSessionExpired
virtual TResult< bool > isSessionExpired(TSessionID const &sID)=0
Check if user session is expired.
+
DataStore::addUser
virtual TResultOpt addUser(User const &user)=0
Add a User to the internal List of registered Users.
+
DataStore::removeUser
virtual TResult< User > removeUser(TSessionID const &sID)=0
Remove a User from the internal List of registered Users. Does not remove votes taken by this user fr...
+
Tracks.h
Definitions of all track related structs.
+
DataStore::getUser
virtual TResult< User > getUser(TSessionID const &sID)=0
Get a User from the internal List of registered Users.
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/GlobalTypes_8h.html b/docs/html/GlobalTypes_8h.html index 0877cdb..f28d48c 100644 --- a/docs/html/GlobalTypes_8h.html +++ b/docs/html/GlobalTypes_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/GlobalTypes.h File Reference +VirtualJukebox: src/Types/GlobalTypes.h File Reference @@ -61,7 +61,7 @@
@@ -91,7 +91,7 @@   using TTrackID = std::string - Track ID type.
+ Track ID type.
  using TPassword = std::string @@ -103,7 +103,7 @@ enum  QueueType { Admin, Normal } - Queue type enumerator.
+ Queue type enumerator.
  enum  PlayerAction {
  Play, diff --git a/docs/html/GlobalTypes_8h_source.html b/docs/html/GlobalTypes_8h_source.html index 7fee124..99701a9 100644 --- a/docs/html/GlobalTypes_8h_source.html +++ b/docs/html/GlobalTypes_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/GlobalTypes.h Source File +VirtualJukebox: src/Types/GlobalTypes.h Source File @@ -61,7 +61,7 @@
diff --git a/docs/html/JukeBox_8cpp.html b/docs/html/JukeBox_8cpp.html index e8805b2..a2b79fe 100644 --- a/docs/html/JukeBox_8cpp.html +++ b/docs/html/JukeBox_8cpp.html @@ -70,16 +70,19 @@
-

Class JukeBox implementation. +

Class JukeBox implementation. More...

#include "JukeBox.h"
-#include <iostream>
+#include <ctime>
#include <memory>
-#include "ConfigHandler.h"
-#include "GlobalTypes.h"
-#include "Result.h"
+#include "Datastore/RAMDataStore.h"
+#include "Network/RestAPI.h"
+#include "Spotify/SpotifyBackend.h"
+#include "Types/User.h"
+#include "Utils/ConfigHandler.h"
+#include "Utils/LoggingHandler.h"

Detailed Description

-

Class JukeBox implementation.

+

Class JukeBox implementation.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/JukeBox_8h.html b/docs/html/JukeBox_8h.html index a6250c3..b6e8ad0 100644 --- a/docs/html/JukeBox_8h.html +++ b/docs/html/JukeBox_8h.html @@ -72,26 +72,30 @@
-

Class JukeBox definition. +

Class JukeBox definition. More...

#include <string>
#include <variant>
#include <vector>
-#include "GlobalTypes.h"
+#include "DataStore.h"
+#include "MusicBackend.h"
+#include "NetworkAPI.h"
#include "NetworkListener.h"
-#include "Queue.h"
-#include "Result.h"
-#include "Track.h"
+#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+#include "Types/Result.h"
+#include "Utils/SimpleScheduler.h"

Go to the source code of this file.

+

Classes

class  JukeBox
 Core class which combines all interface implementations in a working server application. More...
 

Detailed Description

-

Class JukeBox definition.

+

Class JukeBox definition.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/JukeBox_8h_source.html b/docs/html/JukeBox_8h_source.html index 778b89e..8c8839c 100644 --- a/docs/html/JukeBox_8h_source.html +++ b/docs/html/JukeBox_8h_source.html @@ -79,71 +79,80 @@
13 #include <variant>
14 #include <vector>
15 
-
16 #include "GlobalTypes.h"
-
17 #include "NetworkListener.h"
-
18 #include "Queue.h"
-
19 #include "Result.h"
-
20 #include "Track.h"
-
21 
-
22 //#include "ConfigHandler.h"
-
23 //#include "LoggingHandler.h"
-
24 //#include "DataStore.h"
-
25 //#include "MusicBackend.h"
-
26 //#include "NetworkAPI.h"
-
27 //#include "User.h"
-
28 
-
29 class JukeBox : public NetworkListener {
-
30  public:
-
31  void start(std::string configFilePath);
-
32 
-
33  TResult<TSessionID> generateSession(TPassword const &pw) override;
-
34  TResult<std::vector<Track>> queryTracks(std::string const &searchPattern,
-
35  size_t const nrOfEntries) override;
-
36  // TResult<QueueStatus> getCurrentQueues();
-
37  TResultOpt addTrackToQueue(TSessionID const &sid,
-
38  TTrackID const &trkid,
-
39  QueueType type) override;
-
40  TResultOpt voteTrack(TSessionID const &sid,
-
41  TTrackID const &trkid,
-
42  TVote vote) override;
-
43  TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid) override;
-
44  TResultOpt moveTrack(TSessionID const &sid,
-
45  TTrackID const &trkid,
-
46  QueueType type) override;
-
47  TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action) override;
+
16 #include "DataStore.h"
+
17 #include "MusicBackend.h"
+
18 #include "NetworkAPI.h"
+
19 #include "NetworkListener.h"
+
20 #include "Types/GlobalTypes.h"
+
21 #include "Types/Queue.h"
+
22 #include "Types/Result.h"
+
23 #include "Utils/SimpleScheduler.h"
+
24 
+
33 class JukeBox : public NetworkListener {
+
34  public:
+
35  JukeBox();
+
36  ~JukeBox();
+
37 
+
47  bool start(std::string const &exeName, std::string const &configFilePath);
48 
-
49  private:
-
50  // LoggingHandler mLog;
-
51  // ConfigHandler mConfigHandler;
-
52  // DataStore mDataStore;
-
53  // NetworkAPI mNetwork;
-
54  // MusicBackend mMusicBackend;
-
55 };
-
56 
-
57 #endif /* _JUKEBOX_H_ */
+
49  public: // needs to be public for tests only!
+
53  TResult<TSessionID> generateSession(
+
54  std::optional<TPassword> const &pw,
+
55  std::optional<std::string> const &nickname) override;
+
56  TResult<std::vector<BaseTrack>> queryTracks(
+
57  std::string const &searchPattern, size_t const nrOfEntries) override;
+
58  TResult<QueueStatus> getCurrentQueues(TSessionID const &sid);
+
59  TResultOpt addTrackToQueue(TSessionID const &sid,
+
60  TTrackID const &trkid,
+
61  QueueType type) override;
+
62  TResultOpt voteTrack(TSessionID const &sid,
+
63  TTrackID const &trkid,
+
64  TVote vote) override;
+
65  TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid) override;
+
66  TResultOpt moveTrack(TSessionID const &sid,
+
67  TTrackID const &trkid,
+
68  QueueType toQueue) override;
+
69  TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action) override;
+
70 
+
71  private:
+
72  DataStore *mDataStore;
+
73  NetworkAPI *mNetwork;
+
74  MusicBackend *mMusicBackend;
+
75  SimpleScheduler *mScheduler;
+
76 };
+
77 
+
78 #endif /* _JUKEBOX_H_ */
GlobalTypes.h
Defines types and constants that are used globally.
-
JukeBox::voteTrack
TResultOpt voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote) override
Vote for a track or revoke a vote.
Definition: JukeBox.cpp:50
-
JukeBox::queryTracks
TResult< std::vector< Track > > queryTracks(std::string const &searchPattern, size_t const nrOfEntries) override
Query available tracks using different music backends.
Definition: JukeBox.cpp:34
+
DataStore.h
Class DataStore definition.
+
NetworkAPI.h
Definition of class NetworkAPI.
+
JukeBox::voteTrack
TResultOpt voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote) override
Vote for a track or revoke a vote.
Definition: JukeBox.cpp:262
+
JukeBox::getCurrentQueues
TResult< QueueStatus > getCurrentQueues(TSessionID const &sid)
Query the content of the current queues.
Definition: JukeBox.cpp:136
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
-
JukeBox::controlPlayer
TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action) override
Controls the behaviour of the music player.
Definition: JukeBox.cpp:66
-
TPassword
std::string TPassword
Password type.
Definition: GlobalTypes.h:42
+
JukeBox::controlPlayer
TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action) override
Controls the behaviour of the music player.
Definition: JukeBox.cpp:364
+
DataStore
Interface for storing Data such as Tracks, Users, Votes, etc.
Definition: DataStore.h:22
+
JukeBox::moveTrack
TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue) override
Move a track between queues.
Definition: JukeBox.cpp:322
+
MusicBackend
Provides an abstracted interface to a MusicBackend s.
Definition: MusicBackend.h:22
+
MusicBackend.h
Interface for MusicBackend.
Result.h
Defines function return values and types.
+
NetworkAPI
Base class for all implementations of network interfaces.
Definition: NetworkAPI.h:21
+
JukeBox::queryTracks
TResult< std::vector< BaseTrack > > queryTracks(std::string const &searchPattern, size_t const nrOfEntries) override
Query available tracks using different music backends.
Definition: JukeBox.cpp:130
TVote
bool TVote
Vote type.
Definition: GlobalTypes.h:27
PlayerAction
PlayerAction
Player action type enumerator.
Definition: GlobalTypes.h:22
QueueType
QueueType
Queue type enumerator.
Definition: GlobalTypes.h:17
-
JukeBox::moveTrack
TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type) override
Move a track between queues.
Definition: JukeBox.cpp:60
-
JukeBox::removeTrack
TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid) override
Remove a track from a queue.
Definition: JukeBox.cpp:56
+
JukeBox::removeTrack
TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid) override
Remove a track from a queue.
Definition: JukeBox.cpp:272
+
JukeBox::start
bool start(std::string const &exeName, std::string const &configFilePath)
Initializes ConfigHandler, LoggingHandler as well as the MusicBackend.
Definition: JukeBox.cpp:41
+
SimpleScheduler
A simple track scheduler (for presentation purposes).
Definition: SimpleScheduler.h:24
TSessionID
std::string TSessionID
Session ID type.
Definition: GlobalTypes.h:32
-
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:34
+
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
Queue.h
Class Queue definition.
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
-
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
-
JukeBox
Definition: JukeBox.h:29
-
JukeBox::addTrackToQueue
TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type) override
Querie the content of the current queues.
Definition: JukeBox.cpp:44
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
JukeBox
Core class which combines all interface implementations in a working server application.
Definition: JukeBox.h:33
+
SimpleScheduler.h
Class SimpleScheduler definition.
+
JukeBox::addTrackToQueue
TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type) override
Add a track to a given queue (normal or admin).
Definition: JukeBox.cpp:234
+
JukeBox::generateSession
TResult< TSessionID > generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname) override
Definition: JukeBox.cpp:87
NetworkListener.h
Interface Class NetworkListener definition.
-
JukeBox::generateSession
TResult< TSessionID > generateSession(TPassword const &pw) override
Generate a session for an user.
Definition: JukeBox.cpp:26
-
Track.h
Class Track definition.
Generated by   diff --git a/docs/html/LoggingHandler_8cpp.html b/docs/html/LoggingHandler_8cpp.html index ac38525..5d9fdf0 100644 --- a/docs/html/LoggingHandler_8cpp.html +++ b/docs/html/LoggingHandler_8cpp.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/LoggingHandler.cpp File Reference +VirtualJukebox: src/Utils/LoggingHandler.cpp File Reference @@ -61,21 +61,32 @@
+
+Functions
LoggingHandler.cpp File Reference
-

Class LoggingHandler implementation. +

LoggingHandler implementation. More...

-
#include "LoggingHandler.h"
-#include <iostream>
-

Detailed Description

-

Class LoggingHandler implementation.

+
#include "Utils/LoggingHandler.h"
+#include <glog/logging.h>
+#include <string>
+#include "Utils/ConfigHandler.h"
+
+ + + +

+Functions

+void initLoggingHandler (string const &exe)
 
+

Detailed Description

+

LoggingHandler implementation.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/LoggingHandler_8h.html b/docs/html/LoggingHandler_8h.html index 69169ee..2168560 100644 --- a/docs/html/LoggingHandler_8h.html +++ b/docs/html/LoggingHandler_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/LoggingHandler.h File Reference +VirtualJukebox: src/Utils/LoggingHandler.h File Reference @@ -61,30 +61,31 @@
-Classes
+Functions
LoggingHandler.h File Reference
-

Class LoggingHandler definition. +

LoggingHandler header file. More...

#include <string>

Go to the source code of this file.

- - - + + +

-Classes

class  LoggingHandler
 

+Functions

+void initLoggingHandler (std::string const &exe)
 

Detailed Description

-

Class LoggingHandler definition.

+

LoggingHandler header file.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/LoggingHandler_8h_source.html b/docs/html/LoggingHandler_8h_source.html index b8b7647..fcd28c5 100644 --- a/docs/html/LoggingHandler_8h_source.html +++ b/docs/html/LoggingHandler_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/LoggingHandler.h Source File +VirtualJukebox: src/Utils/LoggingHandler.h Source File @@ -61,7 +61,7 @@
@@ -72,20 +72,24 @@ Go to the documentation of this file.
1 /*****************************************************************************/
7 /*****************************************************************************/
8 
-
9 #ifndef _LoggingHandler_H_
-
10 #define _LoggingHandler_H_
+
9 #ifndef _LOGGINGHANDLER_H_
+
10 #define _LOGGINGHANDLER_H_
11 
12 #include <string>
13 
-
14 class LoggingHandler {
-
15  public:
-
16  void logInfo(std::string msg);
-
17  void logError(std::string msg);
-
18 };
-
19 
-
20 #endif /* _LoggingHandler_H_ */
+
14 void initLoggingHandler(std::string const& exe);
+
15 
+
16 /* Usage for Google Log messages:
+
17  *
+
18  * DLOG(INFO) << "Logging a DEBUG message!";
+
19  * LOG(INFO) << "Logging an INFO message!";
+
20  * LOG(WARNING) << "Logging a WARNING message!";
+
21  * LOG(ERROR) << "Logging an ERROR message!";
+
22  *
+
23  */
+
24 
+
25 #endif /* _LOGGINGHANDLER_H_ */
-
LoggingHandler
Definition: LoggingHandler.h:14
Generated by   diff --git a/docs/html/MusicBackend_8h.html b/docs/html/MusicBackend_8h.html index 1dc1ea2..d47a7a0 100644 --- a/docs/html/MusicBackend_8h.html +++ b/docs/html/MusicBackend_8h.html @@ -72,25 +72,24 @@
-

Interface for MusicBackends. +

Interface for MusicBackend. More...

#include <memory>
#include <vector>
-#include "GlobalTypes.h"
-#include "PlaybackTrack.h"
-#include "Queue.h"
-#include "Result.h"
-#include "Track.h"
+#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+#include "Types/Result.h"

Go to the source code of this file.

+

Classes

class  MusicBackend
 Provides an abstracted interface to a MusicBackend s. More...
 

Detailed Description

-

Interface for MusicBackends.

+

Interface for MusicBackend.

Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/MusicBackend_8h_source.html b/docs/html/MusicBackend_8h_source.html index ee83127..e87bcdb 100644 --- a/docs/html/MusicBackend_8h_source.html +++ b/docs/html/MusicBackend_8h_source.html @@ -78,35 +78,54 @@
12 #include <memory>
13 #include <vector>
14 
-
15 #include "GlobalTypes.h"
-
16 #include "PlaybackTrack.h"
-
17 #include "Queue.h"
-
18 #include "Result.h"
-
19 #include "Track.h"
-
20 
-
21 class MusicBackend {
-
22  public:
-
23  virtual TResultOpt initBackend(void) = 0;
-
24  virtual TResult<std::vector<Track>> queryTracks(std::string const &pattern,
-
25  size_t const num) = 0;
-
26  virtual TResultOpt setPlayback(Track const &track) = 0;
-
27  virtual TResult<PlaybackTrack> getCurrentPlayback(void) = 0;
-
28  virtual TResultOpt pause(void) = 0;
-
29  virtual TResultOpt play() = 0;
-
30  virtual TResult<size_t> getVolume(void) = 0;
-
31  virtual TResultOpt setVolume(size_t const percent) = 0;
-
32 };
-
33 
-
34 #endif /* _MUSICBACKEND_H_ */
+
15 #include "Types/GlobalTypes.h"
+
16 #include "Types/Queue.h"
+
17 #include "Types/Result.h"
+
18 
+
22 class MusicBackend {
+
23  public:
+
24  virtual ~MusicBackend() {
+
25  }
+
26 
+
30  virtual TResultOpt initBackend() = 0;
+
31 
+
38  virtual TResult<std::vector<BaseTrack>> queryTracks(
+
39  std::string const &pattern, size_t const num) = 0;
+
40 
+
46  virtual TResultOpt setPlayback(BaseTrack const &track) = 0;
+
47 
+
54  virtual TResult<std::optional<PlaybackTrack>> getCurrentPlayback() = 0;
+
55 
+
60  virtual TResultOpt pause() = 0;
+
61 
+
66  virtual TResultOpt play() = 0;
+
67 
+
72  virtual TResult<size_t> getVolume() = 0;
+
73 
+
81  virtual TResultOpt setVolume(size_t const percent) = 0;
+
82 
+
88  virtual TResult<BaseTrack> createBaseTrack(TTrackID const &trackID) = 0;
+
89 };
+
90 
+
91 #endif /* _MUSICBACKEND_H_ */
GlobalTypes.h
Defines types and constants that are used globally.
-
Track
Definition: Track.h:12
-
MusicBackend
Definition: MusicBackend.h:21
+
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
+
MusicBackend::setVolume
virtual TResultOpt setVolume(size_t const percent)=0
Sets a new volume.
+
MusicBackend
Provides an abstracted interface to a MusicBackend s.
Definition: MusicBackend.h:22
+
MusicBackend::createBaseTrack
virtual TResult< BaseTrack > createBaseTrack(TTrackID const &trackID)=0
Creates a new BaseTrack instance with the given trackID.
+
MusicBackend::queryTracks
virtual TResult< std::vector< BaseTrack > > queryTracks(std::string const &pattern, size_t const num)=0
Queries the backend for all tracks given a pattern.
Result.h
Defines function return values and types.
+
MusicBackend::pause
virtual TResultOpt pause()=0
Pauses the current playback.
+
MusicBackend::getCurrentPlayback
virtual TResult< std::optional< PlaybackTrack > > getCurrentPlayback()=0
Returns the current playback of the active device as a playback track.
Queue.h
Class Queue definition.
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
-
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
-
Track.h
Class Track definition.
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
MusicBackend::setPlayback
virtual TResultOpt setPlayback(BaseTrack const &track)=0
Set the given track as playback (means the track gets played).
+
MusicBackend::getVolume
virtual TResult< size_t > getVolume()=0
Returns the volume of the actual device in percent.
+
BaseTrack
The most basic representation of a track.
Definition: Tracks.h:17
+
MusicBackend::initBackend
virtual TResultOpt initBackend()=0
Initalizes the backend.
+
MusicBackend::play
virtual TResultOpt play()=0
Resumes the current playback.
Generated by   diff --git a/docs/html/NetworkAPI_8h_source.html b/docs/html/NetworkAPI_8h_source.html index ef1ccd6..09a4d09 100644 --- a/docs/html/NetworkAPI_8h_source.html +++ b/docs/html/NetworkAPI_8h_source.html @@ -80,24 +80,26 @@
21 class NetworkAPI {
22  public:
23  NetworkAPI();
-
24 
-
25  void setListener(NetworkListener *);
-
26  virtual TResultOpt handleRequests() = 0;
-
27 
-
28  private:
-
29  // dont allow copying
-
30  NetworkAPI(NetworkAPI const &) = delete;
-
31  NetworkAPI &operator=(NetworkAPI const &) = delete;
-
32 
-
33  protected:
-
34  NetworkListener *listener;
-
35 };
-
36 
-
37 #endif /* _NETWORK_API_H_ */
+
24  virtual ~NetworkAPI() {
+
25  }
+
26 
+
27  void setListener(NetworkListener *);
+
28  virtual TResultOpt handleRequests() = 0;
+
29 
+
30  private:
+
31  // dont allow copying
+
32  NetworkAPI(NetworkAPI const &) = delete;
+
33  NetworkAPI &operator=(NetworkAPI const &) = delete;
+
34 
+
35  protected:
+
36  NetworkListener *listener;
+
37 };
+
38 
+
39 #endif /* _NETWORK_API_H_ */
NetworkAPI
Base class for all implementations of network interfaces.
Definition: NetworkAPI.h:21
-
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:34
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
+
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
NetworkListener.h
Interface Class NetworkListener definition.
diff --git a/docs/html/NetworkListener_8h.html b/docs/html/NetworkListener_8h.html index 1f86d57..edbaba8 100644 --- a/docs/html/NetworkListener_8h.html +++ b/docs/html/NetworkListener_8h.html @@ -66,8 +66,7 @@
-Classes | -Typedefs
+Classes
NetworkListener.h File Reference
@@ -78,10 +77,9 @@
#include <string>
#include <variant>
#include <vector>
-#include "GlobalTypes.h"
-#include "Queue.h"
-#include "Result.h"
-#include "Track.h"
+#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+#include "Types/Result.h"

Go to the source code of this file.

@@ -90,13 +88,6 @@ -
class  NetworkListener
 Provides interface methods for all supported requests. More...
 
- - - -

-Typedefs

-using Queues = Queue
 Type for multiple queues.
 

Detailed Description

Interface Class NetworkListener definition.

diff --git a/docs/html/NetworkListener_8h_source.html b/docs/html/NetworkListener_8h_source.html index 63c2d1e..2a6d3df 100644 --- a/docs/html/NetworkListener_8h_source.html +++ b/docs/html/NetworkListener_8h_source.html @@ -79,67 +79,61 @@
13 #include <variant>
14 #include <vector>
15 
-
16 #include "GlobalTypes.h"
-
17 #include "Queue.h"
-
18 #include "Result.h"
-
19 #include "Track.h"
-
20 
-
21 //#include "LoggingHandler.h"
-
22 //#include "NetworkAPI.h"
-
23 
-
27 using Queues = Queue;
-
28 
-
34 class NetworkListener {
-
35  public:
-
43  virtual TResult<TSessionID> generateSession(TPassword const &pw) = 0;
-
44 
-
53  virtual TResult<std::vector<Track>> queryTracks(
-
54  std::string const &searchPattern, size_t const nrOfEntries) = 0;
-
55 
-
64  // virtual TResult<QueueStatus> getCurrentQueues() = 0;
-
65 
-
82  virtual TResultOpt addTrackToQueue(TSessionID const &sid,
-
83  TTrackID const &trkid,
-
84  QueueType type) = 0;
-
85 
-
102  virtual TResultOpt voteTrack(TSessionID const &sid,
-
103  TTrackID const &trkid,
-
104  TVote vote) = 0;
-
105 
-
120  virtual TResultOpt controlPlayer(TSessionID const &sid,
-
121  PlayerAction action) = 0;
-
122 
-
137  virtual TResultOpt removeTrack(TSessionID const &sid,
-
138  TTrackID const &trkid) = 0;
-
139 
-
156  virtual TResultOpt moveTrack(TSessionID const &sid,
-
157  TTrackID const &trkid,
-
158  QueueType type) = 0;
-
159 };
-
160 
-
161 #endif /* _NETWORKLISTENER_H_ */
+
16 #include "Types/GlobalTypes.h"
+
17 #include "Types/Queue.h"
+
18 #include "Types/Result.h"
+
19 
+
25 class NetworkListener {
+
26  public:
+
34  virtual TResult<TSessionID> generateSession(
+
35  std::optional<TPassword> const &pw,
+
36  std::optional<std::string> const &nickname) = 0;
+
37 
+
46  virtual TResult<std::vector<BaseTrack>> queryTracks(
+
47  std::string const &searchPattern, size_t const nrOfEntries) = 0;
+
48 
+
60  virtual TResult<QueueStatus> getCurrentQueues(TSessionID const &sid) = 0;
+
61 
+
78  virtual TResultOpt addTrackToQueue(TSessionID const &sid,
+
79  TTrackID const &trkid,
+
80  QueueType type) = 0;
+
81 
+
97  virtual TResultOpt voteTrack(TSessionID const &sid,
+
98  TTrackID const &trkid,
+
99  TVote vote) = 0;
+
100 
+
115  virtual TResultOpt controlPlayer(TSessionID const &sid,
+
116  PlayerAction action) = 0;
+
117 
+
132  virtual TResultOpt removeTrack(TSessionID const &sid,
+
133  TTrackID const &trkid) = 0;
+
134 
+
151  virtual TResultOpt moveTrack(TSessionID const &sid,
+
152  TTrackID const &trkid,
+
153  QueueType toQueue) = 0;
+
154 };
+
155 
+
156 #endif /* _NETWORKLISTENER_H_ */
GlobalTypes.h
Defines types and constants that are used globally.
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
-
TPassword
std::string TPassword
Password type.
Definition: GlobalTypes.h:42
+
NetworkListener::getCurrentQueues
virtual TResult< QueueStatus > getCurrentQueues(TSessionID const &sid)=0
Query the content of the current queues.
Result.h
Defines function return values and types.
-
NetworkListener::addTrackToQueue
virtual TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
Querie the content of the current queues.
+
NetworkListener::addTrackToQueue
virtual TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
Add a track to a given queue (normal or admin).
NetworkListener::removeTrack
virtual TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid)=0
Remove a track from a queue.
+
NetworkListener::generateSession
virtual TResult< TSessionID > generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname)=0
Generate a session for an user.
NetworkListener::voteTrack
virtual TResultOpt voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0
Vote for a track or revoke a vote.
-
NetworkListener::moveTrack
virtual TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
Move a track between queues.
TVote
bool TVote
Vote type.
Definition: GlobalTypes.h:27
PlayerAction
PlayerAction
Player action type enumerator.
Definition: GlobalTypes.h:22
QueueType
QueueType
Queue type enumerator.
Definition: GlobalTypes.h:17
TSessionID
std::string TSessionID
Session ID type.
Definition: GlobalTypes.h:32
-
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:34
+
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
Queue.h
Class Queue definition.
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
-
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
-
NetworkListener::generateSession
virtual TResult< TSessionID > generateSession(TPassword const &pw)=0
Generate a session for an user.
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
NetworkListener::queryTracks
virtual TResult< std::vector< BaseTrack > > queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0
Query available tracks using different music backends.
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
NetworkListener::controlPlayer
virtual TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action)=0
Controls the behaviour of the music player.
-
Queue
Definition: Queue.h:12
-
NetworkListener::queryTracks
virtual TResult< std::vector< Track > > queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0
Query available tracks using different music backends.
-
Track.h
Class Track definition.
+
NetworkListener::moveTrack
virtual TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue)=0
Move a track between queues.
Generated by   diff --git a/docs/html/Queue_8h.html b/docs/html/Queue_8h.html index 5bc3823..07ad862 100644 --- a/docs/html/Queue_8h.html +++ b/docs/html/Queue_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/Queue.h File Reference +VirtualJukebox: src/Types/Queue.h File Reference @@ -61,7 +61,7 @@
@@ -72,18 +72,25 @@
-

Class Queue definition. +

Class Queue definition. More...

- +
#include <optional>
+#include <vector>
+#include "Tracks.h"
+

Go to the source code of this file.

- + + + + +

Classes

class  Queue
struct  Queue
 Respresents a queue which is returned to the clients. More...
 
struct  QueueStatus
 Wraps all information to return if a client requests the current queue status. More...
 

Detailed Description

-

Class Queue definition.

+

Class Queue definition.

Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
diff --git a/docs/html/Queue_8h_source.html b/docs/html/Queue_8h_source.html index 4c2b4b8..7a88fa7 100644 --- a/docs/html/Queue_8h_source.html +++ b/docs/html/Queue_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/Queue.h Source File +VirtualJukebox: src/Types/Queue.h Source File @@ -61,7 +61,7 @@
@@ -75,14 +75,27 @@
9 #ifndef _QUEUE_H_
10 #define _QUEUE_H_
11 
-
12 class Queue {
-
13  public:
-
14  private:
-
15 };
+
12 #include <optional>
+
13 #include <vector>
+
14 
+
15 #include "Tracks.h"
16 
-
17 #endif /* _QUEUE_H_ */
+
20 struct Queue {
+
21  std::vector<QueuedTrack> tracks;
+
22 };
+
23 
+
28 struct QueueStatus {
+
29  Queue normalQueue;
+
30  Queue adminQueue;
+
31 
+
32  std::optional<PlaybackTrack> currentTrack;
+
33 };
+
34 
+
35 #endif /* _QUEUE_H_ */
-
Queue
Definition: Queue.h:12
+
Queue
Respresents a queue which is returned to the clients.
Definition: Queue.h:20
+
Tracks.h
Definitions of all track related structs.
+
QueueStatus
Wraps all information to return if a client requests the current queue status.
Definition: Queue.h:28
Generated by   diff --git a/docs/html/RAMDataStore_8h.html b/docs/html/RAMDataStore_8h.html new file mode 100644 index 0000000..59ba5cb --- /dev/null +++ b/docs/html/RAMDataStore_8h.html @@ -0,0 +1,109 @@ + + + + + + + +VirtualJukebox: src/Datastore/RAMDataStore.h File Reference + + + + + + + + + + +
+
+Classes
+
+
RAMDataStore.h File Reference
+
+
+ +

Class RAMDataStore implementation. +More...

+
#include <mutex>
+#include <shared_mutex>
+#include <string>
+#include <variant>
+#include <vector>
+#include "DataStore.h"
+#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+#include "Types/Result.h"
+#include "Types/Tracks.h"
+#include "Types/User.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  RAMDataStore
 Implements a DataStore which stores its data purly in RAM (no persistance). More...
 
+

Detailed Description

+

Class RAMDataStore implementation.

+

Class RAMDataStore definition.

+
Author
Samuel Hick samue.nosp@m.l.hi.nosp@m.ck@gm.nosp@m.x.at
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RAMDataStore_8h_source.html b/docs/html/RAMDataStore_8h_source.html new file mode 100644 index 0000000..4322dc4 --- /dev/null +++ b/docs/html/RAMDataStore_8h_source.html @@ -0,0 +1,156 @@ + + + + + + + +VirtualJukebox: src/Datastore/RAMDataStore.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RAMDataStore.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef _RAMDATASTORE_H_
+
10 #define _RAMDATASTORE_H_
+
11 
+
12 #include <mutex>
+
13 #include <shared_mutex>
+
14 #include <string>
+
15 #include <variant>
+
16 #include <vector>
+
17 
+
18 #include "DataStore.h"
+
19 #include "Types/GlobalTypes.h"
+
20 #include "Types/Queue.h"
+
21 #include "Types/Result.h"
+
22 #include "Types/Tracks.h"
+
23 #include "Types/User.h"
+
24 
+
29 class RAMDataStore : public DataStore {
+
30  public:
+
31  TResultOpt addUser(User const &user) override;
+
32  TResult<User> getUser(TSessionID const &ID) override;
+
33  TResult<User> removeUser(TSessionID const &ID) override;
+
34  TResult<bool> isSessionExpired(TSessionID const &ID) override;
+
35  TResultOpt addTrack(BaseTrack const &track, QueueType q) override;
+
36  TResult<BaseTrack> removeTrack(TTrackID const &ID, QueueType q) override;
+
37  TResult<bool> hasTrack(TTrackID const &ID, QueueType q) override;
+
38  TResultOpt voteTrack(TSessionID const &sID,
+
39  TTrackID const &tID,
+
40  TVote vote) override;
+
41  TResult<Queue> getQueue(QueueType q) override;
+
42  TResult<std::optional<QueuedTrack>> getPlayingTrack() override;
+
43  bool hasUser(TSessionID const &ID) override;
+
44  TResultOpt nextTrack() override;
+
45 
+
46  private:
+
47  void removeVotesForTrack(TTrackID const &);
+
48  Queue *SelectQueue(QueueType q);
+
49 
+
50  Queue mAdminQueue;
+
51  Queue mNormalQueue;
+
52  std::optional<QueuedTrack> mCurrentTrack = std::nullopt;
+
53  std::vector<User> mUsers;
+
54  std::recursive_mutex mUserMutex;
+
55  std::shared_mutex mQueueMutex;
+
56 };
+
57 
+
58 #endif /* _RAMDATASTORE_H_ */
+
+
GlobalTypes.h
Defines types and constants that are used globally.
+
DataStore.h
Class DataStore definition.
+
RAMDataStore::hasUser
bool hasUser(TSessionID const &ID) override
Query the internal user list whether a certain user exists.
Definition: RAMDataStore.cpp:283
+
RAMDataStore::addUser
TResultOpt addUser(User const &user) override
Add a User to the internal List of registered Users.
Definition: RAMDataStore.cpp:31
+
RAMDataStore::hasTrack
TResult< bool > hasTrack(TTrackID const &ID, QueueType q) override
Check for Track in one of the internal Queues.
Definition: RAMDataStore.cpp:176
+
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
+
RAMDataStore::getUser
TResult< User > getUser(TSessionID const &ID) override
Get a User from the internal List of registered Users.
Definition: RAMDataStore.cpp:46
+
DataStore
Interface for storing Data such as Tracks, Users, Votes, etc.
Definition: DataStore.h:22
+
RAMDataStore::addTrack
TResultOpt addTrack(BaseTrack const &track, QueueType q) override
Add Track to one of the internal Queues.
Definition: RAMDataStore.cpp:105
+
RAMDataStore::isSessionExpired
TResult< bool > isSessionExpired(TSessionID const &ID) override
Check if user session is expired.
Definition: RAMDataStore.cpp:84
+
RAMDataStore::removeUser
TResult< User > removeUser(TSessionID const &ID) override
Remove a User from the internal List of registered Users. Does not remove votes taken by this user fr...
Definition: RAMDataStore.cpp:64
+
Result.h
Defines function return values and types.
+
Queue
Respresents a queue which is returned to the clients.
Definition: Queue.h:20
+
RAMDataStore::removeTrack
TResult< BaseTrack > removeTrack(TTrackID const &ID, QueueType q) override
Remove Track from one of the internal Queues.
Definition: RAMDataStore.cpp:146
+
TVote
bool TVote
Vote type.
Definition: GlobalTypes.h:27
+
QueueType
QueueType
Queue type enumerator.
Definition: GlobalTypes.h:17
+
TSessionID
std::string TSessionID
Session ID type.
Definition: GlobalTypes.h:32
+
Queue.h
Class Queue definition.
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
BaseTrack
The most basic representation of a track.
Definition: Tracks.h:17
+
RAMDataStore::getPlayingTrack
TResult< std::optional< QueuedTrack > > getPlayingTrack() override
Get the currently playing track.
Definition: RAMDataStore.cpp:276
+
RAMDataStore::voteTrack
TResultOpt voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) override
Upvote/remove Upvote from a track.
Definition: RAMDataStore.cpp:197
+
RAMDataStore::getQueue
TResult< Queue > getQueue(QueueType q) override
Get entire Queue.
Definition: RAMDataStore.cpp:262
+
RAMDataStore::nextTrack
TResultOpt nextTrack() override
Play next Track in Queue.
Definition: RAMDataStore.cpp:298
+
Tracks.h
Definitions of all track related structs.
+
RAMDataStore
Implements a DataStore which stores its data purly in RAM (no persistance).
Definition: RAMDataStore.h:29
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RequestInformation_8h.html b/docs/html/RequestInformation_8h.html new file mode 100644 index 0000000..aa1822d --- /dev/null +++ b/docs/html/RequestInformation_8h.html @@ -0,0 +1,103 @@ + + + + + + + +VirtualJukebox: src/Network/RequestInformation.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
RequestInformation.h File Reference
+
+
+ +

Definition of class RequestInformation. +More...

+
#include <httpserver.hpp>
+#include <map>
+#include <string>
+
+

Go to the source code of this file.

+ + + + + + + + +

+Classes

struct  RequestInformation
 Wraps all relevant pieces of information provided by a HTTP request. More...
 
struct  ResponseInformation
 Wraps all needed pieces of information to form a proper HTTP response. More...
 
+

Detailed Description

+

Definition of class RequestInformation.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RequestInformation_8h_source.html b/docs/html/RequestInformation_8h_source.html new file mode 100644 index 0000000..9e8b4d4 --- /dev/null +++ b/docs/html/RequestInformation_8h_source.html @@ -0,0 +1,105 @@ + + + + + + + +VirtualJukebox: src/Network/RequestInformation.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RequestInformation.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef _REQUEST_INFORMATION_H_
+
10 #define _REQUEST_INFORMATION_H_
+
11 
+
12 #include <httpserver.hpp>
+
13 #include <map>
+
14 #include <string>
+
15 
+
19 struct RequestInformation {
+
20  std::string path;
+
21  std::string method;
+
22  std::string body;
+
23  std::map<std::string, std::string, httpserver::http::arg_comparator> args;
+
24 };
+
25 
+
29 struct ResponseInformation {
+
30  std::string body;
+
31  int code = 200;
+
32 };
+
33 
+
34 #endif // _REQUEST_INFORMATION_H_
+
+
ResponseInformation
Wraps all needed pieces of information to form a proper HTTP response.
Definition: RequestInformation.h:29
+
RequestInformation
Wraps all relevant pieces of information provided by a HTTP request.
Definition: RequestInformation.h:19
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RestAPI_8cpp.html b/docs/html/RestAPI_8cpp.html index dcbf739..2e56e9b 100644 --- a/docs/html/RestAPI_8cpp.html +++ b/docs/html/RestAPI_8cpp.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/RestAPI.cpp File Reference +VirtualJukebox: src/Network/RestAPI.cpp File Reference @@ -61,7 +61,7 @@
@@ -74,8 +74,8 @@ More...

#include "RestAPI.h"
#include <sstream>
-#include "ConfigHandler.h"
-#include "RestEndpointHandler.h"
+#include "RestRequestHandler.h"
+#include "Utils/ConfigHandler.h"

Detailed Description

Implementation of class RestAPI.

Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
diff --git a/docs/html/RestAPI_8h.html b/docs/html/RestAPI_8h.html index 8334cbb..f53633f 100644 --- a/docs/html/RestAPI_8h.html +++ b/docs/html/RestAPI_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/RestAPI.h File Reference +VirtualJukebox: src/Network/RestAPI.h File Reference @@ -61,7 +61,7 @@
diff --git a/docs/html/RestAPI_8h_source.html b/docs/html/RestAPI_8h_source.html index 7d36323..9520425 100644 --- a/docs/html/RestAPI_8h_source.html +++ b/docs/html/RestAPI_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/RestAPI.h Source File +VirtualJukebox: src/Network/RestAPI.h Source File @@ -61,7 +61,7 @@
@@ -83,13 +83,17 @@
22 class RestAPI : public NetworkAPI {
23  public:
24  TResultOpt handleRequests() override;
-
25 };
+
25  void stopServer();
26 
-
27 #endif /* _REST_API_H_ */
+
27  private:
+
28  std::unique_ptr<httpserver::webserver> ws;
+
29 };
+
30 
+
31 #endif /* _REST_API_H_ */
NetworkAPI.h
Definition of class NetworkAPI.
NetworkAPI
Base class for all implementations of network interfaces.
Definition: NetworkAPI.h:21
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
RestAPI
Implementation of the REST API.
Definition: RestAPI.h:22
diff --git a/docs/html/RestEndpointHandlers_8cpp.html b/docs/html/RestEndpointHandlers_8cpp.html new file mode 100644 index 0000000..22ef767 --- /dev/null +++ b/docs/html/RestEndpointHandlers_8cpp.html @@ -0,0 +1,344 @@ + + + + + + + +VirtualJukebox: src/Network/RestEndpointHandlers.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Macros | +Typedefs | +Functions
+
+
RestEndpointHandlers.cpp File Reference
+
+
+ +

Handler functions for all available REST endpoints. +More...

+
#include "RestEndpointHandlers.h"
+#include <iostream>
+#include "Utils/Serializer.h"
+#include "json/json.hpp"
+
+ + + + + + + + + + + +

+Macros

#define PARSE_REQUIRED_STRING_FIELD(name, body)
 
#define PARSE_REQUIRED_INT_FIELD(name, body)
 
#define PARSE_OPTIONAL_STRING_FIELD(name, body)
 
#define PARSE_OPTIONAL_INT_PARAMETER(name, args)
 
#define PARSE_REQUIRED_STRING_PARAMETER(name, args)
 
+ + + +

+Typedefs

+using json = nlohmann::json
 
+ + + + + + + + + + + + + + + + + +

+Functions

+const ResponseInformation generateSessionHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation queryTracksHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation getCurrentQueuesHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation addTrackToQueueHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation voteTrackHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation controlPlayerHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation moveTracksHandler (NetworkListener *listener, RequestInformation const &infos)
 
+const ResponseInformation removeTrackHandler (NetworkListener *listener, RequestInformation const &infos)
 
+

Detailed Description

+

Handler functions for all available REST endpoints.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+

Macro Definition Documentation

+ +

◆ PARSE_OPTIONAL_INT_PARAMETER

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define PARSE_OPTIONAL_INT_PARAMETER( name,
 args 
)
+
+Value:
do { \
+
if (args.find(#name) != args.cend()) { \
+
auto paramStr = args.at(#name); \
+
int tmpValue; \
+
size_t idx; \
+
try { \
+
tmpValue = stoi(paramStr, &idx); \
+
} catch (invalid_argument const &) { \
+
return mapErrorToResponse(Error(ErrorCode::InvalidFormat, \
+
"Parameter '" #name \
+
"' is not an integer")); \
+
} \
+
if (idx != paramStr.size()) { \
+
return mapErrorToResponse(Error( \
+
ErrorCode::InvalidFormat, \
+
"Parameter '" #name "' must not contain non-integer characters")); \
+
} \
+
name = tmpValue; \
+
} \
+
} while (0)
+
+
+
+ +

◆ PARSE_OPTIONAL_STRING_FIELD

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define PARSE_OPTIONAL_STRING_FIELD( name,
 body 
)
+
+Value:
do { \
+
if (body.find(#name) != body.cend()) { \
+
auto nameJson = body[#name]; \
+
if (!nameJson.is_string()) { \
+
return mapErrorToResponse(Error(ErrorCode::InvalidFormat, \
+
"Value of '" #name \
+
"' must be a string")); \
+
} \
+
name = nameJson.get<string>(); \
+
} \
+
} while (0)
+
+
+
+ +

◆ PARSE_REQUIRED_INT_FIELD

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define PARSE_REQUIRED_INT_FIELD( name,
 body 
)
+
+Value:
do { \
+
if (body.find(#name) == body.cend()) { \
+
return mapErrorToResponse( \
+
Error(ErrorCode::InvalidFormat, "Field '" #name "' not found")); \
+
} \
+
if (!body[#name].is_number_integer()) { \
+
return mapErrorToResponse(Error(ErrorCode::InvalidFormat, \
+
"Value of '" #name \
+
"' must be an integer")); \
+
} \
+
name = body[#name].get<int>(); \
+
} while (0)
+
+
+
+ +

◆ PARSE_REQUIRED_STRING_FIELD

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define PARSE_REQUIRED_STRING_FIELD( name,
 body 
)
+
+Value:
do { \
+
if (body.find(#name) == body.cend()) { \
+
return mapErrorToResponse( \
+
Error(ErrorCode::InvalidFormat, "Field '" #name "' not found")); \
+
} \
+
if (!body[#name].is_string()) { \
+
return mapErrorToResponse(Error( \
+
ErrorCode::InvalidFormat, "Value of '" #name "' must be a string")); \
+
} \
+
name = body[#name].get<string>(); \
+
} while (0)
+
+
+
+ +

◆ PARSE_REQUIRED_STRING_PARAMETER

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define PARSE_REQUIRED_STRING_PARAMETER( name,
 args 
)
+
+Value:
do { \
+
if (args.find(#name) == args.cend()) { \
+
return mapErrorToResponse( \
+
Error(ErrorCode::InvalidFormat, "Parameter '" #name "' not found")); \
+
} \
+
name = args.at(#name); \
+
} while (0)
+
+
+
+
+
Error
A customized error type.
Definition: Result.h:48
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RestEndpointHandlers_8h.html b/docs/html/RestEndpointHandlers_8h.html new file mode 100644 index 0000000..4451eb9 --- /dev/null +++ b/docs/html/RestEndpointHandlers_8h.html @@ -0,0 +1,127 @@ + + + + + + + +VirtualJukebox: src/Network/RestEndpointHandlers.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Typedefs | +Functions
+
+
RestEndpointHandlers.h File Reference
+
+
+ +

Handler functions for all available REST endpoints. +More...

+
#include "NetworkListener.h"
+#include "RequestInformation.h"
+
+

Go to the source code of this file.

+ + + + +

+Typedefs

+typedef const ResponseInformation(* TEndpointHandler) (NetworkListener *, RequestInformation const &)
 
+ + + + + + + + + + + + + + + + + +

+Functions

+const ResponseInformation generateSessionHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation queryTracksHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation getCurrentQueuesHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation addTrackToQueueHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation voteTrackHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation controlPlayerHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation moveTracksHandler (NetworkListener *, RequestInformation const &)
 
+const ResponseInformation removeTrackHandler (NetworkListener *, RequestInformation const &)
 
+

Detailed Description

+

Handler functions for all available REST endpoints.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RestEndpointHandlers_8h_source.html b/docs/html/RestEndpointHandlers_8h_source.html new file mode 100644 index 0000000..1b1b46c --- /dev/null +++ b/docs/html/RestEndpointHandlers_8h_source.html @@ -0,0 +1,122 @@ + + + + + + + +VirtualJukebox: src/Network/RestEndpointHandlers.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestEndpointHandlers.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef _REST_ENDPOINT_HANDLERS_H_
+
10 #define _REST_ENDPOINT_HANDLERS_H_
+
11 
+
12 #include "NetworkListener.h"
+
13 #include "RequestInformation.h"
+
14 
+
15 typedef ResponseInformation const (*TEndpointHandler)(
+
16  NetworkListener *, RequestInformation const &);
+
17 
+
18 ResponseInformation const generateSessionHandler(NetworkListener *,
+
19  RequestInformation const &);
+
20 
+
21 ResponseInformation const queryTracksHandler(NetworkListener *,
+
22  RequestInformation const &);
+
23 
+
24 ResponseInformation const getCurrentQueuesHandler(NetworkListener *,
+
25  RequestInformation const &);
+
26 
+
27 ResponseInformation const addTrackToQueueHandler(NetworkListener *,
+
28  RequestInformation const &);
+
29 
+
30 ResponseInformation const voteTrackHandler(NetworkListener *,
+
31  RequestInformation const &);
+
32 
+
33 ResponseInformation const controlPlayerHandler(NetworkListener *,
+
34  RequestInformation const &);
+
35 
+
36 ResponseInformation const moveTracksHandler(NetworkListener *,
+
37  RequestInformation const &);
+
38 
+
39 ResponseInformation const removeTrackHandler(NetworkListener *,
+
40  RequestInformation const &);
+
41 
+
42 #endif // _REST_ENDPOINT_HANDLERS_H_
+
+
RequestInformation.h
Definition of class RequestInformation.
+
ResponseInformation
Wraps all needed pieces of information to form a proper HTTP response.
Definition: RequestInformation.h:29
+
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
+
NetworkListener.h
Interface Class NetworkListener definition.
+
RequestInformation
Wraps all relevant pieces of information provided by a HTTP request.
Definition: RequestInformation.h:19
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RestRequestHandler_8cpp.html b/docs/html/RestRequestHandler_8cpp.html new file mode 100644 index 0000000..9da67ac --- /dev/null +++ b/docs/html/RestRequestHandler_8cpp.html @@ -0,0 +1,103 @@ + + + + + + + +VirtualJukebox: src/Network/RestRequestHandler.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Typedefs
+
+
RestRequestHandler.cpp File Reference
+
+
+ +

Implementation of class RestRequestHandler. +More...

+
#include "RestRequestHandler.h"
+#include <glog/logging.h>
+#include <cassert>
+#include <iostream>
+#include <sstream>
+#include "RestEndpointHandlers.h"
+#include "Utils/LoggingHandler.h"
+#include "json/json.hpp"
+
+ + + +

+Typedefs

+using json = nlohmann::json
 
+

Detailed Description

+

Implementation of class RestRequestHandler.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RestRequestHandler_8h.html b/docs/html/RestRequestHandler_8h.html new file mode 100644 index 0000000..623b6fe --- /dev/null +++ b/docs/html/RestRequestHandler_8h.html @@ -0,0 +1,102 @@ + + + + + + + +VirtualJukebox: src/Network/RestRequestHandler.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
RestRequestHandler.h File Reference
+
+
+ +

Definition of class RestRequestHandler. +More...

+
#include <httpserver.hpp>
+#include <map>
+#include <optional>
+#include "NetworkListener.h"
+#include "RequestInformation.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  RestRequestHandler
 Provides a REST request handler for incoming connections. More...
 
+

Detailed Description

+

Definition of class RestRequestHandler.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/RestRequestHandler_8h_source.html b/docs/html/RestRequestHandler_8h_source.html new file mode 100644 index 0000000..65b4566 --- /dev/null +++ b/docs/html/RestRequestHandler_8h_source.html @@ -0,0 +1,121 @@ + + + + + + + +VirtualJukebox: src/Network/RestRequestHandler.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
RestRequestHandler.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef _REST_REQUEST_HANDLER_H_
+
10 #define _REST_REQUEST_HANDLER_H_
+
11 
+
12 #include <httpserver.hpp>
+
13 #include <map>
+
14 #include <optional>
+
15 
+
16 #include "NetworkListener.h"
+
17 #include "RequestInformation.h"
+
18 
+
25 class RestRequestHandler : public httpserver::http_resource {
+
26  public:
+
27  RestRequestHandler(NetworkListener *listener);
+
28 
+
29  static std::shared_ptr<httpserver::http_response> const NotFoundHandler(
+
30  httpserver::http_request const &req);
+
31  static std::shared_ptr<httpserver::http_response> const NotAllowedHandler(
+
32  httpserver::http_request const &req);
+
33  static std::shared_ptr<httpserver::http_response> const InternalErrorHandler(
+
34  httpserver::http_request const &req);
+
35 
+
36  private:
+
37  NetworkListener *listener;
+
38 
+
39  bool isValidBasePath(std::string const &path) const;
+
40  std::shared_ptr<httpserver::http_response> const render(
+
41  httpserver::http_request const &req) override;
+
42 
+
43  std::optional<ResponseInformation> decodeAndDispatch(
+
44  RequestInformation const &);
+
45 };
+
46 
+
47 #endif /* _REST_ENDPOINT_HANDLER_H_ */
+
+
RequestInformation.h
Definition of class RequestInformation.
+
RestRequestHandler
Provides a REST request handler for incoming connections.
Definition: RestRequestHandler.h:25
+
NetworkListener
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
+
NetworkListener.h
Interface Class NetworkListener definition.
+
RequestInformation
Wraps all relevant pieces of information provided by a HTTP request.
Definition: RequestInformation.h:19
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/Result_8h.html b/docs/html/Result_8h.html index 9868bb6..fe3c64b 100644 --- a/docs/html/Result_8h.html +++ b/docs/html/Result_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/Result.h File Reference +VirtualJukebox: src/Types/Result.h File Reference @@ -61,7 +61,7 @@
@@ -77,7 +77,8 @@

Defines function return values and types. More...

-
#include <iostream>
+
#include <glog/logging.h>
+#include <iostream>
#include <optional>
#include <string>
#include <variant>
@@ -109,7 +110,24 @@ InvalidFormat,
  InvalidValue, -KeyNotFound +KeyNotFound, +NotImplemented, +NotInitialized, +
+  SpotifyNotFound, +SpotifyAccessDenied, +SpotifyAccessExpired, +SpotifyForbidden, +
+  SpotifyParseError, +SpotifyAPIError, +SpotifyBadRequest, +SpotifyHttpTimeout, +
+  SpotifyNoDevice, +AlreadyExists, +DoesntExist, +WrongPassword
}  Valid error codes enumerator.
@@ -117,9 +135,10 @@ - - - + + + +

Functions

bool checkOptionalError (TResultOpt ret)
 Checks if given parameter contains optional error value. If so, it prints the containing error message. More...
 
template<class GOOD_TYPE >
bool checkAlternativeError (TResult< GOOD_TYPE > &ret)
 Checks if given parameter contains alternative error value. If so, it prints the containing error message. More...
 

Detailed Description

Defines function return values and types.

@@ -162,23 +181,25 @@

Function Documentation

- -

◆ checkOptionalError()

+ +

◆ checkAlternativeError()

+
+template<class GOOD_TYPE >
- + - +
bool checkOptionalError bool checkAlternativeError (TResultOpt TResult< GOOD_TYPE > &  ret)
-

Checks if given parameter contains optional error value. If so, it prints the containing error message.

+

Checks if given parameter contains alternative error value. If so, it prints the containing error message.

Returns
true if parameter contains error type, false otherwise
diff --git a/docs/html/Result_8h_source.html b/docs/html/Result_8h_source.html index d350987..62faad0 100644 --- a/docs/html/Result_8h_source.html +++ b/docs/html/Result_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/Result.h Source File +VirtualJukebox: src/Types/Result.h Source File @@ -61,7 +61,7 @@
@@ -75,52 +75,84 @@
9 #ifndef _RESULT_H_
10 #define _RESULT_H_
11 
-
12 #include <iostream>
-
13 #include <optional>
-
14 #include <string>
-
15 #include <variant>
-
16 
-
20 enum class ErrorCode {
-
21  AccessDenied,
-
22  SessionExpired,
-
23  FileNotFound,
-
24  InvalidFormat,
-
25  InvalidValue,
-
26  KeyNotFound
-
27 };
-
28 
-
32 class Error {
-
33  public:
-
34  Error(ErrorCode code, std::string msg) : mCode(code), mMsg(msg) {
-
35  }
-
36 
-
37  ErrorCode getErrorCode() {
-
38  return mCode;
-
39  }
-
40 
-
41  std::string getErrorMessage() {
-
42  return mMsg;
-
43  }
+
12 #include <glog/logging.h>
+
13 
+
14 #include <iostream>
+
15 #include <optional>
+
16 #include <string>
+
17 #include <variant>
+
18 
+
22 enum class ErrorCode {
+
23  AccessDenied,
+
24  SessionExpired,
+
25  FileNotFound,
+
26  InvalidFormat,
+
27  InvalidValue,
+
28  KeyNotFound,
+
29  NotImplemented,
+
30  NotInitialized,
+
31  SpotifyNotFound,
+
32  SpotifyAccessDenied,
+
33  SpotifyAccessExpired,
+
34  SpotifyForbidden,
+
35  SpotifyParseError,
+
36  SpotifyAPIError,
+
37  SpotifyBadRequest,
+
38  SpotifyHttpTimeout,
+
39  SpotifyNoDevice,
+
40  AlreadyExists,
+
41  DoesntExist,
+
42  WrongPassword
+
43 };
44 
-
45  private:
-
46  ErrorCode mCode;
-
47  std::string mMsg;
-
48 };
-
49 
-
58 template <class GOOD_TYPE>
-
59 using TResult = std::variant<GOOD_TYPE, Error>;
+
48 class Error {
+
49  public:
+
50  Error(ErrorCode code, std::string msg) : mCode(code), mMsg(msg) {
+
51  }
+
52 
+
53  ErrorCode getErrorCode() const {
+
54  return mCode;
+
55  }
+
56 
+
57  std::string getErrorMessage() const {
+
58  return mMsg;
+
59  }
60 
-
69 using TResultOpt = std::optional<Error>;
-
70 
-
75 bool checkOptionalError(TResultOpt ret);
+
61  private:
+
62  ErrorCode mCode;
+
63  std::string mMsg;
+
64 };
+
65 
+
74 template <class GOOD_TYPE>
+
75 using TResult = std::variant<GOOD_TYPE, Error>;
76 
-
77 #endif /* _RESULT_H_ */
+
85 using TResultOpt = std::optional<Error>;
+
86 
+
91 static inline bool checkOptionalError(TResultOpt& ret) {
+
92  if (ret.has_value()) {
+
93  LOG(ERROR) << "Error message is: " << ret.value().getErrorMessage();
+
94  return true;
+
95  }
+
96  return false;
+
97 }
+
98 
+
103 template <class GOOD_TYPE>
+
104 bool checkAlternativeError(TResult<GOOD_TYPE>& ret) {
+
105  if (std::holds_alternative<Error>(ret)) {
+
106  LOG(ERROR) << "Error message is: "
+
107  << std::get<Error>(ret).getErrorMessage();
+
108  return true;
+
109  }
+
110  return false;
+
111 }
+
112 
+
113 #endif /* _RESULT_H_ */
-
ErrorCode
ErrorCode
Valid error codes enumerator.
Definition: Result.h:20
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
-
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
-
Error
A customized error type.
Definition: Result.h:32
-
checkOptionalError
bool checkOptionalError(TResultOpt ret)
Checks if given parameter contains optional error value. If so, it prints the containing error messag...
Definition: Result.cpp:11
+
ErrorCode
ErrorCode
Valid error codes enumerator.
Definition: Result.h:22
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
checkAlternativeError
bool checkAlternativeError(TResult< GOOD_TYPE > &ret)
Checks if given parameter contains alternative error value. If so, it prints the containing error mes...
Definition: Result.h:104
+
Error
A customized error type.
Definition: Result.h:48
Generated by   diff --git a/docs/html/Serializer_8cpp.html b/docs/html/Serializer_8cpp.html new file mode 100644 index 0000000..782a37b --- /dev/null +++ b/docs/html/Serializer_8cpp.html @@ -0,0 +1,98 @@ + + + + + + + +VirtualJukebox: src/Utils/Serializer.cpp File Reference + + + + + + + + + + +
+
+Typedefs
+
+
Serializer.cpp File Reference
+
+
+ +

Implementation of class Serializer. +More...

+
#include "Utils/Serializer.h"
+#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+
+ + + +

+Typedefs

+using json = nlohmann::json
 
+

Detailed Description

+

Implementation of class Serializer.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/Serializer_8h.html b/docs/html/Serializer_8h.html new file mode 100644 index 0000000..071ba2f --- /dev/null +++ b/docs/html/Serializer_8h.html @@ -0,0 +1,98 @@ + + + + + + + +VirtualJukebox: src/Utils/Serializer.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
Serializer.h File Reference
+
+
+ +

Definition of class Serializer. +More...

+
#include "json/json.hpp"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  Serializer
 Template class which can be used as a central class for serialization routines for different data types. More...
 
+

Detailed Description

+

Definition of class Serializer.

+
Author
Sebastian Kaupper kaupp.nosp@m.erse.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/Serializer_8h_source.html b/docs/html/Serializer_8h_source.html new file mode 100644 index 0000000..b67d392 --- /dev/null +++ b/docs/html/Serializer_8h_source.html @@ -0,0 +1,95 @@ + + + + + + + +VirtualJukebox: src/Utils/Serializer.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Serializer.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 #ifndef _SERIALIZER_H_
+
9 #define _SERIALIZER_H_
+
10 
+
11 #include "json/json.hpp"
+
12 
+
17 class Serializer {
+
18  public:
+
19  template <class T>
+
20  static nlohmann::json serialize(T const &);
+
21 };
+
22 
+
23 #endif /* _SERIALIZER_H_ */
+
+
Serializer
Template class which can be used as a central class for serialization routines for different data typ...
Definition: Serializer.h:17
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SimpleScheduler_8cpp.html b/docs/html/SimpleScheduler_8cpp.html new file mode 100644 index 0000000..fee8d33 --- /dev/null +++ b/docs/html/SimpleScheduler_8cpp.html @@ -0,0 +1,88 @@ + + + + + + + +VirtualJukebox: src/Utils/SimpleScheduler.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SimpleScheduler.cpp File Reference
+
+
+ +

Class SimpleScheduler implementation. +More...

+
#include "SimpleScheduler.h"
+#include "Types/GlobalTypes.h"
+

Detailed Description

+

Class SimpleScheduler implementation.

+
Authors
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SimpleScheduler_8h.html b/docs/html/SimpleScheduler_8h.html new file mode 100644 index 0000000..e5de495 --- /dev/null +++ b/docs/html/SimpleScheduler_8h.html @@ -0,0 +1,104 @@ + + + + + + + +VirtualJukebox: src/Utils/SimpleScheduler.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
SimpleScheduler.h File Reference
+
+
+ +

Class SimpleScheduler definition. +More...

+
#include <memory>
+#include <shared_mutex>
+#include <string>
+#include <thread>
+#include "DataStore.h"
+#include "MusicBackend.h"
+#include "Types/Result.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  SimpleScheduler
 A simple track scheduler (for presentation purposes). More...
 
+

Detailed Description

+

Class SimpleScheduler definition.

+
Authors
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SimpleScheduler_8h_source.html b/docs/html/SimpleScheduler_8h_source.html new file mode 100644 index 0000000..9ad203a --- /dev/null +++ b/docs/html/SimpleScheduler_8h_source.html @@ -0,0 +1,149 @@ + + + + + + + +VirtualJukebox: src/Utils/SimpleScheduler.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SimpleScheduler.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef SIMPLE_SCHEDULER_H_INCLUDED
+
10 #define SIMPLE_SCHEDULER_H_INCLUDED
+
11 
+
12 #include <memory>
+
13 #include <shared_mutex>
+
14 #include <string>
+
15 #include <thread>
+
16 
+
17 #include "DataStore.h"
+
18 #include "MusicBackend.h"
+
19 #include "Types/Result.h"
+
20 
+
24 class SimpleScheduler {
+
25  public:
+
26  SimpleScheduler(DataStore* const datastore, MusicBackend* const musicbackend);
+
27  ~SimpleScheduler();
+
28 
+
32  void start();
+
33 
+
38  TResult<std::optional<PlaybackTrack>> const& getLastPlayback();
+
39 
+
44  TResultOpt nextTrack();
+
45 
+
51  bool checkForInconsistency();
+
52 
+
53  /* TODO: functions below */
+
54  /* enable() */
+
55  /* disable() */
+
56 
+
57  private:
+
61  enum class SchedulerState { Idle, PlayNextSong, CheckPlaying, Playing };
+
62 
+
69  TResultOpt doSchedule();
+
70 
+
74  void threadFunc();
+
75 
+
76  TResult<bool> areQueuesEmpty();
+
77  TResult<bool> isTrackPlaying(std::optional<PlaybackTrack> const& currentOpt);
+
78  TResult<bool> isTrackFinished(std::optional<PlaybackTrack> const& currentOpt);
+
79 
+
80  DataStore* mDataStore;
+
81  MusicBackend* mMusicBackend;
+
82  SchedulerState mSchedulerState = SchedulerState::Idle;
+
83  TResult<std::optional<PlaybackTrack>> mLastPlaybackTrack;
+
84 
+
85  int const cScheduleIntervalTimeMs = 1000;
+
86 
+
87  std::thread mThread;
+
88  bool mCloseThread = false;
+
89  std::shared_mutex mMtxPlayback;
+
90  std::shared_mutex mMtxModifySchedulerState;
+
91 };
+
92 
+
93 #endif /* SIMPLE_SCHEDULER_H_INCLUDED */
+
+
DataStore.h
Class DataStore definition.
+
DataStore
Interface for storing Data such as Tracks, Users, Votes, etc.
Definition: DataStore.h:22
+
MusicBackend
Provides an abstracted interface to a MusicBackend s.
Definition: MusicBackend.h:22
+
MusicBackend.h
Interface for MusicBackend.
+
Result.h
Defines function return values and types.
+
SimpleScheduler::getLastPlayback
TResult< std::optional< PlaybackTrack > > const & getLastPlayback()
returns the last polled playback status
Definition: SimpleScheduler.cpp:53
+
SimpleScheduler
A simple track scheduler (for presentation purposes).
Definition: SimpleScheduler.h:24
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
SimpleScheduler::start
void start()
Starts the scheduler thread.
Definition: SimpleScheduler.cpp:38
+
SimpleScheduler::checkForInconsistency
bool checkForInconsistency()
returns true if actual track from datastore and playback needs to be checked if they are equal
Definition: SimpleScheduler.cpp:73
+
SimpleScheduler::nextTrack
TResultOpt nextTrack()
plays the next song from the queue
Definition: SimpleScheduler.cpp:58
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAPITypes_8cpp.html b/docs/html/SpotifyAPITypes_8cpp.html new file mode 100644 index 0000000..eab468e --- /dev/null +++ b/docs/html/SpotifyAPITypes_8cpp.html @@ -0,0 +1,89 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAPITypes.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SpotifyAPITypes.cpp File Reference
+
+
+ +

Contains Structures for the Spotify Api implementation. +More...

+
#include "SpotifyAPITypes.h"
+#include <iostream>
+

Detailed Description

+

Contains Structures for the Spotify Api implementation.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+

These Structures are implemented as described the Spotify Object Model Link: https://developer.spotify.com/documentation/web-api/reference/object-model/ Some structures doesn't contain the whole information given in the object model

+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAPITypes_8h.html b/docs/html/SpotifyAPITypes_8h.html new file mode 100644 index 0000000..1918e71 --- /dev/null +++ b/docs/html/SpotifyAPITypes_8h.html @@ -0,0 +1,141 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAPITypes.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Enumerations
+
+
SpotifyAPITypes.h File Reference
+
+
+ +

Contains Structures for the Spotify Api. +More...

+
#include <string>
+#include <vector>
+#include "json/json.hpp"
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Classes

class  SpotifyApi::Token
 return type on valid token request More...
 
class  SpotifyApi::Device
 Device Object. More...
 
class  SpotifyApi::Devices
 Wrapper class for multiple devices. More...
 
class  SpotifyApi::Artist
 Simplified artist object. More...
 
class  SpotifyApi::Image
 Spotify Image Class. More...
 
class  SpotifyApi::Album
 Simplified Spotify Album class. More...
 
class  SpotifyApi::Track
 Simplified track object. More...
 
class  SpotifyApi::Playback
 Contains infos about the actual playback. More...
 
class  SpotifyApi::SpotifyPaging
 Represents one page of search results. More...
 
class  SpotifyApi::SpotifyError
 Error type. More...
 
class  SpotifyApi::SpotifyDummy
 Type gets used, when no content data or Error is received. More...
 
+ + + + +

+Enumerations

enum  SpotifyApi::GrantType { AuthorizationCode, +ClientCredentials, +ImplicitGrant + }
 Possible Autorization Flows (until now only AuthorizationCode gets implemented)
 
+

Detailed Description

+

Contains Structures for the Spotify Api.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+

These Structures are implemented as described the Spotify Object Model Link: https://developer.spotify.com/documentation/web-api/reference/object-model/ Some structures doesn't contain the whole information given in the object model

+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAPITypes_8h_source.html b/docs/html/SpotifyAPITypes_8h_source.html new file mode 100644 index 0000000..725bfec --- /dev/null +++ b/docs/html/SpotifyAPITypes_8h_source.html @@ -0,0 +1,318 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAPITypes.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SpotifyAPITypes.h
+
+
+Go to the documentation of this file.
1 
+
12 #ifndef SPOTIFYAPITYPES_H_INCLUDED
+
13 #define SPOTIFYAPITYPES_H_INCLUDED
+
14 
+
15 #include <string>
+
16 #include <vector>
+
17 
+
18 #include "json/json.hpp"
+
19 
+
20 namespace SpotifyApi {
+
21 
+
26 enum GrantType { AuthorizationCode, ClientCredentials, ImplicitGrant };
+
27 
+
31 class Token {
+
32  public:
+
33  Token() = default;
+
34  Token(nlohmann::json const &tokenJson);
+
35  void setRefreshToken(std::string const &token);
+
36  std::string const &getAccessToken() const;
+
37  std::string const &getRefreshToken() const;
+
38  std::string const &getTokenType() const;
+
39  std::string const &getScope() const;
+
40  size_t getExpiresIn() const;
+
41 
+
42  private:
+
43  std::string
+
44  mAccesToken;
+
45  std::string
+
46  mRefreshToken;
+
47  std::string mTokenType;
+
48  std::string mScope;
+
50  size_t mExpiresIn;
+
52 };
+
53 
+
57 class Device {
+
58  public:
+
59  Device() = default;
+
60  Device(nlohmann::json const &deviceJson);
+
61  std::string const &getID() const;
+
62  bool isActive() const;
+
63  bool isPrivateSession() const;
+
64  bool isRestricted() const;
+
65  std::string const &getName() const;
+
66  std::string const &getType() const;
+
67  size_t getVolume() const;
+
68 
+
69  private:
+
70  std::string mId;
+
71  bool mIsActive;
+
72  bool mIsPrivateSession;
+
74  bool mIsRestricted;
+
76  std::string mName;
+
77  std::string
+
78  mType;
+
79  size_t mVolume;
+
80 };
+
81 
+
85 class Devices {
+
86  public:
+
87  Devices() = default;
+
88  Devices(nlohmann::json const &devicesJson) {
+
89  if (devicesJson.find("devices") != devicesJson.end()) {
+
90  for (nlohmann::json const &elem : devicesJson["devices"]) {
+
91  mDevices.emplace_back(Device(elem));
+
92  }
+
93  }
+
94  }
+
95  std::vector<Device> mDevices;
+
96 };
+
97 
+
101 class Artist {
+
102  public:
+
103  Artist() = default;
+
104  Artist(nlohmann::json const &artistJson);
+
105  std::string const &getHref() const;
+
106  std::string const &getID() const;
+
107  std::string const &getName() const;
+
108  std::string const &getType() const;
+
109  std::string const &getUri() const;
+
110 
+
111  private:
+
112  std::string mHref;
+
114  std::string mId;
+
115  std::string mName;
+
116  std::string mType;
+
117  std::string mUri;
+
118 };
+
119 
+
123 class Image {
+
124  public:
+
125  Image() = default;
+
126  Image(nlohmann::json const &imageJson);
+
127  int getHeight();
+
128  int getWidth();
+
129  std::string const &getUrl() const;
+
130 
+
131  private:
+
132  int mHeight;
+
133  int mWidth;
+
134  std::string mUrl;
+
135 };
+
136 
+
140 class Album {
+
141  public:
+
142  Album() = default;
+
143  Album(nlohmann::json const &albumJson);
+
144  std::vector<Artist> const &getArtists() const;
+
145  std::vector<Image> const &getImages() const;
+
146  std::string const &getAlbumType() const;
+
147  std::string const &getHref() const;
+
148  std::string const &getId() const;
+
149  std::string const &getName() const;
+
150  std::string const &getReleaseDate() const;
+
151  std::string const &getType() const;
+
152  std::string const &getUri() const;
+
153 
+
154  private:
+
155  std::string
+
156  mAlbumType;
+
157  std::vector<Artist> mArtists;
+
158  std::string mHref;
+
160  std::string mId;
+
161  std::string mName;
+
162  std::string
+
163  mReleaseDate;
+
164  std::string mType;
+
165  std::string mUri;
+
166  std::vector<Image> mImages;
+
167 };
+
168 
+
172 class Track {
+
173  public:
+
174  Track() = default;
+
175  Track(nlohmann::json const &trackJson);
+
176  std::vector<Artist> const &getArtists() const;
+
177  Album const &getAlbum() const;
+
178  size_t getDuration() const;
+
179  std::string const &getHref() const;
+
180  std::string const &getId() const;
+
181  std::string const &getName() const;
+
182  std::string const &getUri() const;
+
183 
+
184  private:
+
185  std::vector<Artist> mArtists;
+
186  Album mAlbum;
+
187  size_t mDurationMs;
+
188  std::string mHref;
+
190  std::string mId;
+
191  std::string mName;
+
192  std::string mUri;
+
193 };
+
194 
+
198 class Playback {
+
199  public:
+
200  Playback() = default;
+
201  Playback(nlohmann::json const &playbackJson);
+
202 
+
203  Device const &getDevice() const;
+
204  std::string const &getRepeatState() const;
+
205  bool getShuffleState() const;
+
206  size_t getTimestamp() const;
+
207  size_t getProgressMs() const;
+
208  bool isPlaying() const;
+
209  std::string const &getCurrentPlayingType() const;
+
210  std::optional<Track> const &getCurrentPlayingTrack() const;
+
211 
+
212  private:
+
213  Device mDevice;
+
214  std::string mRepeatState;
+
216  bool mShuffleState;
+
217  size_t mTimestamp;
+
218  size_t mProgressMs;
+
219  bool mIsPlaying;
+
220  std::string mCurrentPlayingType;
+
222  std::optional<Track> mTrack;
+
223 };
+
224 
+
228 class SpotifyPaging {
+
229  public:
+
230  SpotifyPaging() = default;
+
231  SpotifyPaging(nlohmann::json const &pagingJson);
+
232 
+
233  std::vector<Track> const &getTracks() const;
+
234  std::vector<Artist> const &getArtists() const;
+
235  std::vector<Album> const &getAlbums() const;
+
236  std::string const &getHref() const;
+
237  int getLimit() const;
+
238  std::string const &getNext() const;
+
239  int getOffset() const;
+
240  std::string const &getPrevious() const;
+
241  int getTotal() const;
+
242 
+
243  private:
+
244  std::vector<Track> mTracks;
+
245  std::vector<Artist> mArtists;
+
246  std::vector<Album> mAlbums;
+
247  std::string mHref;
+
249  int mLimit;
+
250  std::string mNext;
+
251  int mOffset;
+
252  std::string mPrevious;
+
253  int mTotal;
+
254 };
+
255 
+
259 class SpotifyError {
+
260  public:
+
261  SpotifyError(nlohmann::json const &errorJson);
+
262  int getStatus() const;
+
263  std::string const &getMessage() const;
+
264 
+
265  private:
+
266  int mStatus;
+
267  std::string mMessage;
+
268 };
+
269 
+
273 class SpotifyDummy {
+
274  public:
+
275  SpotifyDummy() = default;
+
276  SpotifyDummy(nlohmann::json const &dummyJson) {
+
277  (void)dummyJson;
+
278  }
+
279 };
+
280 
+
281 } // namespace SpotifyApi
+
282 
+
283 #endif // VIRTUALJUKEBOX_SPOTIFYAPITYPES_H
+
+
SpotifyApi::Album
Simplified Spotify Album class.
Definition: SpotifyAPITypes.h:140
+
SpotifyApi::SpotifyError
Error type.
Definition: SpotifyAPITypes.h:259
+
SpotifyApi::Artist
Simplified artist object.
Definition: SpotifyAPITypes.h:101
+
SpotifyApi::Token
return type on valid token request
Definition: SpotifyAPITypes.h:31
+
SpotifyApi::SpotifyDummy
Type gets used, when no content data or Error is received.
Definition: SpotifyAPITypes.h:273
+
SpotifyApi::Devices
Wrapper class for multiple devices.
Definition: SpotifyAPITypes.h:85
+
SpotifyApi::SpotifyPaging
Represents one page of search results.
Definition: SpotifyAPITypes.h:228
+
SpotifyApi::Image
Spotify Image Class.
Definition: SpotifyAPITypes.h:123
+
SpotifyApi::GrantType
GrantType
Possible Autorization Flows (until now only AuthorizationCode gets implemented)
Definition: SpotifyAPITypes.h:26
+
SpotifyApi::Track
Simplified track object.
Definition: SpotifyAPITypes.h:172
+
SpotifyApi::Device
Device Object.
Definition: SpotifyAPITypes.h:57
+
SpotifyApi::Playback
Contains infos about the actual playback.
Definition: SpotifyAPITypes.h:198
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAPI_8cpp.html b/docs/html/SpotifyAPI_8cpp.html new file mode 100644 index 0000000..229820d --- /dev/null +++ b/docs/html/SpotifyAPI_8cpp.html @@ -0,0 +1,90 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAPI.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SpotifyAPI.cpp File Reference
+
+
+ +

Class SpotifyAPI definition. +More...

+
#include "SpotifyAPI.h"
+#include <connection.h>
+#include <cassert>
+#include <memory>
+

Detailed Description

+

Class SpotifyAPI definition.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAPI_8h.html b/docs/html/SpotifyAPI_8h.html new file mode 100644 index 0000000..40f6dd5 --- /dev/null +++ b/docs/html/SpotifyAPI_8h.html @@ -0,0 +1,110 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAPI.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Enumerations
+
+
SpotifyAPI.h File Reference
+
+
+ +

Class SpotifyAPI definition. +More...

+
#include "SpotifyAPITypes.h"
+#include "Types/Result.h"
+#include "restclient.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  SpotifyApi::SpotifyAPI
 handles the calls with the spotify web api More...
 
+ + + +

+Enumerations

enum  QueryType { album, +artist, +playlist, +track + }
 
+

Detailed Description

+

Class SpotifyAPI definition.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAPI_8h_source.html b/docs/html/SpotifyAPI_8h_source.html new file mode 100644 index 0000000..6d02481 --- /dev/null +++ b/docs/html/SpotifyAPI_8h_source.html @@ -0,0 +1,198 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAPI.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SpotifyAPI.h
+
+
+Go to the documentation of this file.
1 
+
7 #ifndef SPOTIFYAPI_H_INCLUDED
+
8 #define SPOTIFYAPI_H_INCLUDED
+
9 
+
10 #include "SpotifyAPITypes.h"
+
11 #include "Types/Result.h"
+
12 #include "restclient.h"
+
13 
+
14 namespace SpotifyApi {
+
15 
+
16 enum class QueryType { album, artist, playlist, track };
+
17 
+
21 class SpotifyAPI {
+
22  public:
+
35  TResult<Token> getAccessToken(GrantType grantType,
+
36  std::string const &code,
+
37  std::string const &redirectUri,
+
38  std::string const &clientID,
+
39  std::string const &clientSecret);
+
40 
+
52  TResult<Token> refreshAccessToken(std::string const &refreshToken,
+
53  std::string const &clientID,
+
54  std::string const &clientSecret);
+
55 
+
61  TResult<std::vector<Device>> getAvailableDevices(
+
62  std::string const &accessToken);
+
63 
+
74  TResult<std::optional<Playback>> getCurrentPlayback(
+
75  std::string const &accessToken, std::string const &market = "AT");
+
76 
+
91  TResult<SpotifyPaging> search(std::string const &accessToken,
+
92  std::string const &queryKey,
+
93  QueryType type,
+
94  int const limit = 20,
+
95  int const offset = 0,
+
96  std::string const &market = "AT");
+
97 
+
106  TResultOpt setVolume(std::string const &accessToken,
+
107  int volume,
+
108  Device const &device = Device());
+
109 
+
117  TResultOpt pause(std::string const &accessToken,
+
118  Device const &device = Device());
+
119 
+
132  TResultOpt play(
+
133  std::string const &accessToken,
+
134  std::vector<std::string> const &uris = std::vector<std::string>(),
+
135  Device const &device = Device(),
+
136  int positionMs = 0);
+
137 
+
146  TResult<Track> getTrack(std::string const &accessToken,
+
147  std::string const &spotifyID,
+
148  std::string const &market = "AT");
+
149 
+
164  TResultOpt transferUsersPlayback(std::string const &accessToken,
+
165  std::vector<Device> const &devices,
+
166  bool play = false);
+
167 
+
173  static std::string stringUrlEncode(std::string const &str);
+
174 
+
180  static std::string stringBase64Encode(std::string const &str);
+
181 
+
182  private:
+
188  Error errorParser(SpotifyError const &error);
+
189 
+
190  enum HttpMethod { HttpGet, HttpPost, HttpPut };
+
191  TResult<RestClient::Response> spotifyCall(std::string const &accessToken,
+
192  std::string const &endpoint,
+
193  HttpMethod method,
+
194  std::string const &query = "",
+
195  std::string const &body = "");
+
196 
+
197  template <typename SpotifyAPIType>
+
198  TResult<SpotifyAPIType> parseSpotifyCall(
+
199  RestClient::Response const &response);
+
200 
+
201  std::string const cSpotifyAuthUrl = "https://accounts.spotify.com";
+
202  std::string const cSpotifyAPIUrl = "https://api.spotify.com";
+
203  size_t const cRequestTimeout = 5;
+
204  std::map<QueryType, std::string> const cQueryTypeMap = {
+
205  {QueryType::album, "album"},
+
206  {QueryType::track, "track"},
+
207  {QueryType::artist, "artist"},
+
208  {QueryType::playlist, "playlist"}};
+
209 
+
210  int const cHTTPTimeout = 408;
+
211  int const cHTTPBadRequest = 400;
+
212  int const cHTTPUnouthorized = 401;
+
213  int const cHTTPOK = 200;
+
214  int const cHTTPNotFound = 404;
+
215  int const cHTTPForbidden = 403;
+
216  int const cNoContent = 204;
+
217 };
+
218 
+
219 } // namespace SpotifyApi
+
220 
+
221 #endif // SPOTIFYAPI_H_INCLUDED
+
+
SpotifyApi::SpotifyAPI::setVolume
TResultOpt setVolume(std::string const &accessToken, int volume, Device const &device=Device())
sets a volume
Definition: SpotifyAPI.cpp:200
+
SpotifyApi::SpotifyAPI::stringUrlEncode
static std::string stringUrlEncode(std::string const &str)
encodes the given string with http special characters
Definition: SpotifyAPI.cpp:484
+
SpotifyApi::SpotifyError
Error type.
Definition: SpotifyAPITypes.h:259
+
SpotifyApi::SpotifyAPI::getAccessToken
TResult< Token > getAccessToken(GrantType grantType, std::string const &code, std::string const &redirectUri, std::string const &clientID, std::string const &clientSecret)
requests a Token (access token and refresh token) from the spotify web api
Definition: SpotifyAPI.cpp:16
+
SpotifyApi::SpotifyAPI::transferUsersPlayback
TResultOpt transferUsersPlayback(std::string const &accessToken, std::vector< Device > const &devices, bool play=false)
enables a playback on the given device
Definition: SpotifyAPI.cpp:337
+
Result.h
Defines function return values and types.
+
SpotifyApi::SpotifyAPI
handles the calls with the spotify web api
Definition: SpotifyAPI.h:21
+
SpotifyApi::GrantType
GrantType
Possible Autorization Flows (until now only AuthorizationCode gets implemented)
Definition: SpotifyAPITypes.h:26
+
SpotifyApi::SpotifyAPI::getAvailableDevices
TResult< std::vector< Device > > getAvailableDevices(std::string const &accessToken)
returns vector of available spotify devices
Definition: SpotifyAPI.cpp:126
+
SpotifyApi::SpotifyAPI::getTrack
TResult< Track > getTrack(std::string const &accessToken, std::string const &spotifyID, std::string const &market="AT")
searches for the given track id and returns a simplified track object
Definition: SpotifyAPI.cpp:311
+
SpotifyApi::SpotifyAPI::play
TResultOpt play(std::string const &accessToken, std::vector< std::string > const &uris=std::vector< std::string >(), Device const &device=Device(), int positionMs=0)
plays new songs, or resume the actual song
Definition: SpotifyAPI.cpp:268
+
SpotifyApi::SpotifyAPI::getCurrentPlayback
TResult< std::optional< Playback > > getCurrentPlayback(std::string const &accessToken, std::string const &market="AT")
gets the current playback status of the current active device from spotify
Definition: SpotifyAPI.cpp:143
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
SpotifyApi::Device
Device Object.
Definition: SpotifyAPITypes.h:57
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
SpotifyApi::SpotifyAPI::pause
TResultOpt pause(std::string const &accessToken, Device const &device=Device())
pauses the acutal track
Definition: SpotifyAPI.cpp:237
+
SpotifyAPITypes.h
Contains Structures for the Spotify Api.
+
SpotifyApi::SpotifyAPI::search
TResult< SpotifyPaging > search(std::string const &accessToken, std::string const &queryKey, QueryType type, int const limit=20, int const offset=0, std::string const &market="AT")
searches for tracks,artists,albums or playlists with the given query
Definition: SpotifyAPI.cpp:169
+
Error
A customized error type.
Definition: Result.h:48
+
SpotifyApi::SpotifyAPI::stringBase64Encode
static std::string stringBase64Encode(std::string const &str)
encodes the given string with base64
Definition: SpotifyAPI.cpp:512
+
SpotifyApi::SpotifyAPI::refreshAccessToken
TResult< Token > refreshAccessToken(std::string const &refreshToken, std::string const &clientID, std::string const &clientSecret)
requests with the refresh token a new access token
Definition: SpotifyAPI.cpp:75
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAuthorization_8cpp.html b/docs/html/SpotifyAuthorization_8cpp.html new file mode 100644 index 0000000..d539fb4 --- /dev/null +++ b/docs/html/SpotifyAuthorization_8cpp.html @@ -0,0 +1,93 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAuthorization.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SpotifyAuthorization.cpp File Reference
+
+
+ +

Class SpotifyAuthorization implementation. +More...

+
#include "SpotifyAuthorization.h"
+#include <chrono>
+#include <memory>
+#include "Types/Result.h"
+#include "Utils/ConfigHandler.h"
+#include "Utils/LoggingHandler.h"
+#include "httpserver.hpp"
+

Detailed Description

+

Class SpotifyAuthorization implementation.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAuthorization_8h.html b/docs/html/SpotifyAuthorization_8h.html new file mode 100644 index 0000000..424d9ed --- /dev/null +++ b/docs/html/SpotifyAuthorization_8h.html @@ -0,0 +1,103 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAuthorization.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
SpotifyAuthorization.h File Reference
+
+
+ +

Class SpotifyAuthorization definition. +More...

+
#include <mutex>
+#include <thread>
+#include "SpotifyAPI.h"
+#include "SpotifyAPITypes.h"
+#include "Types/Result.h"
+#include "httpserver.hpp"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  SpotifyApi::SpotifyAuthorization
 handles the 3 parties user authentication More...
 
+

Detailed Description

+

Class SpotifyAuthorization definition.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyAuthorization_8h_source.html b/docs/html/SpotifyAuthorization_8h_source.html new file mode 100644 index 0000000..28da4e7 --- /dev/null +++ b/docs/html/SpotifyAuthorization_8h_source.html @@ -0,0 +1,161 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyAuthorization.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SpotifyAuthorization.h
+
+
+Go to the documentation of this file.
1 
+
7 #ifndef SPOTIFYAUTHORIZATION_H_INCLUDED
+
8 #define SPOTIFYAUTHORIZATION_H_INCLUDED
+
9 
+
10 #include <mutex>
+
11 #include <thread>
+
12 
+
13 #include "SpotifyAPI.h"
+
14 #include "SpotifyAPITypes.h"
+
15 #include "Types/Result.h"
+
16 #include "httpserver.hpp"
+
17 
+
18 namespace SpotifyApi {
+
19 
+
23 class SpotifyAuthorization : public httpserver::http_resource {
+
24  public:
+
25  ~SpotifyAuthorization();
+
31  TResultOpt startServer();
+
32 
+
36  void stopServer();
+
37 
+
42  std::string const &getRefreshToken();
+
43 
+
48  std::string const &getAccessToken();
+
49 
+
54  TResultOpt refreshAccessToken();
+
55 
+
60  __int64_t getExpiresAt();
+
61 
+
69  void setScopes(std::string const &scopes);
+
70 
+
75  std::string getScopes();
+
76 
+
77  private:
+
78  Token mToken;
+
79  __int64_t mTokenReceiveTime = 0;
+
80  std::string mClientID = "";
+
81  std::string mScopes = "";
+
82  std::string mRedirectUri = "";
+
83  std::string mClientSecret = "";
+
84  int mPort = 8080;
+
85  std::string const cSectionKey = "Spotify";
+
86  std::string const cClientIDKey = "clientID";
+
87  std::string const cClientSecretKey = "clientSecret";
+
88  std::string const cPortKey = "port";
+
89  std::string const cRedirectUriKey = "redirectUri";
+
90  std::string const cScopesKey = "scopes";
+
91  std::unique_ptr<httpserver::webserver> mWebserver;
+
92  std::mutex mMutex;
+
93 
+
94  const std::shared_ptr<httpserver::http_response> render(
+
95  httpserver::http_request const &request);
+
96 
+
97  const std::shared_ptr<httpserver::http_response> loginHandler(
+
98  httpserver::http_request const &request);
+
99  const std::shared_ptr<httpserver::http_response> callbackHandler(
+
100  httpserver::http_request const &request);
+
101 
+
102  TResultOpt setupConfigParams();
+
103  std::string generateRandomString(size_t length);
+
104  std::string getFromQueryString(std::string const &query,
+
105  std::string const &key);
+
106 };
+
107 
+
108 } // namespace SpotifyApi
+
109 
+
110 #endif // SPOTIFYAUTHORIZATION_H_INCLUDED
+
+
SpotifyApi::SpotifyAuthorization
handles the 3 parties user authentication
Definition: SpotifyAuthorization.h:23
+
SpotifyApi::Token
return type on valid token request
Definition: SpotifyAPITypes.h:31
+
SpotifyApi::SpotifyAuthorization::refreshAccessToken
TResultOpt refreshAccessToken()
refreshes the access token (!! not implemented yet!!)
Definition: SpotifyAuthorization.cpp:58
+
Result.h
Defines function return values and types.
+
SpotifyAPI.h
Class SpotifyAPI definition.
+
SpotifyApi::SpotifyAuthorization::setScopes
void setScopes(std::string const &scopes)
sets the scopes to ask on the permission
Definition: SpotifyAuthorization.cpp:101
+
SpotifyApi::SpotifyAuthorization::startServer
TResultOpt startServer()
starts the server, on which the user can connect
Definition: SpotifyAuthorization.cpp:24
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
SpotifyApi::SpotifyAuthorization::getAccessToken
const std::string & getAccessToken()
returns access token
Definition: SpotifyAuthorization.cpp:55
+
SpotifyAPITypes.h
Contains Structures for the Spotify Api.
+
SpotifyApi::SpotifyAuthorization::stopServer
void stopServer()
stops the server
Definition: SpotifyAuthorization.cpp:46
+
SpotifyApi::SpotifyAuthorization::getRefreshToken
const std::string & getRefreshToken()
returns refresh token
Definition: SpotifyAuthorization.cpp:52
+
SpotifyApi::SpotifyAuthorization::getExpiresAt
__int64_t getExpiresAt()
returns when the token expires
Definition: SpotifyAuthorization.cpp:96
+
SpotifyApi::SpotifyAuthorization::getScopes
std::string getScopes()
return scopes
Definition: SpotifyAuthorization.cpp:105
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyBackend_8cpp.html b/docs/html/SpotifyBackend_8cpp.html new file mode 100644 index 0000000..aba8df9 --- /dev/null +++ b/docs/html/SpotifyBackend_8cpp.html @@ -0,0 +1,203 @@ + + + + + + + +VirtualJukebox: src/Spotify/SpotifyBackend.cpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Macros
+
+
SpotifyBackend.cpp File Reference
+
+
+ +

Class handles Music Playback with a Spotify Backend. +More...

+
#include "SpotifyBackend.h"
+#include <vector>
+#include "Utils/ConfigHandler.h"
+#include "Utils/LoggingHandler.h"
+
+ + + + + +

+Macros

#define SPOTIFYCALL_WITH_REFRESH(returnValue, functionCall, tokenString)
 
#define SPOTIFYCALL_WITH_REFRESH_OPT(returnValue, functionCall, tokenString)
 
+

Detailed Description

+

Class handles Music Playback with a Spotify Backend.

+
Author
Stefan Jahn stefa.nosp@m.n.ja.nosp@m.hn332.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+

Macro Definition Documentation

+ +

◆ SPOTIFYCALL_WITH_REFRESH

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
#define SPOTIFYCALL_WITH_REFRESH( returnValue,
 functionCall,
 tokenString 
)
+
+Value:
returnValue = functionCall; \
+
if (auto error = std::get_if<Error>(&returnValue)) { \
+
auto ret = errorHandler(*error); \
+
if (ret.has_value()) { \
+
LOG(ERROR) << error->getErrorMessage() << std::endl; \
+
return *error; \
+
} else { \
+
tokenString = mSpotifyAuth.getAccessToken(); \
+
returnValue = functionCall; \
+
\
+
if (auto err = std::get_if<Error>(&returnValue)) { \
+
LOG(ERROR) << error->getErrorMessage() << std::endl; \
+
\
+
return *err; \
+
} \
+
} \
+
}
+
+
+
+ +

◆ SPOTIFYCALL_WITH_REFRESH_OPT

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
#define SPOTIFYCALL_WITH_REFRESH_OPT( returnValue,
 functionCall,
 tokenString 
)
+
+Value:
returnValue = functionCall; \
+
if (returnValue.has_value()) { \
+
auto ret = errorHandler(returnValue.value()); \
+
if (ret.has_value()) { \
+
LOG(ERROR) << ret.value().getErrorMessage() << std::endl; \
+
return ret.value(); \
+
} else { \
+
tokenString = mSpotifyAuth.getAccessToken(); \
+
returnValue = functionCall; \
+
\
+
if (returnValue.has_value()) { \
+
LOG(ERROR) << returnValue.value().getErrorMessage() << std::endl; \
+
\
+
return returnValue.value(); \
+
} \
+
} \
+
}
+
+
+
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/SpotifyBackend_8h.html b/docs/html/SpotifyBackend_8h.html index c6f187e..02aa0ce 100644 --- a/docs/html/SpotifyBackend_8h.html +++ b/docs/html/SpotifyBackend_8h.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/SpotifyBackend.h File Reference +VirtualJukebox: src/Spotify/SpotifyBackend.h File Reference @@ -61,7 +61,7 @@
@@ -74,18 +74,20 @@

Class handles Music Playback with a Spotify Backend. More...

-
#include "GlobalTypes.h"
+
#include <mutex>
#include "MusicBackend.h"
-#include "PlaybackTrack.h"
-#include "Queue.h"
-#include "Result.h"
-#include "Track.h"
+#include "SpotifyAPI.h"
+#include "SpotifyAuthorization.h"
+#include "Types/GlobalTypes.h"
+#include "Types/Queue.h"
+#include "Types/Result.h"

Go to the source code of this file.

+

Classes

class  SpotifyBackend
 spotify music backend class which handles api calls and starts the authentication process More...
 

Detailed Description

diff --git a/docs/html/SpotifyBackend_8h_source.html b/docs/html/SpotifyBackend_8h_source.html index 8293e12..d3ec501 100644 --- a/docs/html/SpotifyBackend_8h_source.html +++ b/docs/html/SpotifyBackend_8h_source.html @@ -5,7 +5,7 @@ -VirtualJukebox: src/SpotifyBackend.h Source File +VirtualJukebox: src/Spotify/SpotifyBackend.h Source File @@ -61,7 +61,7 @@
@@ -75,38 +75,71 @@
9 #ifndef _SPOTIFYBACKEND_H_
10 #define _SPOTIFYBACKEND_H_
11 
-
12 #include "GlobalTypes.h"
-
13 #include "MusicBackend.h"
-
14 #include "PlaybackTrack.h"
-
15 #include "Queue.h"
-
16 #include "Result.h"
-
17 #include "Track.h"
-
18 
-
19 class SpotifyBackend : public MusicBackend {
-
20  public:
-
21  virtual TResultOpt initBackend(void) override;
-
22  virtual TResult<std::vector<Track>> queryTracks(std::string const &pattern,
-
23  size_t const num) override;
-
24  virtual TResultOpt setPlayback(Track const &track) override;
-
25  virtual TResult<PlaybackTrack> getCurrentPlayback(void) override;
-
26  virtual TResultOpt pause(void) override;
-
27  virtual TResultOpt play() override;
-
28  virtual TResult<size_t> getVolume(void) override;
-
29  virtual TResultOpt setVolume(size_t const percent) override;
-
30 };
-
31 
-
32 #endif /* _SPOTIFYBACKEND_H_ */
+
12 #include <mutex>
+
13 
+
14 #include "MusicBackend.h"
+
15 #include "SpotifyAPI.h"
+
16 #include "SpotifyAuthorization.h"
+
17 #include "Types/GlobalTypes.h"
+
18 #include "Types/Queue.h"
+
19 #include "Types/Result.h"
+
20 
+
26 class SpotifyBackend : public MusicBackend {
+
27  public:
+
33  virtual TResultOpt initBackend() override;
+
34 
+
35  virtual TResult<std::vector<BaseTrack>> queryTracks(
+
36  std::string const &pattern, size_t const num) override;
+
37 
+
48  virtual TResultOpt setPlayback(BaseTrack const &track) override;
+
49 
+
50  virtual TResult<std::optional<PlaybackTrack>> getCurrentPlayback() override;
+
51 
+
52  virtual TResultOpt pause() override;
+
53 
+
54  virtual TResultOpt play() override;
+
55 
+
56  virtual TResult<size_t> getVolume() override;
+
57 
+
58  virtual TResultOpt setVolume(size_t const percent) override;
+
59 
+
64  virtual TResult<BaseTrack> createBaseTrack(TTrackID const &trackID) override;
+
65 
+
66  private:
+
67  TResultOpt errorHandler(Error const &error);
+
68  SpotifyApi::SpotifyAPI mSpotifyAPI;
+
69  SpotifyApi::SpotifyAuthorization mSpotifyAuth;
+
70 
+
71  std::mutex mPlayPauseMtx;
+
72  std::mutex mVolumeMtx;
+
73 };
+
74 
+
75 #endif /* _SPOTIFYBACKEND_H_ */
GlobalTypes.h
Defines types and constants that are used globally.
-
Track
Definition: Track.h:12
-
MusicBackend
Definition: MusicBackend.h:21
-
MusicBackend.h
Interface for MusicBackends.
+
SpotifyApi::SpotifyAuthorization
handles the 3 parties user authentication
Definition: SpotifyAuthorization.h:23
+
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
+
SpotifyAuthorization.h
Class SpotifyAuthorization definition.
+
SpotifyBackend::setVolume
virtual TResultOpt setVolume(size_t const percent) override
Sets a new volume.
Definition: SpotifyBackend.cpp:280
+
SpotifyBackend::getCurrentPlayback
virtual TResult< std::optional< PlaybackTrack > > getCurrentPlayback() override
Returns the current playback of the active device as a playback track.
Definition: SpotifyBackend.cpp:166
+
MusicBackend
Provides an abstracted interface to a MusicBackend s.
Definition: MusicBackend.h:22
+
MusicBackend.h
Interface for MusicBackend.
Result.h
Defines function return values and types.
-
SpotifyBackend
Definition: SpotifyBackend.h:19
+
SpotifyAPI.h
Class SpotifyAPI definition.
+
SpotifyBackend
spotify music backend class which handles api calls and starts the authentication process
Definition: SpotifyBackend.h:26
+
SpotifyApi::SpotifyAPI
handles the calls with the spotify web api
Definition: SpotifyAPI.h:21
+
SpotifyBackend::pause
virtual TResultOpt pause() override
Pauses the current playback.
Definition: SpotifyBackend.cpp:211
+
SpotifyBackend::initBackend
virtual TResultOpt initBackend() override
Initalizes the backend.
Definition: SpotifyBackend.cpp:56
Queue.h
Class Queue definition.
-
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
-
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
-
Track.h
Class Track definition.
+
TResultOpt
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
+
TResult
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
+
BaseTrack
The most basic representation of a track.
Definition: Tracks.h:17
+
SpotifyBackend::setPlayback
virtual TResultOpt setPlayback(BaseTrack const &track) override
Set the given track as playback (means the track gets played).
Definition: SpotifyBackend.cpp:105
+
Error
A customized error type.
Definition: Result.h:48
+
SpotifyBackend::createBaseTrack
virtual TResult< BaseTrack > createBaseTrack(TTrackID const &trackID) override
Creates a new BaseTrack instance with the given trackID.
Definition: SpotifyBackend.cpp:318
+
SpotifyBackend::queryTracks
virtual TResult< std::vector< BaseTrack > > queryTracks(std::string const &pattern, size_t const num) override
Queries the backend for all tracks given a pattern.
Definition: SpotifyBackend.cpp:63
+
SpotifyBackend::getVolume
virtual TResult< size_t > getVolume() override
Returns the volume of the actual device in percent.
Definition: SpotifyBackend.cpp:259
+
SpotifyBackend::play
virtual TResultOpt play() override
Resumes the current playback.
Definition: SpotifyBackend.cpp:234
Generated by   diff --git a/docs/html/Tracks_8h.html b/docs/html/Tracks_8h.html new file mode 100644 index 0000000..f268fac --- /dev/null +++ b/docs/html/Tracks_8h.html @@ -0,0 +1,104 @@ + + + + + + + +VirtualJukebox: src/Types/Tracks.h File Reference + + + + + + + + + + +
+
+Classes
+
+
Tracks.h File Reference
+
+
+ +

Definitions of all track related structs. +More...

+
#include "Types/GlobalTypes.h"
+
+

Go to the source code of this file.

+ + + + + + + + + + + +

+Classes

class  BaseTrack
 The most basic representation of a track. More...
 
struct  QueuedTrack
 Specialized track which is found inside queues. More...
 
struct  PlaybackTrack
 Specialized track representing the currently playing track. More...
 
+

Detailed Description

+

Definitions of all track related structs.

+
Author
Michael Wurm wurm..nosp@m.mich.nosp@m.ael95.nosp@m.@gma.nosp@m.il.co.nosp@m.m
+
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/Tracks_8h_source.html b/docs/html/Tracks_8h_source.html new file mode 100644 index 0000000..96fcb97 --- /dev/null +++ b/docs/html/Tracks_8h_source.html @@ -0,0 +1,127 @@ + + + + + + + +VirtualJukebox: src/Types/Tracks.h Source File + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Tracks.h
+
+
+Go to the documentation of this file.
1 /*****************************************************************************/
+
7 /*****************************************************************************/
+
8 
+
9 #ifndef _TRACKS_H_
+
10 #define _TRACKS_H_
+
11 
+
12 #include "Types/GlobalTypes.h"
+
13 
+
17 class BaseTrack {
+
18  public:
+
19  TTrackID trackId;
+
20  std::string title;
+
21  std::string album;
+
22  std::string artist;
+
23  unsigned durationMs;
+
24  std::string iconUri;
+
25  std::string addedBy;
+
26  bool operator==(const BaseTrack &tr) {
+
27  return trackId == tr.trackId;
+
28  }
+
29 };
+
30 
+
34 struct QueuedTrack : public BaseTrack {
+
35  int votes;
+
36  TVote userHasVoted;
+
37  uint64_t insertedAt;
+
38  bool operator<(const QueuedTrack tr) {
+
39  if (votes == tr.votes) {
+
40  return insertedAt < tr.insertedAt;
+
41  } else {
+
42  return votes > tr.votes;
+
43  }
+
44  }
+
45 };
+
46 
+
50 struct PlaybackTrack : public BaseTrack {
+
51  int progressMs;
+
52  bool isPlaying;
+
53 };
+
54 
+
55 #endif /* _TRACKS_H_ */
+
+
GlobalTypes.h
Defines types and constants that are used globally.
+
TTrackID
std::string TTrackID
Track ID type.
Definition: GlobalTypes.h:37
+
QueuedTrack
Specialized track which is found inside queues.
Definition: Tracks.h:34
+
TVote
bool TVote
Vote type.
Definition: GlobalTypes.h:27
+
PlaybackTrack
Specialized track representing the currently playing track.
Definition: Tracks.h:50
+
BaseTrack
The most basic representation of a track.
Definition: Tracks.h:17
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/annotated.html b/docs/html/annotated.html index b984ed9..883a4ba 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -66,20 +66,41 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - - - - - - - - - +
[detail level 12]
 CConfigHandler
 CErrorA customized error type
 CJukeBox
 CLoggingHandler
 CMusicBackend
 CNetworkAPIBase class for all implementations of network interfaces
 CNetworkListenerProvides interface methods for all supported requests
 CPlaybackTrack
 CQueue
 CRestAPIImplementation of the REST API
 CRestEndpointHandlerProvides REST endpoints for incoming connections
 CSpotifyBackend
 CTrack
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼NSpotifyApi
 CAlbumSimplified Spotify Album class
 CArtistSimplified artist object
 CDeviceDevice Object
 CDevicesWrapper class for multiple devices
 CImageSpotify Image Class
 CPlaybackContains infos about the actual playback
 CSpotifyAPIHandles the calls with the spotify web api
 CSpotifyAuthorizationHandles the 3 parties user authentication
 CSpotifyDummyType gets used, when no content data or Error is received
 CSpotifyErrorError type
 CSpotifyPagingRepresents one page of search results
 CTokenReturn type on valid token request
 CTrackSimplified track object
 CBaseTrackThe most basic representation of a track
 CConfigHandlerSingleton class which provides shared access to the configuration file used
 CDataStoreInterface for storing Data such as Tracks, Users, Votes, etc
 CErrorA customized error type
 CJukeBoxCore class which combines all interface implementations in a working server application
 CMusicBackendProvides an abstracted interface to a MusicBackend s
 CNetworkAPIBase class for all implementations of network interfaces
 CNetworkListenerProvides interface methods for all supported requests
 CPlaybackTrackSpecialized track representing the currently playing track
 CQueueRespresents a queue which is returned to the clients
 CQueuedTrackSpecialized track which is found inside queues
 CQueueStatusWraps all information to return if a client requests the current queue status
 CRAMDataStoreImplements a DataStore which stores its data purly in RAM (no persistance)
 CRequestInformationWraps all relevant pieces of information provided by a HTTP request
 CResponseInformationWraps all needed pieces of information to form a proper HTTP response
 CRestAPIImplementation of the REST API
 CRestRequestHandlerProvides a REST request handler for incoming connections
 CSerializerTemplate class which can be used as a central class for serialization routines for different data types
 CSimpleSchedulerA simple track scheduler (for presentation purposes)
 CSpotifyBackendSpotify music backend class which handles api calls and starts the authentication process
diff --git a/docs/html/classBaseTrack-members.html b/docs/html/classBaseTrack-members.html new file mode 100644 index 0000000..b423e9d --- /dev/null +++ b/docs/html/classBaseTrack-members.html @@ -0,0 +1,87 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
BaseTrack Member List
+
+
+ +

This is the complete list of members for BaseTrack, including all inherited members.

+ + + + + + + + + +
addedBy (defined in BaseTrack)BaseTrack
album (defined in BaseTrack)BaseTrack
artist (defined in BaseTrack)BaseTrack
durationMs (defined in BaseTrack)BaseTrack
iconUri (defined in BaseTrack)BaseTrack
operator==(const BaseTrack &tr) (defined in BaseTrack)BaseTrackinline
title (defined in BaseTrack)BaseTrack
trackId (defined in BaseTrack)BaseTrack
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classBaseTrack.html b/docs/html/classBaseTrack.html new file mode 100644 index 0000000..24def44 --- /dev/null +++ b/docs/html/classBaseTrack.html @@ -0,0 +1,131 @@ + + + + + + + +VirtualJukebox: BaseTrack Class Reference + + + + + + + + + +
+
+ + + + + + +
+
VirtualJukebox +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
BaseTrack Class Reference
+
+
+ +

The most basic representation of a track. + More...

+ +

#include <Tracks.h>

+
+Inheritance diagram for BaseTrack:
+
+
+ + +PlaybackTrack +QueuedTrack + +
+ + + + +

+Public Member Functions

+bool operator== (const BaseTrack &tr)
 
+ + + + + + + + + + + + + + + +

+Public Attributes

+TTrackID trackId
 
+std::string title
 
+std::string album
 
+std::string artist
 
+unsigned durationMs
 
+std::string iconUri
 
+std::string addedBy
 
+

Detailed Description

+

The most basic representation of a track.

+
The documentation for this class was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classBaseTrack.png b/docs/html/classBaseTrack.png new file mode 100644 index 0000000000000000000000000000000000000000..da15ef76c02d8b0c6fdb9d60430b74939815ddbd GIT binary patch literal 687 zcmeAS@N?(olHy`uVBq!ia0vp^r+_$sgBeKXyGiW_QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;-Xe;b}TJxdiv3a z=Y)R!ZRV24S`1<_tP7;W88g3PwM9UWB_TkqA^n5Q)Xb`$)5RfiYW{_l6T0Rn zFg$*!#jqF&iyQe~E)ix3FS^gNo2!8r=!GMp3^_Zv9Msn_B^(ZAuqqT~kY2}hp>s9E z4T%WVV-nRfl6p2aOB=g-?&^ziowV+7sLIK<)gD3W{vn+2&;Qn2xr2|l`ms%loQfyw z%8iSHq%~IVXwvmwxv8#n#g!(usk*aOOf$<&RxJ5-hWGT8HO8BdZ&F#WH?_hwwKw;r zUGTF1o6=UUOxgSFV0!QG`|CBe3s-x+-DdaWy3X3YMG|4__UFER=9K<%{;DaVE7L8* zRIhH=aJ?B3XxVEXaw=*0#rF7VI;K-q0&-?1*_~nyD?9yY?JAw@|H(H_>U)bVKJ_y$ zQ|08Nc>fJsBsbp;ys6!*vzB$5zo(VSH)R#|ssAMM_lIAbX*Dl$s_>e5Pha1@_eE&( z61Mse+omt!uREN=Gd12&a*5WYFUdfU0|Ul$(?hLES5A5ZLq%UDxYO_$_fK~3D9v3r T=3H$ArY;6gS3j3^P6getInstance() (defined in ConfigHandler)ConfigHandlerstatic getValueInt(std::string const &section, std::string const &key)ConfigHandler getValueString(std::string const &section, std::string const &key)ConfigHandler - setConfigFilePath(std::string const &filepath)ConfigHandler - ~ConfigHandler()=default (defined in ConfigHandler)ConfigHandler + isInitialized() (defined in ConfigHandler)ConfigHandler + setConfigFilePath(std::string const &filepath)ConfigHandler + ~ConfigHandler()=default (defined in ConfigHandler)ConfigHandler
diff --git a/docs/html/classConfigHandler.html b/docs/html/classConfigHandler.html index 31a2edc..a8266c8 100644 --- a/docs/html/classConfigHandler.html +++ b/docs/html/classConfigHandler.html @@ -69,6 +69,11 @@
ConfigHandler Class Reference
+ +

Singleton class which provides shared access to the configuration file used. + More...

+ +

#include <ConfigHandler.h>

@@ -83,6 +88,9 @@ + +

Public Member Functions

TResult< int > getValueInt (std::string const &section, std::string const &key)
 Returns value of a key as integer. More...
 
+bool isInitialized ()
 
@@ -90,7 +98,9 @@ static const std::shared_ptr< ConfigHandler > 

Static Public Member Functions

getInstance ()
 
-

Member Function Documentation

+

Detailed Description

+

Singleton class which provides shared access to the configuration file used.

+

Member Function Documentation

◆ getValueInt()

@@ -123,8 +133,8 @@

ConfigHandler.h -
  • src/ConfigHandler.cpp
    • +
  • src/Utils/ConfigHandler.h
    • +
  • src/Utils/ConfigHandler.cpp

    • diff --git a/docs/html/classDataStore-members.html b/docs/html/classDataStore-members.html new file mode 100644 index 0000000..b352662 --- /dev/null +++ b/docs/html/classDataStore-members.html @@ -0,0 +1,93 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    DataStore Member List
    +
    +
    + +

    This is the complete list of members for DataStore, including all inherited members.

    + + + + + + + + + + + + + + + +
    addTrack(BaseTrack const &track, QueueType q)=0DataStorepure virtual
    addUser(User const &user)=0DataStorepure virtual
    cSessionTimeoutAfterSeconds (defined in DataStore)DataStorestatic
    getPlayingTrack()=0DataStorepure virtual
    getQueue(QueueType q)=0DataStorepure virtual
    getUser(TSessionID const &sID)=0DataStorepure virtual
    hasTrack(TTrackID const &tID, QueueType q)=0DataStorepure virtual
    hasUser(TSessionID const &sID)=0DataStorepure virtual
    isSessionExpired(TSessionID const &sID)=0DataStorepure virtual
    nextTrack()=0DataStorepure virtual
    removeTrack(TTrackID const &tID, QueueType q)=0DataStorepure virtual
    removeUser(TSessionID const &sID)=0DataStorepure virtual
    voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote)=0DataStorepure virtual
    ~DataStore() (defined in DataStore)DataStoreinlinevirtual
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classDataStore.html b/docs/html/classDataStore.html new file mode 100644 index 0000000..835d881 --- /dev/null +++ b/docs/html/classDataStore.html @@ -0,0 +1,632 @@ + + + + + + + +VirtualJukebox: DataStore Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Public Member Functions | +Static Public Attributes | +List of all members
    +
    +
    DataStore Class Referenceabstract
    +
    +
    + +

    Interface for storing Data such as Tracks, Users, Votes, etc. + More...

    + +

    #include <DataStore.h>

    +
    +Inheritance diagram for DataStore:
    +
    +
    + + +RAMDataStore + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    virtual TResultOpt addUser (User const &user)=0
     Add a User to the internal List of registered Users. More...
     
    virtual TResult< User > getUser (TSessionID const &sID)=0
     Get a User from the internal List of registered Users. More...
     
    virtual TResult< User > removeUser (TSessionID const &sID)=0
     Remove a User from the internal List of registered Users. Does not remove votes taken by this user from the corresponding tracks. More...
     
    virtual TResult< bool > isSessionExpired (TSessionID const &sID)=0
     Check if user session is expired. More...
     
    virtual TResultOpt addTrack (BaseTrack const &track, QueueType q)=0
     Add Track to one of the internal Queues. More...
     
    virtual TResult< BaseTrack > removeTrack (TTrackID const &tID, QueueType q)=0
     Remove Track from one of the internal Queues. More...
     
    virtual TResult< bool > hasTrack (TTrackID const &tID, QueueType q)=0
     Check for Track in one of the internal Queues. More...
     
    virtual TResultOpt voteTrack (TSessionID const &sID, TTrackID const &tID, TVote vote)=0
     Upvote/remove Upvote from a track. More...
     
    virtual TResult< Queue > getQueue (QueueType q)=0
     Get entire Queue. More...
     
    virtual TResult< std::optional< QueuedTrack > > getPlayingTrack ()=0
     Get the currently playing track. More...
     
    virtual bool hasUser (TSessionID const &sID)=0
     Query the internal user list whether a certain user exists. More...
     
    virtual TResultOpt nextTrack ()=0
     Play next Track in Queue. More...
     
    + + + +

    +Static Public Attributes

    +static const unsigned cSessionTimeoutAfterSeconds = 3600
     
    +

    Detailed Description

    +

    Interface for storing Data such as Tracks, Users, Votes, etc.

    +

    Member Function Documentation

    + +

    ◆ addTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    virtual TResultOpt DataStore::addTrack (BaseTrack const & track,
    QueueType q 
    )
    +     		+pure virtual
    +
    + +

    Add Track to one of the internal Queues.

    +
    Parameters
    + + + +
    trackThe Track to add
    qIdentifier for determining which Queue the Track should be added to
    +
    +
    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ addUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResultOpt DataStore::addUser (User const & user)
    +     		+pure virtual
    +
    + +

    Add a User to the internal List of registered Users.

    +
    Parameters
    + + +
    userThe User class to add
    +
    +
    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ getPlayingTrack()

    + +
    +
    + + + + + +
    + + + + + + + +
    virtual TResult<std::optional<QueuedTrack> > DataStore::getPlayingTrack ()
    +     		+pure virtual
    +
    + +

    Get the currently playing track.

    +
    Returns
    Returns the currently playing track (if any) or an Error message.
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ getQueue()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResult<Queue> DataStore::getQueue (QueueType q)
    +     		+pure virtual
    +
    + +

    Get entire Queue.

    +
    Parameters
    + + +
    qIdentifier for determining which Queue should be returned
    +
    +
    +
    Returns
    Either the requested Queue or an Error message.
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ getUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResult<User> DataStore::getUser (TSessionID const & sID)
    +     		+pure virtual
    +
    + +

    Get a User from the internal List of registered Users.

    +
    Parameters
    + + +
    sIDThe ID of the User we want to get
    +
    +
    +
    Returns
    Either the requested user or an Error message.
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ hasTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    virtual TResult<bool> DataStore::hasTrack (TTrackID const & tID,
    QueueType q 
    )
    +     		+pure virtual
    +
    + +

    Check for Track in one of the internal Queues.

    +
    Parameters
    + + + +
    tIDThe ID of the Track to check for
    qIdentifier for determining which Queue should be checked for the Track
    +
    +
    +
    Returns
    Either a boolean answer or an Error message.
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ hasUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual bool DataStore::hasUser (TSessionID const & sID)
    +     		+pure virtual
    +
    + +

    Query the internal user list whether a certain user exists.

    +
    Parameters
    + + +
    sIDThe ID of the user to check for
    +
    +
    +
    Returns
    true if an user with this ID exists, false otherwise
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ isSessionExpired()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResult<bool> DataStore::isSessionExpired (TSessionID const & sID)
    +     		+pure virtual
    +
    + +

    Check if user session is expired.

    +
    Parameters
    + + +
    sIDSession ID of the user to check
    +
    +
    +
    Return values
    + + +
    Returnsfalse if session is not expired yet. Returns an Error object on session expiration or error.
    +
    +
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ nextTrack()

    + +
    +
    + + + + + +
    + + + + + + + +
    virtual TResultOpt DataStore::nextTrack ()
    +     		+pure virtual
    +
    + +

    Play next Track in Queue.

    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ removeTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    virtual TResult<BaseTrack> DataStore::removeTrack (TTrackID const & tID,
    QueueType q 
    )
    +     		+pure virtual
    +
    + +

    Remove Track from one of the internal Queues.

    +
    Parameters
    + + + +
    tIDThe ID of the Track to remove
    qIdentifier for determining which Queue the Track should be removed from
    +
    +
    +
    Returns
    Either the removed track or an Error message.
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ removeUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResult<User> DataStore::removeUser (TSessionID const & sID)
    +     		+pure virtual
    +
    + +

    Remove a User from the internal List of registered Users. Does not remove votes taken by this user from the corresponding tracks.

    +
    Parameters
    + + +
    sIDID number of the User to remove
    +
    +
    +
    Returns
    Either the user that was removed or an Error message.
    + +

    Implemented in RAMDataStore.

    + +
    +
    + +

    ◆ voteTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    virtual TResultOpt DataStore::voteTrack (TSessionID const & sID,
    TTrackID const & tID,
    TVote vote 
    )
    +     		+pure virtual
    +
    + +

    Upvote/remove Upvote from a track.

    +
    Parameters
    + + + + +
    sIDThe ID of the User who wants to vote
    tIDThe ID of the Track to vote for
    voteThe Vote which determines whether a new upvote should be made or an old one removed
    +
    +
    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implemented in RAMDataStore.

    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classDataStore.png b/docs/html/classDataStore.png new file mode 100644 index 0000000000000000000000000000000000000000..e4d0dbbd06cf3f948165b1c84547a3978b8d9558 GIT binary patch literal 490 zcmeAS@N?(olHy`uVBq!ia0vp^2|ygc!3-oX+B7T&QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;{*WnO^FpCDuZYj}9L@b-zX6kPipL=LjZ->HCFbp5M1ioA!q1K=3@yUn>ruvS#_c z3bNyzN;IwecO4PwYN_5_&8oF*(!8^A;BVek<99_g{NOShX2{; za#nHwoxd~nb}8+c;&}4M54mUaEcKqI6pKII#`GfMz7oT9Rfd9}T#g)yJ}eJ}q!0L{ zac|4rl(_AISpB-hT@Sc-WpFaoOk+5Z%E=IeO8r}?a7<$ThNBXXSvw|~^s7!#nSP%0 z(BJ8KvkUi|Wv6NGO-onV`akpn&vDhtcTIMy_MZ0lxOAZMpxwLQYn}P-oRL|7y~o{g zX^-oKYp-H&w$07F^H{QiDSE=JMS><@B$r&8@}{^1>XVaYX95This is the complete list of members for Error, including all inherited members.

    - - + +
    Error(ErrorCode code, std::string msg) (defined in Error)Errorinline
    getErrorCode() (defined in Error)Errorinline
    getErrorMessage() (defined in Error)Errorinline
    getErrorCode() const (defined in Error)Errorinline
    getErrorMessage() const (defined in Error)Errorinline
    diff --git a/docs/html/classError.html b/docs/html/classError.html index 226cafb..5c2b058 100644 --- a/docs/html/classError.html +++ b/docs/html/classError.html @@ -79,17 +79,17 @@  Error (ErrorCode code, std::string msg)   - -ErrorCode getErrorCode () -  - -std::string getErrorMessage () -  + +ErrorCode getErrorCode () const +  + +std::string getErrorMessage () const + 

    Detailed Description

    A customized error type.

    The documentation for this class was generated from the following file: diff --git a/docs/html/classJukeBox-members.html b/docs/html/classJukeBox-members.html index 08a9bd1..7642283 100644 --- a/docs/html/classJukeBox-members.html +++ b/docs/html/classJukeBox-members.html @@ -70,12 +70,15 @@ - - - + + + + + - + +
    addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type) overrideJukeBoxvirtual
    controlPlayer(TSessionID const &sid, PlayerAction action) overrideJukeBoxvirtual
    generateSession(TPassword const &pw) overrideJukeBoxvirtual
    moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type) overrideJukeBoxvirtual
    queryTracks(std::string const &searchPattern, size_t const nrOfEntries) overrideJukeBoxvirtual
    generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname) overrideJukeBoxvirtual
    getCurrentQueues(TSessionID const &sid)JukeBoxvirtual
    JukeBox() (defined in JukeBox)JukeBox
    moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue) overrideJukeBoxvirtual
    queryTracks(std::string const &searchPattern, size_t const nrOfEntries) overrideJukeBoxvirtual
    removeTrack(TSessionID const &sid, TTrackID const &trkid) overrideJukeBoxvirtual
    start(std::string configFilePath) (defined in JukeBox)JukeBox
    start(std::string const &exeName, std::string const &configFilePath)JukeBox
    voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote) overrideJukeBoxvirtual
    ~JukeBox() (defined in JukeBox)JukeBox
    diff --git a/docs/html/classJukeBox.html b/docs/html/classJukeBox.html index 6be8aeb..8b88421 100644 --- a/docs/html/classJukeBox.html +++ b/docs/html/classJukeBox.html @@ -68,6 +68,11 @@
    JukeBox Class Reference
    + +

    Core class which combines all interface implementations in a working server application. + More...

    + +

    #include <JukeBox.h>

    Inheritance diagram for JukeBox:
    @@ -80,17 +85,19 @@ - - - - - - - - + + + + + + + + + + + - + @@ -98,14 +105,19 @@ - - - + + +

    Public Member Functions

    -void start (std::string configFilePath)
     
    TResult< TSessionID > generateSession (TPassword const &pw) override
     Generate a session for an user. More...
     
    TResult< std::vector< Track > > queryTracks (std::string const &searchPattern, size_t const nrOfEntries) override
     Query available tracks using different music backends. More...
     
    bool start (std::string const &exeName, std::string const &configFilePath)
     Initializes ConfigHandler, LoggingHandler as well as the MusicBackend. More...
     
    TResult< TSessionID > generateSession (std::optional< TPassword > const &pw, std::optional< std::string > const &nickname) override
     
    TResult< std::vector< BaseTrack > > queryTracks (std::string const &searchPattern, size_t const nrOfEntries) override
     Query available tracks using different music backends. More...
     
    TResult< QueueStatus > getCurrentQueues (TSessionID const &sid)
     Query the content of the current queues. More...
     
    TResultOpt addTrackToQueue (TSessionID const &sid, TTrackID const &trkid, QueueType type) override
     Querie the content of the current queues. More...
     Add a track to a given queue (normal or admin). More...
     
    TResultOpt voteTrack (TSessionID const &sid, TTrackID const &trkid, TVote vote) override
     Vote for a track or revoke a vote. More...
    TResultOpt removeTrack (TSessionID const &sid, TTrackID const &trkid) override
     Remove a track from a queue. More...
     
    TResultOpt moveTrack (TSessionID const &sid, TTrackID const &trkid, QueueType type) override
     Move a track between queues. More...
     
    TResultOpt moveTrack (TSessionID const &sid, TTrackID const &trkid, QueueType toQueue) override
     Move a track between queues. More...
     
    TResultOpt controlPlayer (TSessionID const &sid, PlayerAction action) override
     Controls the behaviour of the music player. More...
     
    -

    Member Function Documentation

    +

    Detailed Description

    +

    Core class which combines all interface implementations in a working server application.

    +

    This class is responsible for forwarding requests to the MusicBackends as well as accessing data of an DataStore and responding to requests from the NetworkAPI appropriatly.
    +
    + Additionally the JukeBox contains a (simple) scheduler algorithm to proceed after a track is over.

    +

    Member Function Documentation

    ◆ addTrackToQueue()

    @@ -146,10 +158,7 @@

    -

    Querie the content of the current queues.

    -

    Additionally to the current normal and admin queue, the currently playing track is returned as well (if any).

    -
    Returns
    On success the current queues and the current track are returned, an Error otherwise.
    -

    Add a track to a given queue (normal or admin).

    +

    Add a track to a given queue (normal or admin).

    Depending on the value of type a track is added to either the normal or the admin queue. If the track is not found, or the user has no permission to add the track to the specified queue, an error is returned.

    Parameters
    @@ -216,8 +225,8 @@

    -

    ◆ generateSession()

    + +

    ◆ generateSession()

    @@ -228,9 +237,19 @@

    TResult< TSessionID > JukeBox::generateSession

    - - + + + + + + + + + + + +
    (TPassword const & pw)std::optional< TPassword > const & pw,
    std::optional< std::string > const & nickname 
    )
    @@ -239,22 +258,52 @@

    +

    Implementations of the network endpoints defined in NetworkListener

    + +

    Implements NetworkListener.

    + +

    +
    + +

    ◆ getCurrentQueues()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResult< QueueStatus > JukeBox::getCurrentQueues (TSessionID const & sid)
    +     		+virtual
    +
    -

    Generate a session for an user.

    -

    A password may be provided to request admin privileges.

    Parameters
    +

    Query the content of the current queues.

    +

    Additionally to the current normal and admin queue, the currently playing track is returned as well (if any).

    +
    Parameters
    - +
    pwThe password used to authenticate as admin user.
    sidThe session ID of the user. Used to provide the information if the user has already voted for a specific track.
    -
    Returns
    On success the newly generated session ID is returned, an Error otherwise.
    +
    Returns
    On success the current queues and the current track are returned, an Error otherwise.
    -

    Implements NetworkListener.

    +

    Implements NetworkListener.

    - -

    ◆ moveTrack()

    + +

    ◆ moveTrack()

    @@ -278,7 +327,7 @@

    QueueType  - type  + toQueue  @@ -299,19 +348,19 @@

    sidThe session ID of the user. Used to authenticate as admin. trkidThe track to be moved. Has to be queried using queryMusic beforehand. - typeDetermines to which queue the track should be moved. + toQueueDetermines which queue the track should be moved to.
    Returns
    Returns an Error if something went wrong.
    Note
    To move a track from and to any queue, the user must have been authenticated as admin when generating the session ID!
    -

    Implements NetworkListener.

    +

    Implements NetworkListener.

    - -

    ◆ queryTracks()

    + +

    ◆ queryTracks()

    @@ -320,7 +369,7 @@

    - + @@ -354,7 +403,7 @@

    Returns
    On success the a maximum of nrOfEntries tracks are returned, an Error otherwise.
    -

    Implements NetworkListener.

    +

    Implements NetworkListener.

    @@ -406,6 +455,44 @@

    NetworkListener.

    + + + +

    ◆ start()

    + +
    +
    +

    TResult< vector< Track > > JukeBox::queryTracks TResult< vector< BaseTrack > > JukeBox::queryTracks ( std::string const &  searchPattern,
    + + + + + + + + + + + + + + + + + +
    bool JukeBox::start (std::string const & exeName,
    std::string const & configFilePath 
    )
    +

    + +

    Initializes ConfigHandler, LoggingHandler as well as the MusicBackend.

    +

    After initializing all handlers and interfaces it starts to handle incoming requests using the NetworkAPI.

    Parameters
    + + + +
    exeNameName of the currently running executable.
    configFilePathPath to *.ini config file, relative to executable.
    +
    +
    +
    Returns
    true on success, false otherwise.
    +
    @@ -454,7 +541,6 @@

    sidThe session ID of the user. Used to authenticate as admin if needed. trkidThe ID of the track to add to a queue. Has to be queried using queryMusic beforehand. - typeDetermines to which queue the track should be added. voteDetermines if a vote is set or revoked. There cannot be more than 1 or less than 0 votes from the same user on the same track! diff --git a/docs/html/classMusicBackend-members.html b/docs/html/classMusicBackend-members.html index 81f55a3..a684f59 100644 --- a/docs/html/classMusicBackend-members.html +++ b/docs/html/classMusicBackend-members.html @@ -68,14 +68,16 @@

    This is the complete list of members for MusicBackend, including all inherited members.

    - - - - - - - - + + + + + + + + + +
    getCurrentPlayback(void)=0 (defined in MusicBackend)MusicBackendpure virtual
    getVolume(void)=0 (defined in MusicBackend)MusicBackendpure virtual
    initBackend(void)=0 (defined in MusicBackend)MusicBackendpure virtual
    pause(void)=0 (defined in MusicBackend)MusicBackendpure virtual
    play()=0 (defined in MusicBackend)MusicBackendpure virtual
    queryTracks(std::string const &pattern, size_t const num)=0 (defined in MusicBackend)MusicBackendpure virtual
    setPlayback(Track const &track)=0 (defined in MusicBackend)MusicBackendpure virtual
    setVolume(size_t const percent)=0 (defined in MusicBackend)MusicBackendpure virtual
    createBaseTrack(TTrackID const &trackID)=0MusicBackendpure virtual
    getCurrentPlayback()=0MusicBackendpure virtual
    getVolume()=0MusicBackendpure virtual
    initBackend()=0MusicBackendpure virtual
    pause()=0MusicBackendpure virtual
    play()=0MusicBackendpure virtual
    queryTracks(std::string const &pattern, size_t const num)=0MusicBackendpure virtual
    setPlayback(BaseTrack const &track)=0MusicBackendpure virtual
    setVolume(size_t const percent)=0MusicBackendpure virtual
    ~MusicBackend() (defined in MusicBackend)MusicBackendinlinevirtual
    diff --git a/docs/html/classMusicBackend.html b/docs/html/classMusicBackend.html index 6db7f91..0880423 100644 --- a/docs/html/classMusicBackend.html +++ b/docs/html/classMusicBackend.html @@ -68,43 +68,334 @@
    MusicBackend Class Referenceabstract
    + +

    Provides an abstracted interface to a MusicBackend s. + More...

    + +

    #include <MusicBackend.h>

    Inheritance diagram for MusicBackend:
    -SpotifyBackend +SpotifyBackend
    - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - + + + + + + + + +

    Public Member Functions

    -virtual TResultOpt initBackend (void)=0
     
    -virtual TResult< std::vector< Track > > queryTracks (std::string const &pattern, size_t const num)=0
     
    -virtual TResultOpt setPlayback (Track const &track)=0
     
    -virtual TResult< PlaybackTrack > getCurrentPlayback (void)=0
     
    -virtual TResultOpt pause (void)=0
     
    -virtual TResultOpt play ()=0
    +virtual TResultOpt initBackend ()=0
     Initalizes the backend.
     
    virtual TResult< std::vector< BaseTrack > > queryTracks (std::string const &pattern, size_t const num)=0
     Queries the backend for all tracks given a pattern. More...
     
    virtual TResultOpt setPlayback (BaseTrack const &track)=0
     Set the given track as playback (means the track gets played). More...
     
    virtual TResult< std::optional< PlaybackTrack > > getCurrentPlayback ()=0
     Returns the current playback of the active device as a playback track. More...
     
    virtual TResultOpt pause ()=0
     Pauses the current playback. More...
     
    virtual TResultOpt play ()=0
     Resumes the current playback. More...
     
    -virtual TResult< size_t > getVolume (void)=0
     
    -virtual TResultOpt setVolume (size_t const percent)=0
    virtual TResult< size_t > getVolume ()=0
     Returns the volume of the actual device in percent. More...
     
    virtual TResultOpt setVolume (size_t const percent)=0
     Sets a new volume. More...
     
    virtual TResult< BaseTrack > createBaseTrack (TTrackID const &trackID)=0
     Creates a new BaseTrack instance with the given trackID. More...
     
    +

    Detailed Description

    +

    Provides an abstracted interface to a MusicBackend s.

    +

    Member Function Documentation

    + +

    ◆ createBaseTrack()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResult<BaseTrack> MusicBackend::createBaseTrack (TTrackID const & trackID)
    +     		+pure virtual
    +
    + +

    Creates a new BaseTrack instance with the given trackID.

    +
    Parameters
    + + +
    trackIDUnique track ID (returned for example by queryTracks).
    +
    +
    +
    Returns
    New BaseTrack object on success, Error otherwise
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ getCurrentPlayback()

    + +
    +
    + + + + + +
    + + + + + + + +
    virtual TResult<std::optional<PlaybackTrack> > MusicBackend::getCurrentPlayback ()
    +     		+pure virtual
    +
    + +

    Returns the current playback of the active device as a playback track.

    +
    Returns
    Current playback track on success (or nothing if no track is currently playing), otherwise Error.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ getVolume()

    + +
    +
    + + + + + +
    + + + + + + + +
    virtual TResult<size_t> MusicBackend::getVolume ()
    +     		+pure virtual
    +
    + +

    Returns the volume of the actual device in percent.

    +
    Returns
    Volume in percent on success, otherwise Error.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ pause()

    + +
    +
    + + + + + +
    + + + + + + + +
    virtual TResultOpt MusicBackend::pause ()
    +     		+pure virtual
    +
    + +

    Pauses the current playback.

    +
    Returns
    Returns an Error on failure.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ play()

    + +
    +
    + + + + +
    + + + + + + + +
    virtual TResultOpt MusicBackend::play ()
    +     		+pure virtual
    +
    + +

    Resumes the current playback.

    +
    Returns
    Returns an Error on failure.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ queryTracks()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    virtual TResult<std::vector<BaseTrack> > MusicBackend::queryTracks (std::string const & pattern,
    size_t const num 
    )
    +     		+pure virtual
    +
    + +

    Queries the backend for all tracks given a pattern.

    +
    Parameters
    + + + +
    patternSearch patten (wildcard support depends on the backend).
    numMaximum number of returned tracks (maximum is 50).
    +
    +
    +
    Returns
    On success returns a vector of BaseTrack, otherwise Error.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ setPlayback()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResultOpt MusicBackend::setPlayback (BaseTrack const & track)
    +     		+pure virtual
    +
    + +

    Set the given track as playback (means the track gets played).

    +
    Parameters
    + + +
    tracktrack to play
    +
    +
    +
    Returns
    Returns an Error on failure.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    + +

    ◆ setVolume()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResultOpt MusicBackend::setVolume (size_t const percent)
    +     		+pure virtual
    +
    + +

    Sets a new volume.

    +

    If a device is given in the ini file, this device gets selected. If no such device is given, the actual active device is used.

    Parameters
    + + +
    percentVolume in percent.
    +
    +
    +
    Returns
    Returns an Error on failure.
    + +

    Implemented in SpotifyBackend.

    + +
    +
    The documentation for this class was generated from the following file: diff --git a/docs/html/classNetworkAPI-members.html b/docs/html/classNetworkAPI-members.html index 0a7d132..9ea55be 100644 --- a/docs/html/classNetworkAPI-members.html +++ b/docs/html/classNetworkAPI-members.html @@ -72,6 +72,7 @@ listener (defined in NetworkAPI)NetworkAPIprotected NetworkAPI() (defined in NetworkAPI)NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI)NetworkAPI + ~NetworkAPI() (defined in NetworkAPI)NetworkAPIinlinevirtual
    diff --git a/docs/html/classNetworkListener-members.html b/docs/html/classNetworkListener-members.html index b6f3153..a3cfb07 100644 --- a/docs/html/classNetworkListener-members.html +++ b/docs/html/classNetworkListener-members.html @@ -70,11 +70,12 @@ - - - - - + + + + + +
    addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0NetworkListenerpure virtual
    controlPlayer(TSessionID const &sid, PlayerAction action)=0NetworkListenerpure virtual
    generateSession(TPassword const &pw)=0NetworkListenerpure virtual
    moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0NetworkListenerpure virtual
    queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0NetworkListenerpure virtual
    removeTrack(TSessionID const &sid, TTrackID const &trkid)=0NetworkListenerpure virtual
    voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0NetworkListenerpure virtual
    generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname)=0NetworkListenerpure virtual
    getCurrentQueues(TSessionID const &sid)=0NetworkListenerpure virtual
    moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue)=0NetworkListenerpure virtual
    queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0NetworkListenerpure virtual
    removeTrack(TSessionID const &sid, TTrackID const &trkid)=0NetworkListenerpure virtual
    voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0NetworkListenerpure virtual
    diff --git a/docs/html/classNetworkListener.html b/docs/html/classNetworkListener.html index 1977b21..c23d047 100644 --- a/docs/html/classNetworkListener.html +++ b/docs/html/classNetworkListener.html @@ -79,20 +79,23 @@
    -JukeBox +JukeBox
    - - - - - - + + + + + + + + + - + @@ -103,9 +106,9 @@ - - - + + +

    Public Member Functions

    virtual TResult< TSessionID > generateSession (TPassword const &pw)=0
     Generate a session for an user. More...
     
    virtual TResult< std::vector< Track > > queryTracks (std::string const &searchPattern, size_t const nrOfEntries)=0
     Query available tracks using different music backends. More...
     
    virtual TResult< TSessionID > generateSession (std::optional< TPassword > const &pw, std::optional< std::string > const &nickname)=0
     Generate a session for an user. More...
     
    virtual TResult< std::vector< BaseTrack > > queryTracks (std::string const &searchPattern, size_t const nrOfEntries)=0
     Query available tracks using different music backends. More...
     
    virtual TResult< QueueStatus > getCurrentQueues (TSessionID const &sid)=0
     Query the content of the current queues. More...
     
    virtual TResultOpt addTrackToQueue (TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
     Querie the content of the current queues. More...
     Add a track to a given queue (normal or admin). More...
     
    virtual TResultOpt voteTrack (TSessionID const &sid, TTrackID const &trkid, TVote vote)=0
     Vote for a track or revoke a vote. More...
    virtual TResultOpt removeTrack (TSessionID const &sid, TTrackID const &trkid)=0
     Remove a track from a queue. More...
     
    virtual TResultOpt moveTrack (TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
     Move a track between queues. More...
     
    virtual TResultOpt moveTrack (TSessionID const &sid, TTrackID const &trkid, QueueType toQueue)=0
     Move a track between queues. More...
     

    Detailed Description

    Provides interface methods for all supported requests.

    @@ -151,10 +154,7 @@

    -

    Querie the content of the current queues.

    -

    Additionally to the current normal and admin queue, the currently playing track is returned as well (if any).

    -
    Returns
    On success the current queues and the current track are returned, an Error otherwise.
    -

    Add a track to a given queue (normal or admin).

    +

    Add a track to a given queue (normal or admin).

    Depending on the value of type a track is added to either the normal or the admin queue. If the track is not found, or the user has no permission to add the track to the specified queue, an error is returned.

    Parameters
    @@ -221,8 +221,8 @@

    -

    ◆ generateSession()

    + +

    ◆ generateSession()

    @@ -233,9 +233,19 @@

    virtual TResult<TSessionID> NetworkListener::generateSession

    - - + + + + + + + + + + + +
    (TPassword const & pw)std::optional< TPassword > const & pw,
    std::optional< std::string > const & nickname 
    )
    @@ -248,18 +258,57 @@

    Parameters
    - + +
    pwThe password used to authenticate as admin user.
    pw(optional) Password to authenticate the user as an admin.
    nickname(optional) A human readable nickname for the user.

    -
    Returns
    On success the newly generated session ID is returned, an Error otherwise.
    +
    Returns
    The created Session ID string on success, Error otherwise.
    -

    Implemented in JukeBox.

    +

    Implemented in JukeBox.

    - -

    ◆ moveTrack()

    + +

    ◆ getCurrentQueues()

    + +
    +
    + + + + + +
    + + + + + + + + +
    virtual TResult<QueueStatus> NetworkListener::getCurrentQueues (TSessionID const & sid)
    +     		+pure virtual
    +
    + +

    Query the content of the current queues.

    +

    Additionally to the current normal and admin queue, the currently playing track is returned as well (if any).

    +
    Parameters
    + + +
    sidThe session ID of the user. Used to provide the information if the user has already voted for a specific track.
    +
    +
    +
    Returns
    On success the current queues and the current track are returned, an Error otherwise.
    + +

    Implemented in JukeBox.

    + +
    +
    + +

    ◆ moveTrack()

    @@ -283,7 +332,7 @@

    QueueType  - type  + toQueue  @@ -304,19 +353,19 @@

    sidThe session ID of the user. Used to authenticate as admin. trkidThe track to be moved. Has to be queried using queryMusic beforehand. - typeDetermines to which queue the track should be moved. + toQueueDetermines which queue the track should be moved to.
    Returns
    Returns an Error if something went wrong.
    Note
    To move a track from and to any queue, the user must have been authenticated as admin when generating the session ID!
    -

    Implemented in JukeBox.

    +

    Implemented in JukeBox.

    - -

    ◆ queryTracks()

    + +

    ◆ queryTracks()

    @@ -325,7 +374,7 @@

    - + @@ -359,7 +408,7 @@

    Returns
    On success the a maximum of nrOfEntries tracks are returned, an Error otherwise.
    -

    Implemented in JukeBox.

    +

    Implemented in JukeBox.

    @@ -459,7 +508,6 @@

    -
    virtual TResult<std::vector<Track> > NetworkListener::queryTracks virtual TResult<std::vector<BaseTrack> > NetworkListener::queryTracks ( std::string const &  searchPattern,
    sidThe session ID of the user. Used to authenticate as admin if needed.
    trkidThe ID of the track to add to a queue. Has to be queried using queryMusic beforehand.
    typeDetermines to which queue the track should be added.
    voteDetermines if a vote is set or revoked. There cannot be more than 1 or less than 0 votes from the same user on the same track!
     diff --git a/docs/html/classRAMDataStore-members.html b/docs/html/classRAMDataStore-members.html new file mode 100644 index 0000000..2096df5 --- /dev/null +++ b/docs/html/classRAMDataStore-members.html @@ -0,0 +1,93 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    RAMDataStore Member List
    +
    +
    + +

    This is the complete list of members for RAMDataStore, including all inherited members.

    + + + + + + + + + + + + + + + +
    addTrack(BaseTrack const &track, QueueType q) overrideRAMDataStorevirtual
    addUser(User const &user) overrideRAMDataStorevirtual
    cSessionTimeoutAfterSeconds (defined in DataStore)DataStorestatic
    getPlayingTrack() overrideRAMDataStorevirtual
    getQueue(QueueType q) overrideRAMDataStorevirtual
    getUser(TSessionID const &ID) overrideRAMDataStorevirtual
    hasTrack(TTrackID const &ID, QueueType q) overrideRAMDataStorevirtual
    hasUser(TSessionID const &ID) overrideRAMDataStorevirtual
    isSessionExpired(TSessionID const &ID) overrideRAMDataStorevirtual
    nextTrack() overrideRAMDataStorevirtual
    removeTrack(TTrackID const &ID, QueueType q) overrideRAMDataStorevirtual
    removeUser(TSessionID const &ID) overrideRAMDataStorevirtual
    voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) overrideRAMDataStorevirtual
    ~DataStore() (defined in DataStore)DataStoreinlinevirtual
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classRAMDataStore.html b/docs/html/classRAMDataStore.html new file mode 100644 index 0000000..7d3a77c --- /dev/null +++ b/docs/html/classRAMDataStore.html @@ -0,0 +1,633 @@ + + + + + + + +VirtualJukebox: RAMDataStore Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    RAMDataStore Class Reference
    +
    +
    + +

    Implements a DataStore which stores its data purly in RAM (no persistance). + More...

    + +

    #include <RAMDataStore.h>

    +
    +Inheritance diagram for RAMDataStore:
    +
    +
    + + +DataStore + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    TResultOpt addUser (User const &user) override
     Add a User to the internal List of registered Users. More...
     
    TResult< User > getUser (TSessionID const &ID) override
     Get a User from the internal List of registered Users. More...
     
    TResult< User > removeUser (TSessionID const &ID) override
     Remove a User from the internal List of registered Users. Does not remove votes taken by this user from the corresponding tracks. More...
     
    TResult< bool > isSessionExpired (TSessionID const &ID) override
     Check if user session is expired. More...
     
    TResultOpt addTrack (BaseTrack const &track, QueueType q) override
     Add Track to one of the internal Queues. More...
     
    TResult< BaseTrack > removeTrack (TTrackID const &ID, QueueType q) override
     Remove Track from one of the internal Queues. More...
     
    TResult< bool > hasTrack (TTrackID const &ID, QueueType q) override
     Check for Track in one of the internal Queues. More...
     
    TResultOpt voteTrack (TSessionID const &sID, TTrackID const &tID, TVote vote) override
     Upvote/remove Upvote from a track. More...
     
    TResult< Queue > getQueue (QueueType q) override
     Get entire Queue. More...
     
    TResult< std::optional< QueuedTrack > > getPlayingTrack () override
     Get the currently playing track. More...
     
    bool hasUser (TSessionID const &ID) override
     Query the internal user list whether a certain user exists. More...
     
    TResultOpt nextTrack () override
     Play next Track in Queue. More...
     
    + + + + +

    +Additional Inherited Members

    - Static Public Attributes inherited from DataStore
    +static const unsigned cSessionTimeoutAfterSeconds = 3600
     
    +

    Detailed Description

    +

    Implements a DataStore which stores its data purly in RAM (no persistance).

    +

    Member Function Documentation

    + +

    ◆ addTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    TResultOpt RAMDataStore::addTrack (BaseTrack const & track,
    QueueType q 
    )
    +     		+overridevirtual
    +
    + +

    Add Track to one of the internal Queues.

    +
    Parameters
    + + + +
    trackThe Track to add
    qIdentifier for determining which Queue the Track should be added to
    +
    +
    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ addUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResultOpt RAMDataStore::addUser (User const & user)
    +     		+overridevirtual
    +
    + +

    Add a User to the internal List of registered Users.

    +
    Parameters
    + + +
    userThe User class to add
    +
    +
    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ getPlayingTrack()

    + +
    +
    + + + + + +
    + + + + + + + +
    TResult< optional< QueuedTrack > > RAMDataStore::getPlayingTrack ()
    +     		+overridevirtual
    +
    + +

    Get the currently playing track.

    +
    Returns
    Returns the currently playing track (if any) or an Error message.
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ getQueue()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResult< Queue > RAMDataStore::getQueue (QueueType q)
    +     		+overridevirtual
    +
    + +

    Get entire Queue.

    +
    Parameters
    + + +
    qIdentifier for determining which Queue should be returned
    +
    +
    +
    Returns
    Either the requested Queue or an Error message.
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ getUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResult< User > RAMDataStore::getUser (TSessionID const & sID)
    +     		+overridevirtual
    +
    + +

    Get a User from the internal List of registered Users.

    +
    Parameters
    + + +
    sIDThe ID of the User we want to get
    +
    +
    +
    Returns
    Either the requested user or an Error message.
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ hasTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    TResult< bool > RAMDataStore::hasTrack (TTrackID const & tID,
    QueueType q 
    )
    +     		+overridevirtual
    +
    + +

    Check for Track in one of the internal Queues.

    +
    Parameters
    + + + +
    tIDThe ID of the Track to check for
    qIdentifier for determining which Queue should be checked for the Track
    +
    +
    +
    Returns
    Either a boolean answer or an Error message.
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ hasUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    bool RAMDataStore::hasUser (TSessionID const & sID)
    +     		+overridevirtual
    +
    + +

    Query the internal user list whether a certain user exists.

    +
    Parameters
    + + +
    sIDThe ID of the user to check for
    +
    +
    +
    Returns
    true if an user with this ID exists, false otherwise
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ isSessionExpired()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResult< bool > RAMDataStore::isSessionExpired (TSessionID const & sID)
    +     		+overridevirtual
    +
    + +

    Check if user session is expired.

    +
    Parameters
    + + +
    sIDSession ID of the user to check
    +
    +
    +
    Return values
    + + +
    Returnsfalse if session is not expired yet. Returns an Error object on session expiration or error.
    +
    +
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ nextTrack()

    + +
    +
    + + + + + +
    + + + + + + + +
    TResultOpt RAMDataStore::nextTrack ()
    +     		+overridevirtual
    +
    + +

    Play next Track in Queue.

    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ removeTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    TResult< BaseTrack > RAMDataStore::removeTrack (TTrackID const & tID,
    QueueType q 
    )
    +     		+overridevirtual
    +
    + +

    Remove Track from one of the internal Queues.

    +
    Parameters
    + + + +
    tIDThe ID of the Track to remove
    qIdentifier for determining which Queue the Track should be removed from
    +
    +
    +
    Returns
    Either the removed track or an Error message.
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ removeUser()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResult< User > RAMDataStore::removeUser (TSessionID const & sID)
    +     		+overridevirtual
    +
    + +

    Remove a User from the internal List of registered Users. Does not remove votes taken by this user from the corresponding tracks.

    +
    Parameters
    + + +
    sIDID number of the User to remove
    +
    +
    +
    Returns
    Either the user that was removed or an Error message.
    + +

    Implements DataStore.

    + +
    +
    + +

    ◆ voteTrack()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    TResultOpt RAMDataStore::voteTrack (TSessionID const & sID,
    TTrackID const & tID,
    TVote vote 
    )
    +     		+overridevirtual
    +
    + +

    Upvote/remove Upvote from a track.

    +
    Parameters
    + + + + +
    sIDThe ID of the User who wants to vote
    tIDThe ID of the Track to vote for
    voteThe Vote which determines whether a new upvote should be made or an old one removed
    +
    +
    +
    Returns
    An Error message or nothing at all (at success).
    + +

    Implements DataStore.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classRAMDataStore.png b/docs/html/classRAMDataStore.png new file mode 100644 index 0000000000000000000000000000000000000000..48283f4b39a078f4a71c89821a3b999646dc645c GIT binary patch literal 488 zcmeAS@N?(olHy`uVBq!ia0vp^2|ygc!3-oX+B7T&QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;M2~-G0DWATfuW(9k;+d{oi|ex5{}|tuAk{doA#j z^FZGB&ta2=rO!WGRqdHo!scQ5I`8zAqh;rBubUfo!9-=JcBo^Pif8Y-EgH{P#lFa@ zG8FxPU#a-y^5y%DT+11@YiWquUw=FI*^`J=rpd#!$=%FZYT&!VrQ4HC(7 zG#a9-7|vYDIq=wUrh)W^r}MpM@cn4gjACGj=Vo}2#mEq&%h0fzm7!oO1H(Eoh67jS zSy}`R`3N#R%LK~R@)g{v_!PQ(z1p>wOUY~5H_YcUcore_ob$!zZM*+)H#lBr+H#qqsj|b-C*+AxJ&zZhV3-lJB{oa(m~!i3~sfoD@~XFnzJ`E@LcL{1BN$8 zN_01=@;5AWeYR43xjpNb%sj?*Apw`BboJLCw=ve7lE3ZV!_}HhGZsSKWyi>&*wXon ZU3-listener (defined in NetworkAPI)NetworkAPIprotected NetworkAPI() (defined in NetworkAPI)NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI)NetworkAPI + stopServer() (defined in RestAPI)RestAPI + ~NetworkAPI() (defined in NetworkAPI)NetworkAPIinlinevirtual

    diff --git a/docs/html/classRestAPI.html b/docs/html/classRestAPI.html index 82f3c50..e6e4273 100644 --- a/docs/html/classRestAPI.html +++ b/docs/html/classRestAPI.html @@ -88,6 +88,9 @@ TResultOpt handleRequests () override   + +void stopServer () +  - Public Member Functions inherited from NetworkAPI void setListener (NetworkListener *) @@ -104,8 +107,8 @@

    Implementation of the REST API.

    See also
    NetworkAPI, NetworkListener
    The documentation for this class was generated from the following files:
    diff --git a/docs/html/classRestRequestHandler-members.html b/docs/html/classRestRequestHandler-members.html new file mode 100644 index 0000000..f3b4d44 --- /dev/null +++ b/docs/html/classRestRequestHandler-members.html @@ -0,0 +1,83 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    RestRequestHandler Member List
    +
    +
    + +

    This is the complete list of members for RestRequestHandler, including all inherited members.

    + + + + + +
    InternalErrorHandler(httpserver::http_request const &req) (defined in RestRequestHandler)RestRequestHandlerstatic
    NotAllowedHandler(httpserver::http_request const &req) (defined in RestRequestHandler)RestRequestHandlerstatic
    NotFoundHandler(httpserver::http_request const &req) (defined in RestRequestHandler)RestRequestHandlerstatic
    RestRequestHandler(NetworkListener *listener) (defined in RestRequestHandler)RestRequestHandler
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classRestRequestHandler.html b/docs/html/classRestRequestHandler.html new file mode 100644 index 0000000..94e0118 --- /dev/null +++ b/docs/html/classRestRequestHandler.html @@ -0,0 +1,117 @@ + + + + + + + +VirtualJukebox: RestRequestHandler Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    RestRequestHandler Class Reference
    +
    +
    + +

    Provides a REST request handler for incoming connections. + More...

    + +

    #include <RestRequestHandler.h>

    +
    +Inheritance diagram for RestRequestHandler:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + RestRequestHandler (NetworkListener *listener)
     
    + + + + + + + +

    +Static Public Member Functions

    +static const std::shared_ptr< httpserver::http_response > NotFoundHandler (httpserver::http_request const &req)
     
    +static const std::shared_ptr< httpserver::http_response > NotAllowedHandler (httpserver::http_request const &req)
     
    +static const std::shared_ptr< httpserver::http_response > InternalErrorHandler (httpserver::http_request const &req)
     
    +

    Detailed Description

    +

    Provides a REST request handler for incoming connections.

    +

    Is used to validate and dispatch incoming requests. If a valid request has found the assigned NetworkListener is notified.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classRestRequestHandler.png b/docs/html/classRestRequestHandler.png new file mode 100644 index 0000000000000000000000000000000000000000..cd147f198bec97268f86f4013739717ab091cba8 GIT binary patch literal 530 zcmV+t0`2{YP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0004@Nklz)l7ckpk`$qDr6>Dx zyKaBqOShH0{iO%*+g#i4bX{**-ap>`9lA+*lt*wp`Ve=k{NuyBfAaO}l`og2rWcjF zguay|o%|ho3X`Np@8w=J<~Vmr>gri~RrkT}Qe<73H*(+Fz3KVf%tdE!p|$^&o|lxz zMX&s?=;@!bBz;DIB6mr;K$9*>5elc9nMDcU4c!336iUC{BJrX01s;fxrT^=mpLBo_ zO*%k?CLJI`lMWD}Ne76~qyt1~(g7kg=>V_E%q&b8K#(RKAVOb4-&+vyV=;8?0JYZG z;|D;g(+lL0>Ai`^oM-T#p{G>W>-j>K_T4y&b&kc7=M)pp(2AZG_M^6+^lq$oWKRy* zH!-NYTezru0c_|lHm}^>)*Q1eH|wqAVQN45TS6onOT&60JlR* UL0ewMd;kCd07*qoM6N<$g7*smG5`Po literal 0 HcmV?d00001 diff --git a/docs/html/classSerializer-members.html b/docs/html/classSerializer-members.html new file mode 100644 index 0000000..10a5de3 --- /dev/null +++ b/docs/html/classSerializer-members.html @@ -0,0 +1,83 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    Serializer Member List
    +
    +
    + +

    This is the complete list of members for Serializer, including all inherited members.

    + + + + + +
    serialize(T const &) (defined in Serializer)Serializerstatic
    serialize(BaseTrack const &track) (defined in Serializer)Serializerstatic
    serialize(QueuedTrack const &track) (defined in Serializer)Serializerstatic
    serialize(PlaybackTrack const &track) (defined in Serializer)Serializerstatic
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSerializer.html b/docs/html/classSerializer.html new file mode 100644 index 0000000..38467aa --- /dev/null +++ b/docs/html/classSerializer.html @@ -0,0 +1,110 @@ + + + + + + + +VirtualJukebox: Serializer Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Static Public Member Functions | +List of all members
    +
    +
    Serializer Class Reference
    +
    +
    + +

    Template class which can be used as a central class for serialization routines for different data types. + More...

    + +

    #include <Serializer.h>

    + + + + + + + + + + + + + + +

    +Static Public Member Functions

    +template<class T >
    static nlohmann::json serialize (T const &)
     
    +template<>
    json serialize (BaseTrack const &track)
     
    +template<>
    json serialize (QueuedTrack const &track)
     
    +template<>
    json serialize (PlaybackTrack const &track)
     
    +

    Detailed Description

    +

    Template class which can be used as a central class for serialization routines for different data types.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSimpleScheduler-members.html b/docs/html/classSimpleScheduler-members.html new file mode 100644 index 0000000..e654cc1 --- /dev/null +++ b/docs/html/classSimpleScheduler-members.html @@ -0,0 +1,85 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    SimpleScheduler Member List
    +
    +
    + +

    This is the complete list of members for SimpleScheduler, including all inherited members.

    + + + + + + + +
    checkForInconsistency()SimpleScheduler
    getLastPlayback()SimpleScheduler
    nextTrack()SimpleScheduler
    SimpleScheduler(DataStore *const datastore, MusicBackend *const musicbackend) (defined in SimpleScheduler)SimpleScheduler
    start()SimpleScheduler
    ~SimpleScheduler() (defined in SimpleScheduler)SimpleScheduler
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSimpleScheduler.html b/docs/html/classSimpleScheduler.html new file mode 100644 index 0000000..b9a7e8d --- /dev/null +++ b/docs/html/classSimpleScheduler.html @@ -0,0 +1,171 @@ + + + + + + + +VirtualJukebox: SimpleScheduler Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SimpleScheduler Class Reference
    +
    +
    + +

    A simple track scheduler (for presentation purposes). + More...

    + +

    #include <SimpleScheduler.h>

    + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SimpleScheduler (DataStore *const datastore, MusicBackend *const musicbackend)
     
    +void start ()
     Starts the scheduler thread.
     
    TResult< std::optional< PlaybackTrack > > const & getLastPlayback ()
     returns the last polled playback status More...
     
    TResultOpt nextTrack ()
     plays the next song from the queue More...
     
    bool checkForInconsistency ()
     returns true if actual track from datastore and playback needs to be checked if they are equal More...
     
    +

    Detailed Description

    +

    A simple track scheduler (for presentation purposes).

    +

    Member Function Documentation

    + +

    ◆ checkForInconsistency()

    + +
    +
    + + + + + + + +
    bool SimpleScheduler::checkForInconsistency ()
    +
    + +

    returns true if actual track from datastore and playback needs to be checked if they are equal

    +
    Returns
    true if check is required else false
    + +
    +
    + +

    ◆ getLastPlayback()

    + +
    +
    + + + + + + + +
    const TResult< std::optional< PlaybackTrack > > & SimpleScheduler::getLastPlayback ()
    +
    + +

    returns the last polled playback status

    +
    Returns
    returns playback status
    + +
    +
    + +

    ◆ nextTrack()

    + +
    +
    + + + + + + + +
    TResultOpt SimpleScheduler::nextTrack ()
    +
    + +

    plays the next song from the queue

    +
    Returns
    Error on failure, otherwise nullopt
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Album-members.html b/docs/html/classSpotifyApi_1_1Album-members.html new file mode 100644 index 0000000..9a77f73 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Album-members.html @@ -0,0 +1,94 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Album Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Album, including all inherited members.

    + + + + + + + + + + + + +
    Album()=default (defined in SpotifyApi::Album)SpotifyApi::Album
    Album(nlohmann::json const &albumJson) (defined in SpotifyApi::Album)SpotifyApi::Album
    getAlbumType() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getArtists() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getHref() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getId() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getImages() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getName() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getReleaseDate() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getType() const (defined in SpotifyApi::Album)SpotifyApi::Album
    getUri() const (defined in SpotifyApi::Album)SpotifyApi::Album
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Album.html b/docs/html/classSpotifyApi_1_1Album.html new file mode 100644 index 0000000..71155a7 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Album.html @@ -0,0 +1,128 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Album Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Album Class Reference
    +
    +
    + +

    Simplified Spotify Album class. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Album (nlohmann::json const &albumJson)
     
    +const std::vector< Artist > & getArtists () const
     
    +const std::vector< Image > & getImages () const
     
    +const std::string & getAlbumType () const
     
    +const std::string & getHref () const
     
    +const std::string & getId () const
     
    +const std::string & getName () const
     
    +const std::string & getReleaseDate () const
     
    +const std::string & getType () const
     
    +const std::string & getUri () const
     
    +

    Detailed Description

    +

    Simplified Spotify Album class.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Artist-members.html b/docs/html/classSpotifyApi_1_1Artist-members.html new file mode 100644 index 0000000..ab4d5a2 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Artist-members.html @@ -0,0 +1,90 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Artist Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Artist, including all inherited members.

    + + + + + + + + +
    Artist()=default (defined in SpotifyApi::Artist)SpotifyApi::Artist
    Artist(nlohmann::json const &artistJson) (defined in SpotifyApi::Artist)SpotifyApi::Artist
    getHref() const (defined in SpotifyApi::Artist)SpotifyApi::Artist
    getID() const (defined in SpotifyApi::Artist)SpotifyApi::Artist
    getName() const (defined in SpotifyApi::Artist)SpotifyApi::Artist
    getType() const (defined in SpotifyApi::Artist)SpotifyApi::Artist
    getUri() const (defined in SpotifyApi::Artist)SpotifyApi::Artist
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Artist.html b/docs/html/classSpotifyApi_1_1Artist.html new file mode 100644 index 0000000..fce6cf9 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Artist.html @@ -0,0 +1,116 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Artist Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Artist Class Reference
    +
    +
    + +

    Simplified artist object. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + +

    +Public Member Functions

    + Artist (nlohmann::json const &artistJson)
     
    +const std::string & getHref () const
     
    +const std::string & getID () const
     
    +const std::string & getName () const
     
    +const std::string & getType () const
     
    +const std::string & getUri () const
     
    +

    Detailed Description

    +

    Simplified artist object.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Device-members.html b/docs/html/classSpotifyApi_1_1Device-members.html new file mode 100644 index 0000000..6d35006 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Device-members.html @@ -0,0 +1,92 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Device Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Device, including all inherited members.

    + + + + + + + + + + +
    Device()=default (defined in SpotifyApi::Device)SpotifyApi::Device
    Device(nlohmann::json const &deviceJson) (defined in SpotifyApi::Device)SpotifyApi::Device
    getID() const (defined in SpotifyApi::Device)SpotifyApi::Device
    getName() const (defined in SpotifyApi::Device)SpotifyApi::Device
    getType() const (defined in SpotifyApi::Device)SpotifyApi::Device
    getVolume() const (defined in SpotifyApi::Device)SpotifyApi::Device
    isActive() const (defined in SpotifyApi::Device)SpotifyApi::Device
    isPrivateSession() const (defined in SpotifyApi::Device)SpotifyApi::Device
    isRestricted() const (defined in SpotifyApi::Device)SpotifyApi::Device
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Device.html b/docs/html/classSpotifyApi_1_1Device.html new file mode 100644 index 0000000..86e9894 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Device.html @@ -0,0 +1,122 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Device Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Device Class Reference
    +
    +
    + +

    Device Object. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Device (nlohmann::json const &deviceJson)
     
    +const std::string & getID () const
     
    +bool isActive () const
     
    +bool isPrivateSession () const
     
    +bool isRestricted () const
     
    +const std::string & getName () const
     
    +const std::string & getType () const
     
    +size_t getVolume () const
     
    +

    Detailed Description

    +

    Device Object.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Devices-members.html b/docs/html/classSpotifyApi_1_1Devices-members.html new file mode 100644 index 0000000..8b024c6 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Devices-members.html @@ -0,0 +1,86 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Devices Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Devices, including all inherited members.

    + + + + +
    Devices()=default (defined in SpotifyApi::Devices)SpotifyApi::Devices
    Devices(nlohmann::json const &devicesJson) (defined in SpotifyApi::Devices)SpotifyApi::Devicesinline
    mDevices (defined in SpotifyApi::Devices)SpotifyApi::Devices
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Devices.html b/docs/html/classSpotifyApi_1_1Devices.html new file mode 100644 index 0000000..861ff0b --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Devices.html @@ -0,0 +1,107 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Devices Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Public Attributes | +List of all members
    +
    +
    SpotifyApi::Devices Class Reference
    +
    +
    + +

    Wrapper class for multiple devices. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + +

    +Public Member Functions

    + Devices (nlohmann::json const &devicesJson)
     
    + + + +

    +Public Attributes

    +std::vector< Device > mDevices
     
    +

    Detailed Description

    +

    Wrapper class for multiple devices.

    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Image-members.html b/docs/html/classSpotifyApi_1_1Image-members.html new file mode 100644 index 0000000..bda8836 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Image-members.html @@ -0,0 +1,88 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Image Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Image, including all inherited members.

    + + + + + + +
    getHeight() (defined in SpotifyApi::Image)SpotifyApi::Image
    getUrl() const (defined in SpotifyApi::Image)SpotifyApi::Image
    getWidth() (defined in SpotifyApi::Image)SpotifyApi::Image
    Image()=default (defined in SpotifyApi::Image)SpotifyApi::Image
    Image(nlohmann::json const &imageJson) (defined in SpotifyApi::Image)SpotifyApi::Image
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Image.html b/docs/html/classSpotifyApi_1_1Image.html new file mode 100644 index 0000000..4a1e93a --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Image.html @@ -0,0 +1,110 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Image Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Image Class Reference
    +
    +
    + +

    Spotify Image Class. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + +

    +Public Member Functions

    + Image (nlohmann::json const &imageJson)
     
    +int getHeight ()
     
    +int getWidth ()
     
    +const std::string & getUrl () const
     
    +

    Detailed Description

    +

    Spotify Image Class.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Playback-members.html b/docs/html/classSpotifyApi_1_1Playback-members.html new file mode 100644 index 0000000..879c9e7 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Playback-members.html @@ -0,0 +1,93 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Playback Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Playback, including all inherited members.

    + + + + + + + + + + + +
    getCurrentPlayingTrack() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    getCurrentPlayingType() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    getDevice() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    getProgressMs() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    getRepeatState() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    getShuffleState() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    getTimestamp() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    isPlaying() const (defined in SpotifyApi::Playback)SpotifyApi::Playback
    Playback()=default (defined in SpotifyApi::Playback)SpotifyApi::Playback
    Playback(nlohmann::json const &playbackJson) (defined in SpotifyApi::Playback)SpotifyApi::Playback
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Playback.html b/docs/html/classSpotifyApi_1_1Playback.html new file mode 100644 index 0000000..cdd48bd --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Playback.html @@ -0,0 +1,125 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Playback Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Playback Class Reference
    +
    +
    + +

    Contains infos about the actual playback. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Playback (nlohmann::json const &playbackJson)
     
    +const Device & getDevice () const
     
    +const std::string & getRepeatState () const
     
    +bool getShuffleState () const
     
    +size_t getTimestamp () const
     
    +size_t getProgressMs () const
     
    +bool isPlaying () const
     
    +const std::string & getCurrentPlayingType () const
     
    +const std::optional< Track > & getCurrentPlayingTrack () const
     
    +

    Detailed Description

    +

    Contains infos about the actual playback.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyAPI-members.html b/docs/html/classSpotifyApi_1_1SpotifyAPI-members.html new file mode 100644 index 0000000..3456132 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyAPI-members.html @@ -0,0 +1,95 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::SpotifyAPI Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::SpotifyAPI, including all inherited members.

    + + + + + + + + + + + + + +
    getAccessToken(GrantType grantType, std::string const &code, std::string const &redirectUri, std::string const &clientID, std::string const &clientSecret)SpotifyApi::SpotifyAPI
    getAvailableDevices(std::string const &accessToken)SpotifyApi::SpotifyAPI
    getCurrentPlayback(std::string const &accessToken, std::string const &market="AT")SpotifyApi::SpotifyAPI
    getTrack(std::string const &accessToken, std::string const &spotifyID, std::string const &market="AT")SpotifyApi::SpotifyAPI
    pause(std::string const &accessToken, Device const &device=Device())SpotifyApi::SpotifyAPI
    play(std::string const &accessToken, std::vector< std::string > const &uris=std::vector< std::string >(), Device const &device=Device(), int positionMs=0)SpotifyApi::SpotifyAPI
    refreshAccessToken(std::string const &refreshToken, std::string const &clientID, std::string const &clientSecret)SpotifyApi::SpotifyAPI
    search(std::string const &accessToken, std::string const &queryKey, QueryType type, int const limit=20, int const offset=0, std::string const &market="AT")SpotifyApi::SpotifyAPI
    setVolume(std::string const &accessToken, int volume, Device const &device=Device())SpotifyApi::SpotifyAPI
    stringBase64Encode(std::string const &str)SpotifyApi::SpotifyAPIstatic
    stringUrlEncode(std::string const &str)SpotifyApi::SpotifyAPIstatic
    transferUsersPlayback(std::string const &accessToken, std::vector< Device > const &devices, bool play=false)SpotifyApi::SpotifyAPI
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyAPI.html b/docs/html/classSpotifyApi_1_1SpotifyAPI.html new file mode 100644 index 0000000..a4542c6 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyAPI.html @@ -0,0 +1,669 @@ + + + + + + + +VirtualJukebox: SpotifyApi::SpotifyAPI Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    SpotifyApi::SpotifyAPI Class Reference
    +
    +
    + +

    handles the calls with the spotify web api + More...

    + +

    #include <SpotifyAPI.h>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    TResult< Token > getAccessToken (GrantType grantType, std::string const &code, std::string const &redirectUri, std::string const &clientID, std::string const &clientSecret)
     requests a Token (access token and refresh token) from the spotify web api More...
     
    TResult< Token > refreshAccessToken (std::string const &refreshToken, std::string const &clientID, std::string const &clientSecret)
     requests with the refresh token a new access token More...
     
    TResult< std::vector< Device > > getAvailableDevices (std::string const &accessToken)
     returns vector of available spotify devices More...
     
    TResult< std::optional< Playback > > getCurrentPlayback (std::string const &accessToken, std::string const &market="AT")
     gets the current playback status of the current active device from spotify More...
     
    TResult< SpotifyPaging > search (std::string const &accessToken, std::string const &queryKey, QueryType type, int const limit=20, int const offset=0, std::string const &market="AT")
     searches for tracks,artists,albums or playlists with the given query More...
     
    TResultOpt setVolume (std::string const &accessToken, int volume, Device const &device=Device())
     sets a volume More...
     
    TResultOpt pause (std::string const &accessToken, Device const &device=Device())
     pauses the acutal track More...
     
    TResultOpt play (std::string const &accessToken, std::vector< std::string > const &uris=std::vector< std::string >(), Device const &device=Device(), int positionMs=0)
     plays new songs, or resume the actual song More...
     
    TResult< Track > getTrack (std::string const &accessToken, std::string const &spotifyID, std::string const &market="AT")
     searches for the given track id and returns a simplified track object More...
     
    TResultOpt transferUsersPlayback (std::string const &accessToken, std::vector< Device > const &devices, bool play=false)
     enables a playback on the given device More...
     
    + + + + + + + +

    +Static Public Member Functions

    static std::string stringUrlEncode (std::string const &str)
     encodes the given string with http special characters More...
     
    static std::string stringBase64Encode (std::string const &str)
     encodes the given string with base64 More...
     
    +

    Detailed Description

    +

    handles the calls with the spotify web api

    +

    Member Function Documentation

    + +

    ◆ getAccessToken()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TResult< Token > SpotifyAPI::getAccessToken (GrantType grantType,
    std::string const & code,
    std::string const & redirectUri,
    std::string const & clientID,
    std::string const & clientSecret 
    )
    +
    + +

    requests a Token (access token and refresh token) from the spotify web api

    +
    Parameters
    + + + + + + +
    grantTypewhich authorization type to use
    codeauthentification code (received from Spotify Authorization)
    redirectUriredirection url (only for comparing)
    clientIDclientID (from spotify developers dashboard)
    clientSecretclientSecret (from spotify developers dashboard)
    +
    +
    +

    this function fetches a token from the spotify web api. until now, only the GrantType AuthorizationCode is implemented.

    Returns
    if succeeded, the function returns a valid Token, otherwise a Error
    + +
    +
    + +

    ◆ getAvailableDevices()

    + +
    +
    + + + + + + + + +
    TResult< std::vector< Device > > SpotifyAPI::getAvailableDevices (std::string const & accessToken)
    +
    + +

    returns vector of available spotify devices

    +
    Parameters
    + + +
    accessTokenvalid access token to use the spotify api
    +
    +
    +
    Returns
    if succeeded vector of Devices, otherwise Error
    + +
    +
    + +

    ◆ getCurrentPlayback()

    + +
    +
    + + + + + + + + + + + + + + + + + + +
    TResult< std::optional< Playback > > SpotifyAPI::getCurrentPlayback (std::string const & accessToken,
    std::string const & market = "AT" 
    )
    +
    + +

    gets the current playback status of the current active device from spotify

    +
    Parameters
    + + + +
    accessTokenvalid access token
    marketspecifies, that only tracks get returned which are valid in the given market (not implemented)
    +
    +
    +

    a playback is the actual status of the player, if its playing, wich device, which track and so on..

    Returns
    if succeeded it returns eher a Playback object, else Error
    + +
    +
    + +

    ◆ getTrack()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    TResult< Track > SpotifyAPI::getTrack (std::string const & accessToken,
    std::string const & spotifyID,
    std::string const & market = "AT" 
    )
    +
    + +

    searches for the given track id and returns a simplified track object

    +
    Parameters
    + + + + +
    accessTokenvalid access token
    spotifyIDspotify id of the song (without "spotify:track:" string)
    marketonly return tracks, which are valid in the given market
    +
    +
    +
    Returns
    if succeeded Track Object, otherwise Error
    + +
    +
    + +

    ◆ pause()

    + +
    +
    + + + + + + + + + + + + + + + + + + +
    TResultOpt SpotifyAPI::pause (std::string const & accessToken,
    Device const & device = Device() 
    )
    +
    + +

    pauses the acutal track

    +
    Parameters
    + + + +
    accessTokenvalid access token
    deviceselect on which device to pause (if not given, the current active device will be used)
    +
    +
    +
    Returns
    on failure a Error object gets returned
    + +
    +
    + +

    ◆ play()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TResultOpt SpotifyAPI::play (std::string const & accessToken,
    std::vector< std::string > const & uris = std::vector<std::string>(),
    Device const & device = Device(),
    int positionMs = 0 
    )
    +
    + +

    plays new songs, or resume the actual song

    +
    Parameters
    + + + + + +
    accessTokenvalid access token
    urisa vector of spotify uris (ids) which will be queued and played
    deviceselect on which device to play (if not given, the current active device will be used)
    positionMsset the start position in ms of the new track
    +
    +
    +

    if uris and devices are left empty, the actual song gets resumed, and if the positionMs is greater than the duration of the song, the next song will be played

    Returns
    on failure a Error object gets returned
    + +
    +
    + +

    ◆ refreshAccessToken()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    TResult< Token > SpotifyAPI::refreshAccessToken (std::string const & refreshToken,
    std::string const & clientID,
    std::string const & clientSecret 
    )
    +
    + +

    requests with the refresh token a new access token

    +
    Parameters
    + + + + +
    refreshTokenthe refresh token gathered from getAccessToken(..)
    clientIDclientID (from spotify developers dashboard)
    clientSecretclientSecret (from spotify developers dashboard)
    +
    +
    +

    this function fetches a new token from the spotify web api. Caution it only fetches a access token, not a new refresh token (because it doesn't need to be updated) so the refresh token value from the return will be empty!!

    Returns
    if succeeded, the function returns a valid Token, otherwise a Error
    + +
    +
    + +

    ◆ search()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TResult< SpotifyPaging > SpotifyAPI::search (std::string const & accessToken,
    std::string const & queryKey,
    SpotifyApi::QueryType type,
    int const limit = 20,
    int const offset = 0,
    std::string const & market = "AT" 
    )
    +
    + +

    searches for tracks,artists,albums or playlists with the given query

    +
    Parameters
    + + + + + + + +
    accessTokenvalid access token
    queryKeythe search string
    typespecifies if it gets searched for tracks, artists, albums, or playlists
    limitsets the limit of maximum number returned tracks,..
    offsetnumber offset
    marketonly return tracks,.. which are valid in the given market
    +
    +
    +

    the queryKey can also contain 2 wildcards. for further details on the query string see https://developer.spotify.com/documentation/web-api/reference/search/search/

    Returns
    if succeeded SpotifyPaging object else Error
    + +
    +
    + +

    ◆ setVolume()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    TResultOpt SpotifyAPI::setVolume (std::string const & accessToken,
    int volume,
    Device const & device = Device() 
    )
    +
    + +

    sets a volume

    +
    Parameters
    + + + + +
    accessTokenvalid access token
    volumevolume in percent (0-100)
    deviceselect on which device to set the volume (if not given, the current active device will be used)
    +
    +
    +
    Returns
    on failure a Error object gets returned
    + +
    +
    + +

    ◆ stringBase64Encode()

    + +
    +
    + + + + + +
    + + + + + + + + +
    std::string SpotifyAPI::stringBase64Encode (std::string const & str)
    +     		+static
    +
    + +

    encodes the given string with base64

    +
    Parameters
    + + +
    strstring to encode
    +
    +
    +
    Returns
    encoded string
    + +
    +
    + +

    ◆ stringUrlEncode()

    + +
    +
    + + + + + +
    + + + + + + + + +
    std::string SpotifyAPI::stringUrlEncode (std::string const & str)
    +     		+static
    +
    + +

    encodes the given string with http special characters

    +
    Parameters
    + + +
    strstring to encode
    +
    +
    +
    Returns
    encoded string
    + +
    +
    + +

    ◆ transferUsersPlayback()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    TResultOpt SpotifyAPI::transferUsersPlayback (std::string const & accessToken,
    std::vector< Device > const & devices,
    bool play = false 
    )
    +
    + +

    enables a playback on the given device

    +

    this function has to be called, when a device has no actual playback. Note: Note that a value of false for the play parameter when also transferring to another device_id will not pause playback. To ensure that playback is paused on the new device you should send a pause command to the currently active device before transferring to the new device_id

    Parameters
    + + + + +
    accessTokenvalid access token
    devicesits possible to set an array, but until now only a single device is currently supported
    playtrue ensures playback happends on new device otherwise keep the current playback state
    +
    +
    +
    Returns
    on failure a Error object
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyAuthorization-members.html b/docs/html/classSpotifyApi_1_1SpotifyAuthorization-members.html new file mode 100644 index 0000000..855c58c --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyAuthorization-members.html @@ -0,0 +1,92 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::SpotifyAuthorization Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::SpotifyAuthorization, including all inherited members.

    + + + + + + + + + + +
    getAccessToken()SpotifyApi::SpotifyAuthorization
    getExpiresAt()SpotifyApi::SpotifyAuthorization
    getRefreshToken()SpotifyApi::SpotifyAuthorization
    getScopes()SpotifyApi::SpotifyAuthorization
    refreshAccessToken()SpotifyApi::SpotifyAuthorization
    setScopes(std::string const &scopes)SpotifyApi::SpotifyAuthorization
    startServer()SpotifyApi::SpotifyAuthorization
    stopServer()SpotifyApi::SpotifyAuthorization
    ~SpotifyAuthorization() (defined in SpotifyApi::SpotifyAuthorization)SpotifyApi::SpotifyAuthorization
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyAuthorization.html b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.html new file mode 100644 index 0000000..aef1a6f --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.html @@ -0,0 +1,277 @@ + + + + + + + +VirtualJukebox: SpotifyApi::SpotifyAuthorization Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::SpotifyAuthorization Class Reference
    +
    +
    + +

    handles the 3 parties user authentication + More...

    + +

    #include <SpotifyAuthorization.h>

    +
    +Inheritance diagram for SpotifyApi::SpotifyAuthorization:
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    TResultOpt startServer ()
     starts the server, on which the user can connect More...
     
    +void stopServer ()
     stops the server
     
    const std::string & getRefreshToken ()
     returns refresh token More...
     
    const std::string & getAccessToken ()
     returns access token More...
     
    TResultOpt refreshAccessToken ()
     refreshes the access token (!! not implemented yet!!) More...
     
    __int64_t getExpiresAt ()
     returns when the token expires More...
     
    void setScopes (std::string const &scopes)
     sets the scopes to ask on the permission More...
     
    std::string getScopes ()
     return scopes More...
     
    +

    Detailed Description

    +

    handles the 3 parties user authentication

    +

    Member Function Documentation

    + +

    ◆ getAccessToken()

    + +
    +
    + + + + + + + +
    const std::string & SpotifyAuthorization::getAccessToken ()
    +
    + +

    returns access token

    +
    Returns
    refresh access string
    + +
    +
    + +

    ◆ getExpiresAt()

    + +
    +
    + + + + + + + +
    __int64_t SpotifyAuthorization::getExpiresAt ()
    +
    + +

    returns when the token expires

    +
    Returns
    time when the token expires (in epoch format and seconds)
    + +
    +
    + +

    ◆ getRefreshToken()

    + +
    +
    + + + + + + + +
    const std::string & SpotifyAuthorization::getRefreshToken ()
    +
    + +

    returns refresh token

    +
    Returns
    refresh token string
    + +
    +
    + +

    ◆ getScopes()

    + +
    +
    + + + + + + + +
    std::string SpotifyAuthorization::getScopes ()
    +
    + +

    return scopes

    +
    Returns
    scopes
    + +
    +
    + +

    ◆ refreshAccessToken()

    + +
    +
    + + + + + + + +
    TResultOpt SpotifyAuthorization::refreshAccessToken ()
    +
    + +

    refreshes the access token (!! not implemented yet!!)

    +
    Returns
    on failer Error object
    + +
    +
    + +

    ◆ setScopes()

    + +
    +
    + + + + + + + + +
    void SpotifyAuthorization::setScopes (std::string const & scopes)
    +
    + +

    sets the scopes to ask on the permission

    +
    Parameters
    + + +
    scopesscopes
    +
    +
    +

    see https://developer.spotify.com/documentation/general/guides/scopes/ for valid scopes

    + +
    +
    + +

    ◆ startServer()

    + +
    +
    + + + + + + + +
    TResultOpt SpotifyAuthorization::startServer ()
    +
    + +

    starts the server, on which the user can connect

    +
    Returns
    if failed Error object gets returned and no server has been created..
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png new file mode 100644 index 0000000000000000000000000000000000000000..85bce2227a627bea75cd5f5e67e8af55b9427cc8 GIT binary patch literal 655 zcmeAS@N?(olHy`uVBq!ia0vp^dx1EBgBeIxUv7y5QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;48@7eoFBymC#JTpSf#gWL3rrbzzeHa{mPhE_r1Ej?)U%tm#NDB z^}n61r!Two{_p>5p<6$H-d*pYziR7OMGLv;$;+glJ#YT5Q|z`Yaow`39`{r4*?Z0p z$~r%X|I6-~t6p9Ib$9c7y=}GMR;>#DrTI(oeed13(~{FH=hbSNFP|0M?HL|9>7~W{ zz~YdtX3Ho2U;Jg~kN-#K9=Qp0g2s!`&{~l%t5(@nUGDB!qty_9g*zcq*Y|(b+MfL; zf2HdZ|7?A^_!&cm<_pFekuMB(TvZJ6thNpPO>zg^9r+(DUcmk#@B;G>4OD4WkY5>e zRzYP~Tw1QpQ}Wh!6K|RE+|b$?-}YPVD|~Tl)k6QfCsp`)UQ6oF`m}vV!?H*<+giC3 z3enTGv;IYL_OIhP`!oG^PJqp)nzFNj+UqTK_%*XyTJxPzEC3oBTWUF7 dT*R)*FIrX + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::SpotifyDummy Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::SpotifyDummy, including all inherited members.

    + + + +
    SpotifyDummy()=default (defined in SpotifyApi::SpotifyDummy)SpotifyApi::SpotifyDummy
    SpotifyDummy(nlohmann::json const &dummyJson) (defined in SpotifyApi::SpotifyDummy)SpotifyApi::SpotifyDummyinline
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyDummy.html b/docs/html/classSpotifyApi_1_1SpotifyDummy.html new file mode 100644 index 0000000..1d55ddb --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyDummy.html @@ -0,0 +1,100 @@ + + + + + + + +VirtualJukebox: SpotifyApi::SpotifyDummy Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::SpotifyDummy Class Reference
    +
    +
    + +

    Type gets used, when no content data or Error is received. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + +

    +Public Member Functions

    + SpotifyDummy (nlohmann::json const &dummyJson)
     
    +

    Detailed Description

    +

    Type gets used, when no content data or Error is received.

    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyError-members.html b/docs/html/classSpotifyApi_1_1SpotifyError-members.html new file mode 100644 index 0000000..76d869b --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyError-members.html @@ -0,0 +1,86 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::SpotifyError Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::SpotifyError, including all inherited members.

    + + + + +
    getMessage() const (defined in SpotifyApi::SpotifyError)SpotifyApi::SpotifyError
    getStatus() const (defined in SpotifyApi::SpotifyError)SpotifyApi::SpotifyError
    SpotifyError(nlohmann::json const &errorJson) (defined in SpotifyApi::SpotifyError)SpotifyApi::SpotifyError
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyError.html b/docs/html/classSpotifyApi_1_1SpotifyError.html new file mode 100644 index 0000000..e91c634 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyError.html @@ -0,0 +1,107 @@ + + + + + + + +VirtualJukebox: SpotifyApi::SpotifyError Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::SpotifyError Class Reference
    +
    +
    + +

    Error type. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + +

    +Public Member Functions

    + SpotifyError (nlohmann::json const &errorJson)
     
    +int getStatus () const
     
    +const std::string & getMessage () const
     
    +

    Detailed Description

    +

    Error type.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyPaging-members.html b/docs/html/classSpotifyApi_1_1SpotifyPaging-members.html new file mode 100644 index 0000000..d6f9842 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyPaging-members.html @@ -0,0 +1,94 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::SpotifyPaging Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::SpotifyPaging, including all inherited members.

    + + + + + + + + + + + + +
    getAlbums() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getArtists() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getHref() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getLimit() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getNext() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getOffset() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getPrevious() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getTotal() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    getTracks() const (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    SpotifyPaging()=default (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    SpotifyPaging(nlohmann::json const &pagingJson) (defined in SpotifyApi::SpotifyPaging)SpotifyApi::SpotifyPaging
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1SpotifyPaging.html b/docs/html/classSpotifyApi_1_1SpotifyPaging.html new file mode 100644 index 0000000..8b9df1b --- /dev/null +++ b/docs/html/classSpotifyApi_1_1SpotifyPaging.html @@ -0,0 +1,128 @@ + + + + + + + +VirtualJukebox: SpotifyApi::SpotifyPaging Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::SpotifyPaging Class Reference
    +
    +
    + +

    Represents one page of search results. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SpotifyPaging (nlohmann::json const &pagingJson)
     
    +const std::vector< Track > & getTracks () const
     
    +const std::vector< Artist > & getArtists () const
     
    +const std::vector< Album > & getAlbums () const
     
    +const std::string & getHref () const
     
    +int getLimit () const
     
    +const std::string & getNext () const
     
    +int getOffset () const
     
    +const std::string & getPrevious () const
     
    +int getTotal () const
     
    +

    Detailed Description

    +

    Represents one page of search results.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Token-members.html b/docs/html/classSpotifyApi_1_1Token-members.html new file mode 100644 index 0000000..22a45a4 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Token-members.html @@ -0,0 +1,91 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Token Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Token, including all inherited members.

    + + + + + + + + + +
    getAccessToken() const (defined in SpotifyApi::Token)SpotifyApi::Token
    getExpiresIn() const (defined in SpotifyApi::Token)SpotifyApi::Token
    getRefreshToken() const (defined in SpotifyApi::Token)SpotifyApi::Token
    getScope() const (defined in SpotifyApi::Token)SpotifyApi::Token
    getTokenType() const (defined in SpotifyApi::Token)SpotifyApi::Token
    setRefreshToken(std::string const &token) (defined in SpotifyApi::Token)SpotifyApi::Token
    Token()=default (defined in SpotifyApi::Token)SpotifyApi::Token
    Token(nlohmann::json const &tokenJson) (defined in SpotifyApi::Token)SpotifyApi::Token
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Token.html b/docs/html/classSpotifyApi_1_1Token.html new file mode 100644 index 0000000..6b5ff5e --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Token.html @@ -0,0 +1,119 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Token Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Token Class Reference
    +
    +
    + +

    return type on valid token request + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Token (nlohmann::json const &tokenJson)
     
    +void setRefreshToken (std::string const &token)
     
    +const std::string & getAccessToken () const
     
    +const std::string & getRefreshToken () const
     
    +const std::string & getTokenType () const
     
    +const std::string & getScope () const
     
    +size_t getExpiresIn () const
     
    +

    Detailed Description

    +

    return type on valid token request

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Track-members.html b/docs/html/classSpotifyApi_1_1Track-members.html new file mode 100644 index 0000000..5727a02 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Track-members.html @@ -0,0 +1,92 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    SpotifyApi::Track Member List
    +
    +
    + +

    This is the complete list of members for SpotifyApi::Track, including all inherited members.

    + + + + + + + + + + +
    getAlbum() const (defined in SpotifyApi::Track)SpotifyApi::Track
    getArtists() const (defined in SpotifyApi::Track)SpotifyApi::Track
    getDuration() const (defined in SpotifyApi::Track)SpotifyApi::Track
    getHref() const (defined in SpotifyApi::Track)SpotifyApi::Track
    getId() const (defined in SpotifyApi::Track)SpotifyApi::Track
    getName() const (defined in SpotifyApi::Track)SpotifyApi::Track
    getUri() const (defined in SpotifyApi::Track)SpotifyApi::Track
    Track()=default (defined in SpotifyApi::Track)SpotifyApi::Track
    Track(nlohmann::json const &trackJson) (defined in SpotifyApi::Track)SpotifyApi::Track
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyApi_1_1Track.html b/docs/html/classSpotifyApi_1_1Track.html new file mode 100644 index 0000000..f8a26f1 --- /dev/null +++ b/docs/html/classSpotifyApi_1_1Track.html @@ -0,0 +1,122 @@ + + + + + + + +VirtualJukebox: SpotifyApi::Track Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    SpotifyApi::Track Class Reference
    +
    +
    + +

    Simplified track object. + More...

    + +

    #include <SpotifyAPITypes.h>

    + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Track (nlohmann::json const &trackJson)
     
    +const std::vector< Artist > & getArtists () const
     
    +const Album & getAlbum () const
     
    +size_t getDuration () const
     
    +const std::string & getHref () const
     
    +const std::string & getId () const
     
    +const std::string & getName () const
     
    +const std::string & getUri () const
     
    +

    Detailed Description

    +

    Simplified track object.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/classSpotifyBackend-members.html b/docs/html/classSpotifyBackend-members.html index 69bf181..edc7b68 100644 --- a/docs/html/classSpotifyBackend-members.html +++ b/docs/html/classSpotifyBackend-members.html @@ -68,14 +68,16 @@

    This is the complete list of members for SpotifyBackend, including all inherited members.

    - - - - - - - - + + + + + + + + + +
    getCurrentPlayback(void) override (defined in SpotifyBackend)SpotifyBackendvirtual
    getVolume(void) override (defined in SpotifyBackend)SpotifyBackendvirtual
    initBackend(void) override (defined in SpotifyBackend)SpotifyBackendvirtual
    pause(void) override (defined in SpotifyBackend)SpotifyBackendvirtual
    play() override (defined in SpotifyBackend)SpotifyBackendvirtual
    queryTracks(std::string const &pattern, size_t const num) override (defined in SpotifyBackend)SpotifyBackendvirtual
    setPlayback(Track const &track) override (defined in SpotifyBackend)SpotifyBackendvirtual
    setVolume(size_t const percent) override (defined in SpotifyBackend)SpotifyBackendvirtual
    createBaseTrack(TTrackID const &trackID) overrideSpotifyBackendvirtual
    getCurrentPlayback() overrideSpotifyBackendvirtual
    getVolume() overrideSpotifyBackendvirtual
    initBackend() overrideSpotifyBackendvirtual
    pause() overrideSpotifyBackendvirtual
    play() overrideSpotifyBackendvirtual
    queryTracks(std::string const &pattern, size_t const num) overrideSpotifyBackendvirtual
    setPlayback(BaseTrack const &track) overrideSpotifyBackendvirtual
    setVolume(size_t const percent) overrideSpotifyBackendvirtual
    ~MusicBackend() (defined in MusicBackend)MusicBackendinlinevirtual
    diff --git a/docs/html/classSpotifyBackend.html b/docs/html/classSpotifyBackend.html index 11a5b0e..0c40775 100644 --- a/docs/html/classSpotifyBackend.html +++ b/docs/html/classSpotifyBackend.html @@ -68,46 +68,368 @@
    SpotifyBackend Class Reference
    + +

    spotify music backend class which handles api calls and starts the authentication process + More...

    + +

    #include <SpotifyBackend.h>

    Inheritance diagram for SpotifyBackend:
    -MusicBackend +MusicBackend
    - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - + + + + + + + + +

    Public Member Functions

    -virtual TResultOpt initBackend (void) override
     
    -virtual TResult< std::vector< Track > > queryTracks (std::string const &pattern, size_t const num) override
     
    -virtual TResultOpt setPlayback (Track const &track) override
     
    -virtual TResult< PlaybackTrack > getCurrentPlayback (void) override
     
    -virtual TResultOpt pause (void) override
     
    -virtual TResultOpt play () override
    virtual TResultOpt initBackend () override
     Initalizes the backend. More...
     
    virtual TResult< std::vector< BaseTrack > > queryTracks (std::string const &pattern, size_t const num) override
     Queries the backend for all tracks given a pattern. More...
     
    virtual TResultOpt setPlayback (BaseTrack const &track) override
     Set the given track as playback (means the track gets played). More...
     
    virtual TResult< std::optional< PlaybackTrack > > getCurrentPlayback () override
     Returns the current playback of the active device as a playback track. More...
     
    virtual TResultOpt pause () override
     Pauses the current playback. More...
     
    virtual TResultOpt play () override
     Resumes the current playback. More...
     
    -virtual TResult< size_t > getVolume (void) override
     
    -virtual TResultOpt setVolume (size_t const percent) override
    virtual TResult< size_t > getVolume () override
     Returns the volume of the actual device in percent. More...
     
    virtual TResultOpt setVolume (size_t const percent) override
     Sets a new volume. More...
     
    virtual TResult< BaseTrack > createBaseTrack (TTrackID const &trackID) override
     Creates a new BaseTrack instance with the given trackID. More...
     
    +

    Detailed Description

    +

    spotify music backend class which handles api calls and starts the authentication process

    +

    all methods are capable of refreshing the token, if it gets expired

    +

    Member Function Documentation

    + +

    ◆ createBaseTrack()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResult< BaseTrack > SpotifyBackend::createBaseTrack (TTrackID const & trackID)
    +     		+overridevirtual
    +
    + +

    Creates a new BaseTrack instance with the given trackID.

    +

    the trackID is the same as the spotify uri string

    Parameters
    + + +
    trackIDUnique track ID (returned for example by queryTracks).
    +
    +
    +
    Returns
    New BaseTrack object on success, Error otherwise
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ getCurrentPlayback()

    + +
    +
    + + + + + +
    + + + + + + + +
    TResult< std::optional< PlaybackTrack > > SpotifyBackend::getCurrentPlayback ()
    +     		+overridevirtual
    +
    + +

    Returns the current playback of the active device as a playback track.

    +
    Returns
    Current playback track on success (or nothing if no track is currently playing), otherwise Error.
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ getVolume()

    + +
    +
    + + + + + +
    + + + + + + + +
    TResult< size_t > SpotifyBackend::getVolume ()
    +     		+overridevirtual
    +
    + +

    Returns the volume of the actual device in percent.

    +
    Returns
    Volume in percent on success, otherwise Error.
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ initBackend()

    + +
    +
    + + + + + +
    + + + + + + + +
    TResultOpt SpotifyBackend::initBackend ()
    +     		+overridevirtual
    +
    + +

    Initalizes the backend.

    +

    This function must be called to start the authorization server which is needed to acquire an access token.

    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ pause()

    + +
    +
    + + + + +
    + + + + + + + +
    TResultOpt SpotifyBackend::pause ()
    +     		+overridevirtual
    +
    + +

    Pauses the current playback.

    +
    Returns
    Returns an Error on failure.
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ play()

    + +
    +
    + + + + + +
    + + + + + + + +
    TResultOpt SpotifyBackend::play ()
    +     		+overridevirtual
    +
    + +

    Resumes the current playback.

    +
    Returns
    Returns an Error on failure.
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ queryTracks()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    TResult< std::vector< BaseTrack > > SpotifyBackend::queryTracks (std::string const & pattern,
    size_t const num 
    )
    +     		+overridevirtual
    +
    + +

    Queries the backend for all tracks given a pattern.

    +
    Parameters
    + + + +
    patternSearch patten (wildcard support depends on the backend).
    numMaximum number of returned tracks (maximum is 50).
    +
    +
    +
    Returns
    On success returns a vector of BaseTrack, otherwise Error.
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ setPlayback()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResultOpt SpotifyBackend::setPlayback (BaseTrack const & track)
    +     		+overridevirtual
    +
    + +

    Set the given track as playback (means the track gets played).

    +

    This method checks if there are any active Spotify devices (webplayer, smartphone,...), if not KeyNotFound is returned.
    +The next step is to check if playingDevice is set in the configuration file. If yes, and this device is currently active, it gets selected for the playback, otherwise the currently selected (Spotify Connect) device is used.

    Parameters
    + + +
    tracktrack to play
    +
    +
    +
    Returns
    Returns an Error on failure.
    + +

    Implements MusicBackend.

    + +
    +
    + +

    ◆ setVolume()

    + +
    +
    + + + + + +
    + + + + + + + + +
    TResultOpt SpotifyBackend::setVolume (size_t const percent)
    +     		+overridevirtual
    +
    + +

    Sets a new volume.

    +

    If a device is given in the ini file, this device gets selected. If no such device is given, the actual active device is used.

    Parameters
    + + +
    percentVolume in percent.
    +
    +
    +
    Returns
    Returns an Error on failure.
    + +

    Implements MusicBackend.

    + +
    +
    The documentation for this class was generated from the following files:
    diff --git a/docs/html/classes.html b/docs/html/classes.html index 9aff5c6..569385e 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -65,55 +65,86 @@
    Class Index
    -
    c | e | j | l | m | n | p | q | r | s | t
    +
    a | b | c | d | e | i | j | m | n | p | q | r | s | t
    - - + - - + + + + + + + + + - + + + + + + + + + - - + - - + + + + + - + + - - - - + + - - - + + - - + + + + - - + + - - - + + + + +
      c  
    +
      a  
      l  
    +    		Device (SpotifyApi)   
      n  
    		NetworkListener   
      r  
      t  
    +    		SpotifyBackend   
    Devices (SpotifyApi)   SpotifyDummy (SpotifyApi)   
    Album (SpotifyApi)   
      e  
    		NetworkAPI   RAMDataStore   SpotifyError (SpotifyApi)   
      p  
    +
    Artist (SpotifyApi)   NetworkListener   RequestInformation   SpotifyPaging (SpotifyApi)   
      b  
    +    		Error   
      p  
    +    		ResponseInformation   
      t  
    ConfigHandler   LoggingHandler   
      i  
    +    		 RestAPI   Track   
      e  
    +
    BaseTrack   Playback (SpotifyApi)   RestRequestHandler   Token (SpotifyApi)   
      c  
      m  
    +    		Image (SpotifyApi)   PlaybackTrack   
      s  
    		PlaybackTrack   RestEndpointHandler   
      q  
    +    		Track (SpotifyApi)   
      j  
      s  
    +
      q  
    Error   MusicBackend   
    ConfigHandler   Serializer   
      j  
    +
      d  
      n  
    +    		JukeBox   Queue   SimpleScheduler   
      m  
    		Queue   SpotifyBackend   QueuedTrack   SpotifyAPI (SpotifyApi)   
    JukeBox   NetworkAPI   
    DataStore   QueueStatus   SpotifyAuthorization (SpotifyApi)   
    MusicBackend   
    -
    c | e | j | l | m | n | p | q | r | s | t
    +
    a | b | c | d | e | i | j | m | n | p | q | r | s | t
    diff --git a/docs/html/dir_03ba4c266e378ccffb87dd5fa6a12b43.html b/docs/html/dir_03ba4c266e378ccffb87dd5fa6a12b43.html new file mode 100644 index 0000000..bfa0212 --- /dev/null +++ b/docs/html/dir_03ba4c266e378ccffb87dd5fa6a12b43.html @@ -0,0 +1,108 @@ + + + + + + + +VirtualJukebox: src/Spotify Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    Spotify Directory Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Files

    file  SpotifyAPI.cpp
     Class SpotifyAPI definition.
     
    file  SpotifyAPI.h [code]
     Class SpotifyAPI definition.
     
    file  SpotifyAPITypes.cpp
     Contains Structures for the Spotify Api implementation.
     
    file  SpotifyAPITypes.h [code]
     Contains Structures for the Spotify Api.
     
    file  SpotifyAuthorization.cpp
     Class SpotifyAuthorization implementation.
     
    file  SpotifyAuthorization.h [code]
     Class SpotifyAuthorization definition.
     
    file  SpotifyBackend.cpp
     Class handles Music Playback with a Spotify Backend.
     
    file  SpotifyBackend.h [code]
     Class handles Music Playback with a Spotify Backend.
     
    +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/dir_0c0333544ec44c57ec7d33d873fe36a2.html b/docs/html/dir_0c0333544ec44c57ec7d33d873fe36a2.html new file mode 100644 index 0000000..390ec24 --- /dev/null +++ b/docs/html/dir_0c0333544ec44c57ec7d33d873fe36a2.html @@ -0,0 +1,105 @@ + + + + + + + +VirtualJukebox: src/Network Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    Network Directory Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + +

    +Files

    file  RequestInformation.h [code]
     Definition of class RequestInformation.
     
    file  RestAPI.cpp
     Implementation of class RestAPI.
     
    file  RestAPI.h [code]
     Definition of class RestAPI.
     
    file  RestEndpointHandlers.cpp
     Handler functions for all available REST endpoints.
     
    file  RestEndpointHandlers.h [code]
     Handler functions for all available REST endpoints.
     
    file  RestRequestHandler.cpp
     Implementation of class RestRequestHandler.
     
    file  RestRequestHandler.h [code]
     Definition of class RestRequestHandler.
     
    +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 5962d3b..8abadf1 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -70,34 +70,25 @@
    + +

    +Directories

    - - - - - - - - + + - + - - - - - - - + - + - + @@ -108,39 +99,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Files

    file  ConfigHandler.cpp
     Class ConfigHandler implementation.
     
    file  ConfigHandler.h [code]
     Class ConfigHandler definition.
     
    file  GlobalTypes.h [code]
     Defines types and constants that are used globally.
    file  DataStore.h [code]
     Class DataStore definition.
     
    file  JukeBox.cpp
     Class JukeBox implementation.
     Class JukeBox implementation.
     
    file  JukeBox.h [code]
     Class JukeBox definition.
     
    file  LoggingHandler.cpp
     Class LoggingHandler implementation.
     
    file  LoggingHandler.h [code]
     Class LoggingHandler definition.
     Class JukeBox definition.
     
    file  main.cpp
     Main program for project "Virtual JukeBox".
     Main program for project "VirtualJukeBox".
     
    file  MusicBackend.h [code]
     Interface for MusicBackends.
     Interface for MusicBackend.
     
    file  NetworkAPI.cpp
     Implementation of class NetworkAPI.
    file  NetworkListener.h [code]
     Interface Class NetworkListener definition.
     
    file  Queue.cpp
     Class Queue implementation.
     
    file  Queue.h [code]
     Class Queue definition.
     
    file  RestAPI.cpp
     Implementation of class RestAPI.
     
    file  RestAPI.h [code]
     Definition of class RestAPI.
     
    file  RestEndpointHandler.cpp
     Implementation of class RestEndpointHandler.
     
    file  RestEndpointHandler.h [code]
     Definition of class RestEndpointHandler.
     
    file  Result.cpp
     Implements functions.
     
    file  Result.h [code]
     Defines function return values and types.
     
    file  SpotifyBackend.h [code]
     Class handles Music Playback with a Spotify Backend.
     
    file  Track.cpp
     Class Track implementation.
     
    file  Track.h [code]
     Class Track definition.
     
    diff --git a/docs/html/dir_a7363e98f9e0bdd87618633653859815.html b/docs/html/dir_a7363e98f9e0bdd87618633653859815.html new file mode 100644 index 0000000..2654065 --- /dev/null +++ b/docs/html/dir_a7363e98f9e0bdd87618633653859815.html @@ -0,0 +1,108 @@ + + + + + + + +VirtualJukebox: src/Utils Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    Utils Directory Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Files

    file  ConfigHandler.cpp
     Class ConfigHandler implementation.
     
    file  ConfigHandler.h [code]
     Class ConfigHandler definition.
     
    file  LoggingHandler.cpp
     LoggingHandler implementation.
     
    file  LoggingHandler.h [code]
     LoggingHandler header file.
     
    file  Serializer.cpp
     Implementation of class Serializer.
     
    file  Serializer.h [code]
     Definition of class Serializer.
     
    file  SimpleScheduler.cpp
     Class SimpleScheduler implementation.
     
    file  SimpleScheduler.h [code]
     Class SimpleScheduler definition.
     
    +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/dir_a80ba6df1bafd3b08a3ea260be098349.html b/docs/html/dir_a80ba6df1bafd3b08a3ea260be098349.html new file mode 100644 index 0000000..c7b2719 --- /dev/null +++ b/docs/html/dir_a80ba6df1bafd3b08a3ea260be098349.html @@ -0,0 +1,96 @@ + + + + + + + +VirtualJukebox: src/Types Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    Types Directory Reference
    +
    +
    + + + + + + + + + + + + + + +

    +Files

    file  GlobalTypes.h [code]
     Defines types and constants that are used globally.
     
    file  Queue.h [code]
     Class Queue definition.
     
    file  Result.h [code]
     Defines function return values and types.
     
    file  Tracks.h [code]
     Definitions of all track related structs.
     
    +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/dir_d5390e4c740f826103ce9bf0b50d1543.html b/docs/html/dir_d5390e4c740f826103ce9bf0b50d1543.html new file mode 100644 index 0000000..0c438a5 --- /dev/null +++ b/docs/html/dir_d5390e4c740f826103ce9bf0b50d1543.html @@ -0,0 +1,87 @@ + + + + + + + +VirtualJukebox: src/Datastore Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    VirtualJukebox +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    Datastore Directory Reference
    +
    +
    + + + + + +

    +Files

    file  RAMDataStore.h [code]
     Class RAMDataStore implementation.
     
    +
    + +
    +Generated by   +doxygen + 1.8.16 +
    + + diff --git a/docs/html/files.html b/docs/html/files.html index 7b289c4..185859a 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -66,32 +66,49 @@
    Here is a list of all documented files with brief descriptions:
    -
    [detail level 12]
    +
    [detail level 123]
    - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼ src
     ConfigHandler.cppClass ConfigHandler implementation
     ConfigHandler.hClass ConfigHandler definition
     GlobalTypes.hDefines types and constants that are used globally
     JukeBox.cppClass JukeBox implementation
     JukeBox.hClass JukeBox definition
     LoggingHandler.cppClass LoggingHandler implementation
     LoggingHandler.hClass LoggingHandler definition
     main.cppMain program for project "Virtual JukeBox"
     MusicBackend.hInterface for MusicBackends
     NetworkAPI.cppImplementation of class NetworkAPI
     NetworkAPI.hDefinition of class NetworkAPI
     NetworkListener.hInterface Class NetworkListener definition
     PlaybackTrack.h
     Queue.cppClass Queue implementation
     Queue.hClass Queue definition
     RestAPI.cppImplementation of class RestAPI
     RestAPI.hDefinition of class RestAPI
     RestEndpointHandler.cppImplementation of class RestEndpointHandler
     RestEndpointHandler.hDefinition of class RestEndpointHandler
     Result.cppImplements functions
     Result.hDefines function return values and types
     SpotifyBackend.hClass handles Music Playback with a Spotify Backend
     Track.cppClass Track implementation
     Track.hClass Track definition
     ▼ Datastore
     RAMDataStore.hClass RAMDataStore implementation
     ▼ Network
     RequestInformation.hDefinition of class RequestInformation
     RestAPI.cppImplementation of class RestAPI
     RestAPI.hDefinition of class RestAPI
     RestEndpointHandlers.cppHandler functions for all available REST endpoints
     RestEndpointHandlers.hHandler functions for all available REST endpoints
     RestRequestHandler.cppImplementation of class RestRequestHandler
     RestRequestHandler.hDefinition of class RestRequestHandler
     ▼ Spotify
     SpotifyAPI.cppClass SpotifyAPI definition
     SpotifyAPI.hClass SpotifyAPI definition
     SpotifyAPITypes.cppContains Structures for the Spotify Api implementation
     SpotifyAPITypes.hContains Structures for the Spotify Api
     SpotifyAuthorization.cppClass SpotifyAuthorization implementation
     SpotifyAuthorization.hClass SpotifyAuthorization definition
     SpotifyBackend.cppClass handles Music Playback with a Spotify Backend
     SpotifyBackend.hClass handles Music Playback with a Spotify Backend
     ▼ Types
     GlobalTypes.hDefines types and constants that are used globally
     Queue.hClass Queue definition
     Result.hDefines function return values and types
     Tracks.hDefinitions of all track related structs
     ▼ Utils
     ConfigHandler.cppClass ConfigHandler implementation
     ConfigHandler.hClass ConfigHandler definition
     LoggingHandler.cppLoggingHandler implementation
     LoggingHandler.hLoggingHandler header file
     Serializer.cppImplementation of class Serializer
     Serializer.hDefinition of class Serializer
     SimpleScheduler.cppClass SimpleScheduler implementation
     SimpleScheduler.hClass SimpleScheduler definition
     DataStore.hClass DataStore definition
     JukeBox.cppClass JukeBox implementation
     JukeBox.hClass JukeBox definition
     main.cppMain program for project "VirtualJukeBox"
     MusicBackend.hInterface for MusicBackend
     NetworkAPI.cppImplementation of class NetworkAPI
     NetworkAPI.hDefinition of class NetworkAPI
     NetworkListener.hInterface Class NetworkListener definition
    diff --git a/docs/html/functions.html b/docs/html/functions.html index c8e5165..7cddaf4 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -61,18 +61,86 @@
    -
    Here is a list of all documented class members with links to the class documentation for each member:
    diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index cc7f52d..17862a0 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -61,18 +61,86 @@
    - 
    diff --git a/docs/html/globals.html b/docs/html/globals.html index 93b3c5b..25c6aa8 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -62,9 +62,8 @@
    Here is a list of all documented file members with links to the documentation:
      -
    • checkOptionalError() -: Result.cpp -, Result.h +
    • checkAlternativeError() +: Result.h
    • ErrorCode : Result.h @@ -72,9 +71,6 @@
    • PlayerAction : GlobalTypes.h
      • -
    • Queues -: NetworkListener.h -
    • QueueType : GlobalTypes.h
      • diff --git a/docs/html/globals_func.html b/docs/html/globals_func.html index 846ab97..1eb4db5 100644 --- a/docs/html/globals_func.html +++ b/docs/html/globals_func.html @@ -62,9 +62,8 @@
       
      diff --git a/docs/html/globals_type.html b/docs/html/globals_type.html index fd2940d..5451168 100644 --- a/docs/html/globals_type.html +++ b/docs/html/globals_type.html @@ -62,9 +62,6 @@
       
      -

      Main program for project "Virtual JukeBox". +

      Main program for project "VirtualJukeBox". More...

      -
      #include <iostream>
      +
      #include <glog/logging.h>
      +#include <iostream>
      #include <string>
      -#include "ConfigHandler.h"
      #include "JukeBox.h"
      -#include "LoggingHandler.h"
      -#include "Result.h"
      +#include "Types/Result.h"
      +#include "Utils/ConfigHandler.h"
      +#include "Utils/LoggingHandler.h"
      - - + +

      Functions

      -int main ()
       
      +int main (int argc, char *argv[])
       

      Detailed Description

      -

      Main program for project "Virtual JukeBox".

      -
      Author
      Team Server
      +

      Main program for project "VirtualJukeBox".

      +
      Author
      Team Server
      +

      Usage: ./executable [<filepath-to-config-file.ini>]

      diff --git a/docs/html/menudata.js b/docs/html/menudata.js index b82e202..07978ef 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -28,8 +28,34 @@ var menudata={children:[ {text:"Class Index",url:"classes.html"}, {text:"Class Hierarchy",url:"hierarchy.html"}, {text:"Class Members",url:"functions.html",children:[ -{text:"All",url:"functions.html"}, -{text:"Functions",url:"functions_func.html"}]}]}, +{text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, +{text:"c",url:"functions.html#index_c"}, +{text:"g",url:"functions.html#index_g"}, +{text:"h",url:"functions.html#index_h"}, +{text:"i",url:"functions.html#index_i"}, +{text:"m",url:"functions.html#index_m"}, +{text:"n",url:"functions.html#index_n"}, +{text:"p",url:"functions.html#index_p"}, +{text:"q",url:"functions.html#index_q"}, +{text:"r",url:"functions.html#index_r"}, +{text:"s",url:"functions.html#index_s"}, +{text:"t",url:"functions.html#index_t"}, +{text:"v",url:"functions.html#index_v"}]}, +{text:"Functions",url:"functions_func.html",children:[ +{text:"a",url:"functions_func.html#index_a"}, +{text:"c",url:"functions_func.html#index_c"}, +{text:"g",url:"functions_func.html#index_g"}, +{text:"h",url:"functions_func.html#index_h"}, +{text:"i",url:"functions_func.html#index_i"}, +{text:"m",url:"functions_func.html#index_m"}, +{text:"n",url:"functions_func.html#index_n"}, +{text:"p",url:"functions_func.html#index_p"}, +{text:"q",url:"functions_func.html#index_q"}, +{text:"r",url:"functions_func.html#index_r"}, +{text:"s",url:"functions_func.html#index_s"}, +{text:"t",url:"functions_func.html#index_t"}, +{text:"v",url:"functions_func.html#index_v"}]}]}]}, {text:"Files",url:"files.html",children:[ {text:"File List",url:"files.html"}, {text:"File Members",url:"globals.html",children:[ diff --git a/docs/html/rest_interface.html b/docs/html/rest_interface.html index b672590..1352258 100644 --- a/docs/html/rest_interface.html +++ b/docs/html/rest_interface.html @@ -89,12 +89,10 @@

    • 401 Unauthorized
      If a client requested a new admin session but specified a wrong password.
    • 403 Forbidden
      - The request was done by an unauthorized user. That includes requests to admin endpoints by non-admins or an attempt to do multiple votes on the same track.
      • + The request was done by an unauthorized user. That includes requests to admin endpoints by non-admins or an attempt to do multiple votes on the same track. Additionally this error may be returned if the MusicBackend has an permission problem.
    • 404 Not found
      The requested endpoint has not been found.
      For now, unknown track_ids also trigger this error.
      • -
    • 405 Method not allowed
      - The requested endpoint was accessed with an unallowed method.
    • 422 Unprocessable Entity
      The content of the request (JSON body) has an unexpected/invalid format.
    • 440 Login-Time-out
      @@ -102,6 +100,8 @@

    • 500 Internal Server Error
      This code may be encountered if the server catched an internal error (which may as well just have crashed the server) and was still able to send a response.
      If a client gets that status code, please notify the server team!
      • +
    • 502 Bad Gateway
      + If a third party service responds with any unexpected error this error code is returned.

    Note: More errors may be added in the future!

    In case of an error (i.e. HTTP status code is not 200) the response body looks like this:

    @@ -132,7 +132,7 @@

  • Body:
    {
    "password": "<admin_password>",
    -
    "nickname" "<nickname>"
    +
    "nickname": "<nickname>"
    }
    • @@ -320,9 +320,8 @@

    The value of player_action controls which action the server should take. Valid values are:

      -
    • "play": Starts or resumes playback
      • +
    • "play": Starts or resumes playback.
    • "pause": Pauses the playback. If it is already paused or stopped nothing happens.
      • -
    • "stop": Stops playback and remove the currently playing track (if any). If playback is paused remove the track as well. If it is already stopped nothing happens.
    • "skip": Removes the currently playing (or paused) track and play the next one in the queue. If playback is stopped remove the next queued track without resuming playback.
    • "volume_up": Raises the volume by a fixed amount if it is not already at its maximum value.
    • "volume_down": Lowers the volume by a fixed amount if it is not already at its minimum value.
      • diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js index 837fea6..44257e6 100644 --- a/docs/html/search/all_0.js +++ b/docs/html/search/all_0.js @@ -1,4 +1,8 @@ var searchData= [ - ['addtracktoqueue_0',['addTrackToQueue',['../classJukeBox.html#acbf8e845d6b8ca1e150a91a5c329820b',1,'JukeBox::addTrackToQueue()'],['../classNetworkListener.html#a37a93e71aa983e86260345e5e4982359',1,'NetworkListener::addTrackToQueue()']]] + ['addtrack_0',['addTrack',['../classDataStore.html#af31bb3ea7dd37ea7412a0d7c66e614a8',1,'DataStore::addTrack()'],['../classRAMDataStore.html#a4b944bdbcf5ad9dbb83310c3e331b059',1,'RAMDataStore::addTrack()']]], + ['addtracktoqueue_1',['addTrackToQueue',['../classJukeBox.html#acbf8e845d6b8ca1e150a91a5c329820b',1,'JukeBox::addTrackToQueue()'],['../classNetworkListener.html#a37a93e71aa983e86260345e5e4982359',1,'NetworkListener::addTrackToQueue()']]], + ['adduser_2',['addUser',['../classDataStore.html#ab386aa5aaf7b83fc7eecbe5916ea9c9c',1,'DataStore::addUser()'],['../classRAMDataStore.html#af448bf43df0110b43a40e7ee4b5cb3ac',1,'RAMDataStore::addUser()']]], + ['album_3',['Album',['../classSpotifyApi_1_1Album.html',1,'SpotifyApi']]], + ['artist_4',['Artist',['../classSpotifyApi_1_1Artist.html',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index 9e18a2b..88cbb02 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -1,9 +1,4 @@ var searchData= [ - ['checkoptionalerror_1',['checkOptionalError',['../Result_8cpp.html#a65516cd58ee6ae0d9b3e5f4fc4c4a5cb',1,'checkOptionalError(TResultOpt ret): Result.cpp'],['../Result_8h.html#a65516cd58ee6ae0d9b3e5f4fc4c4a5cb',1,'checkOptionalError(TResultOpt ret): Result.cpp']]], - ['class_20diagram_2',['Class diagram',['../class_diagram.html',1,'']]], - ['confighandler_3',['ConfigHandler',['../classConfigHandler.html',1,'']]], - ['confighandler_2ecpp_4',['ConfigHandler.cpp',['../ConfigHandler_8cpp.html',1,'']]], - ['confighandler_2eh_5',['ConfigHandler.h',['../ConfigHandler_8h.html',1,'']]], - ['controlplayer_6',['controlPlayer',['../classJukeBox.html#a2141a7b4645dde1155b696d7258cd8c1',1,'JukeBox::controlPlayer()'],['../classNetworkListener.html#aafbc105ce3b3008f19fd373df4ebc383',1,'NetworkListener::controlPlayer()']]] + ['basetrack_5',['BaseTrack',['../classBaseTrack.html',1,'']]] ]; diff --git a/docs/html/search/all_10.html b/docs/html/search/all_10.html new file mode 100644 index 0000000..c234738 --- /dev/null +++ b/docs/html/search/all_10.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/all_10.js b/docs/html/search/all_10.js new file mode 100644 index 0000000..739381a --- /dev/null +++ b/docs/html/search/all_10.js @@ -0,0 +1,13 @@ +var searchData= +[ + ['token_117',['Token',['../classSpotifyApi_1_1Token.html',1,'SpotifyApi']]], + ['tpassword_118',['TPassword',['../GlobalTypes_8h.html#a0427177b8e88da62a10f9acfcece1359',1,'GlobalTypes.h']]], + ['track_119',['Track',['../classSpotifyApi_1_1Track.html',1,'SpotifyApi']]], + ['tracks_2eh_120',['Tracks.h',['../Tracks_8h.html',1,'']]], + ['transferusersplayback_121',['transferUsersPlayback',['../classSpotifyApi_1_1SpotifyAPI.html#a88c9245d103e8ca354ada6716cfbd71b',1,'SpotifyApi::SpotifyAPI']]], + ['tresult_122',['TResult',['../Result_8h.html#a442760d03514e6c849a35e3f0c768bef',1,'Result.h']]], + ['tresultopt_123',['TResultOpt',['../Result_8h.html#aada7d5476a077b5984176864eefe0c5f',1,'Result.h']]], + ['tsessionid_124',['TSessionID',['../GlobalTypes_8h.html#a0de933f1c954bae9fd7edbff41cf9a91',1,'GlobalTypes.h']]], + ['ttrackid_125',['TTrackID',['../GlobalTypes_8h.html#a913b47270997e628c2767eebc80a2e6a',1,'GlobalTypes.h']]], + ['tvote_126',['TVote',['../GlobalTypes_8h.html#a5842247e6ba9809bdba7898b9fe2b3dd',1,'GlobalTypes.h']]] +]; diff --git a/docs/html/search/all_11.html b/docs/html/search/all_11.html new file mode 100644 index 0000000..2f927fe --- /dev/null +++ b/docs/html/search/all_11.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/all_11.js b/docs/html/search/all_11.js new file mode 100644 index 0000000..5719a65 --- /dev/null +++ b/docs/html/search/all_11.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['virtualjukebox_20landing_20page_127',['VirtualJukebox landing page',['../index.html',1,'']]], + ['votetrack_128',['voteTrack',['../classJukeBox.html#a63dd8c5ab590dda4ccd3fe3476134acd',1,'JukeBox::voteTrack()'],['../classNetworkListener.html#a5eaa0385f3f14a0797e47d53aba2a5aa',1,'NetworkListener::voteTrack()'],['../classDataStore.html#a6138d338385475e34bcbbb76434a0069',1,'DataStore::voteTrack()'],['../classRAMDataStore.html#ad3fcb14a48c0cea4c39699025526d51a',1,'RAMDataStore::voteTrack()']]] +]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index 0bfc6a0..3622ad4 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -1,5 +1,11 @@ var searchData= [ - ['error_7',['Error',['../classError.html',1,'']]], - ['errorcode_8',['ErrorCode',['../Result_8h.html#a59e56af19e754a6aa26a612ebf91d05f',1,'Result.h']]] + ['checkalternativeerror_6',['checkAlternativeError',['../Result_8h.html#a6b675dd28f1987a6202a29614e0bdae3',1,'Result.h']]], + ['checkforinconsistency_7',['checkForInconsistency',['../classSimpleScheduler.html#a9f86bd605e4c10cacf065b5753e27240',1,'SimpleScheduler']]], + ['class_20diagram_8',['Class diagram',['../class_diagram.html',1,'']]], + ['confighandler_9',['ConfigHandler',['../classConfigHandler.html',1,'']]], + ['confighandler_2ecpp_10',['ConfigHandler.cpp',['../ConfigHandler_8cpp.html',1,'']]], + ['confighandler_2eh_11',['ConfigHandler.h',['../ConfigHandler_8h.html',1,'']]], + ['controlplayer_12',['controlPlayer',['../classJukeBox.html#a2141a7b4645dde1155b696d7258cd8c1',1,'JukeBox::controlPlayer()'],['../classNetworkListener.html#aafbc105ce3b3008f19fd373df4ebc383',1,'NetworkListener::controlPlayer()']]], + ['createbasetrack_13',['createBaseTrack',['../classMusicBackend.html#a1239cd230929373e2bfb754f36b9f709',1,'MusicBackend::createBaseTrack()'],['../classSpotifyBackend.html#aa00eb1214463bc77ca207e5cf9f22deb',1,'SpotifyBackend::createBaseTrack()']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 6332b4a..e0ddbfe 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,7 +1,7 @@ var searchData= [ - ['generatesession_9',['generateSession',['../classJukeBox.html#a09250e342b2dd69438abf04d9f1b194f',1,'JukeBox::generateSession()'],['../classNetworkListener.html#a9a43c5dff18af1a206adb9cb33c9c652',1,'NetworkListener::generateSession()']]], - ['getvalueint_10',['getValueInt',['../classConfigHandler.html#aec101acc1e0961ec88c6897d9393da3f',1,'ConfigHandler']]], - ['getvaluestring_11',['getValueString',['../classConfigHandler.html#a0739c6cfe676547dfba163bfdcfe8974',1,'ConfigHandler']]], - ['globaltypes_2eh_12',['GlobalTypes.h',['../GlobalTypes_8h.html',1,'']]] + ['datastore_14',['DataStore',['../classDataStore.html',1,'']]], + ['datastore_2eh_15',['DataStore.h',['../DataStore_8h.html',1,'']]], + ['device_16',['Device',['../classSpotifyApi_1_1Device.html',1,'SpotifyApi']]], + ['devices_17',['Devices',['../classSpotifyApi_1_1Devices.html',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index e350259..4553aa4 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,6 +1,5 @@ var searchData= [ - ['jukebox_13',['JukeBox',['../classJukeBox.html',1,'']]], - ['jukebox_2ecpp_14',['JukeBox.cpp',['../JukeBox_8cpp.html',1,'']]], - ['jukebox_2eh_15',['JukeBox.h',['../JukeBox_8h.html',1,'']]] + ['error_18',['Error',['../classError.html',1,'']]], + ['errorcode_19',['ErrorCode',['../Result_8h.html#a59e56af19e754a6aa26a612ebf91d05f',1,'Result.h']]] ]; diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js index 5fa2d5b..e2f95c4 100644 --- a/docs/html/search/all_5.js +++ b/docs/html/search/all_5.js @@ -1,6 +1,21 @@ var searchData= [ - ['logginghandler_16',['LoggingHandler',['../classLoggingHandler.html',1,'']]], - ['logginghandler_2ecpp_17',['LoggingHandler.cpp',['../LoggingHandler_8cpp.html',1,'']]], - ['logginghandler_2eh_18',['LoggingHandler.h',['../LoggingHandler_8h.html',1,'']]] + ['generatesession_20',['generateSession',['../classJukeBox.html#a42a91fa2ca2060a1481e5be03c909332',1,'JukeBox::generateSession()'],['../classNetworkListener.html#a9c987d6bf2bfb3ac32528c19e1cd9317',1,'NetworkListener::generateSession()']]], + ['getaccesstoken_21',['getAccessToken',['../classSpotifyApi_1_1SpotifyAPI.html#af1167ea72c6bae03deec8d8d3325ba54',1,'SpotifyApi::SpotifyAPI::getAccessToken()'],['../classSpotifyApi_1_1SpotifyAuthorization.html#a4f585bfa111c73298109d6a43e02450b',1,'SpotifyApi::SpotifyAuthorization::getAccessToken()']]], + ['getavailabledevices_22',['getAvailableDevices',['../classSpotifyApi_1_1SpotifyAPI.html#a8c53faad5ef80cd0121ede0c48aca28d',1,'SpotifyApi::SpotifyAPI']]], + ['getcurrentplayback_23',['getCurrentPlayback',['../classMusicBackend.html#a25a901920a84a9834152c2aacf28efbf',1,'MusicBackend::getCurrentPlayback()'],['../classSpotifyBackend.html#a36c663bbf4f607a40af21b5213a9a0b9',1,'SpotifyBackend::getCurrentPlayback()'],['../classSpotifyApi_1_1SpotifyAPI.html#ac44c5580af168ab1b71139774c19a582',1,'SpotifyApi::SpotifyAPI::getCurrentPlayback()']]], + ['getcurrentqueues_24',['getCurrentQueues',['../classJukeBox.html#ab4552d328bbc8ddf9bfda905061d98dd',1,'JukeBox::getCurrentQueues()'],['../classNetworkListener.html#a5a04722db64e24631450f9ca5d1ef7dd',1,'NetworkListener::getCurrentQueues()']]], + ['getexpiresat_25',['getExpiresAt',['../classSpotifyApi_1_1SpotifyAuthorization.html#a1fe628cb5c782e6ed2b3dc43cf892f7d',1,'SpotifyApi::SpotifyAuthorization']]], + ['getlastplayback_26',['getLastPlayback',['../classSimpleScheduler.html#a0f6396c941bcfb0102d57dfcdb9f4c30',1,'SimpleScheduler']]], + ['getplayingtrack_27',['getPlayingTrack',['../classDataStore.html#a26e949891a194a7126017fc4493e7657',1,'DataStore::getPlayingTrack()'],['../classRAMDataStore.html#a590c3f45a352599f4ba164c1f05ac6c0',1,'RAMDataStore::getPlayingTrack()']]], + ['getqueue_28',['getQueue',['../classDataStore.html#afeebbf533d0b21aca9fcba83754b1f4a',1,'DataStore::getQueue()'],['../classRAMDataStore.html#acb413affd5c8fcad837f0f817ded8f20',1,'RAMDataStore::getQueue()']]], + ['getrefreshtoken_29',['getRefreshToken',['../classSpotifyApi_1_1SpotifyAuthorization.html#a6f9572508052dae2a5a445854263f39e',1,'SpotifyApi::SpotifyAuthorization']]], + ['getscopes_30',['getScopes',['../classSpotifyApi_1_1SpotifyAuthorization.html#af14742b62d6de55558a39d2c5aec5f03',1,'SpotifyApi::SpotifyAuthorization']]], + ['gettrack_31',['getTrack',['../classSpotifyApi_1_1SpotifyAPI.html#a7c239d1b61c8e80fdc01f757197100e8',1,'SpotifyApi::SpotifyAPI']]], + ['getuser_32',['getUser',['../classDataStore.html#ae2101b1f6b1f8fd00b0216bbca112691',1,'DataStore::getUser()'],['../classRAMDataStore.html#a6b1d53b36ee4e9d401342c0853206f7c',1,'RAMDataStore::getUser()']]], + ['getvalueint_33',['getValueInt',['../classConfigHandler.html#aec101acc1e0961ec88c6897d9393da3f',1,'ConfigHandler']]], + ['getvaluestring_34',['getValueString',['../classConfigHandler.html#a0739c6cfe676547dfba163bfdcfe8974',1,'ConfigHandler']]], + ['getvolume_35',['getVolume',['../classMusicBackend.html#a9c6d972426ee071034a7ab2c3cae990e',1,'MusicBackend::getVolume()'],['../classSpotifyBackend.html#a54530275a3787b8d22b99369b07f53fa',1,'SpotifyBackend::getVolume()']]], + ['globaltypes_2eh_36',['GlobalTypes.h',['../GlobalTypes_8h.html',1,'']]], + ['granttype_37',['GrantType',['../SpotifyAPITypes_8h.html#a4afaee2515de500ea4bfce9537ca0ceb',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index d6dc3bd..24e5996 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -1,7 +1,5 @@ var searchData= [ - ['main_2ecpp_19',['main.cpp',['../main_8cpp.html',1,'']]], - ['movetrack_20',['moveTrack',['../classJukeBox.html#acbf13a27d1dfe0922389b3871739a52b',1,'JukeBox::moveTrack()'],['../classNetworkListener.html#aa40327e801fb55a41362afe09825396c',1,'NetworkListener::moveTrack()']]], - ['musicbackend_21',['MusicBackend',['../classMusicBackend.html',1,'']]], - ['musicbackend_2eh_22',['MusicBackend.h',['../MusicBackend_8h.html',1,'']]] + ['hastrack_38',['hasTrack',['../classDataStore.html#a3e86350d2533c5e8fe4a3cc294819ba7',1,'DataStore::hasTrack()'],['../classRAMDataStore.html#abc3b8321530d0398f4ec1bd707410d07',1,'RAMDataStore::hasTrack()']]], + ['hasuser_39',['hasUser',['../classDataStore.html#a534c91e2d79168a6fd1bd582b6692514',1,'DataStore::hasUser()'],['../classRAMDataStore.html#aa121f84da8d284abee666d835a133af8',1,'RAMDataStore::hasUser()']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index d225303..661f082 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,8 +1,6 @@ var searchData= [ - ['networkapi_23',['NetworkAPI',['../classNetworkAPI.html',1,'']]], - ['networkapi_2ecpp_24',['NetworkAPI.cpp',['../NetworkAPI_8cpp.html',1,'']]], - ['networkapi_2eh_25',['NetworkAPI.h',['../NetworkAPI_8h.html',1,'']]], - ['networklistener_26',['NetworkListener',['../classNetworkListener.html',1,'']]], - ['networklistener_2eh_27',['NetworkListener.h',['../NetworkListener_8h.html',1,'']]] + ['image_40',['Image',['../classSpotifyApi_1_1Image.html',1,'SpotifyApi']]], + ['initbackend_41',['initBackend',['../classMusicBackend.html#a9c20d8af1a5dd01766cb1595a2546ece',1,'MusicBackend::initBackend()'],['../classSpotifyBackend.html#ad1cb12d1fa585e6d4e25d7437bdbdde4',1,'SpotifyBackend::initBackend()']]], + ['issessionexpired_42',['isSessionExpired',['../classDataStore.html#aa7582a831e7f5b10d52ffd42526acd4b',1,'DataStore::isSessionExpired()'],['../classRAMDataStore.html#a5741d23da3acb2de51a9789be973997f',1,'RAMDataStore::isSessionExpired()']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index 6798e2b..bf7d028 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -1,5 +1,6 @@ var searchData= [ - ['playbacktrack_28',['PlaybackTrack',['../classPlaybackTrack.html',1,'']]], - ['playeraction_29',['PlayerAction',['../GlobalTypes_8h.html#aea132397c26cad8f8637a9422260deca',1,'GlobalTypes.h']]] + ['jukebox_43',['JukeBox',['../classJukeBox.html',1,'']]], + ['jukebox_2ecpp_44',['JukeBox.cpp',['../JukeBox_8cpp.html',1,'']]], + ['jukebox_2eh_45',['JukeBox.h',['../JukeBox_8h.html',1,'']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index a3d0abe..0f5c306 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -1,9 +1,5 @@ var searchData= [ - ['querytracks_30',['queryTracks',['../classJukeBox.html#a5d9708b771a667cec6b960319c1b0813',1,'JukeBox::queryTracks()'],['../classNetworkListener.html#a5d27adf3626f08e552a0f1c2f3daab74',1,'NetworkListener::queryTracks()']]], - ['queue_31',['Queue',['../classQueue.html',1,'']]], - ['queue_2ecpp_32',['Queue.cpp',['../Queue_8cpp.html',1,'']]], - ['queue_2eh_33',['Queue.h',['../Queue_8h.html',1,'']]], - ['queues_34',['Queues',['../NetworkListener_8h.html#adcc80250835bc2b99ce350f7cc40730b',1,'NetworkListener.h']]], - ['queuetype_35',['QueueType',['../GlobalTypes_8h.html#ad18b8aa57b4ec903e6c8684855647be1',1,'GlobalTypes.h']]] + ['logginghandler_2ecpp_46',['LoggingHandler.cpp',['../LoggingHandler_8cpp.html',1,'']]], + ['logginghandler_2eh_47',['LoggingHandler.h',['../LoggingHandler_8h.html',1,'']]] ]; diff --git a/docs/html/search/all_a.js b/docs/html/search/all_a.js index 3608d0f..5b9743b 100644 --- a/docs/html/search/all_a.js +++ b/docs/html/search/all_a.js @@ -1,13 +1,7 @@ var searchData= [ - ['removetrack_36',['removeTrack',['../classJukeBox.html#a4ef7b0f9ab225fc18b606a1ec3fb830d',1,'JukeBox::removeTrack()'],['../classNetworkListener.html#a017bf4541619e098880ad115fd1ba6e7',1,'NetworkListener::removeTrack()']]], - ['rest_20interface_37',['REST interface',['../rest_interface.html',1,'']]], - ['restapi_38',['RestAPI',['../classRestAPI.html',1,'']]], - ['restapi_2ecpp_39',['RestAPI.cpp',['../RestAPI_8cpp.html',1,'']]], - ['restapi_2eh_40',['RestAPI.h',['../RestAPI_8h.html',1,'']]], - ['restendpointhandler_41',['RestEndpointHandler',['../classRestEndpointHandler.html',1,'']]], - ['restendpointhandler_2ecpp_42',['RestEndpointHandler.cpp',['../RestEndpointHandler_8cpp.html',1,'']]], - ['restendpointhandler_2eh_43',['RestEndpointHandler.h',['../RestEndpointHandler_8h.html',1,'']]], - ['result_2ecpp_44',['Result.cpp',['../Result_8cpp.html',1,'']]], - ['result_2eh_45',['Result.h',['../Result_8h.html',1,'']]] + ['main_2ecpp_48',['main.cpp',['../main_8cpp.html',1,'']]], + ['movetrack_49',['moveTrack',['../classJukeBox.html#a47da68cdc2e529fc5b74c846ac196db5',1,'JukeBox::moveTrack()'],['../classNetworkListener.html#a2d0015c8ce1c73931662102539709a5f',1,'NetworkListener::moveTrack()']]], + ['musicbackend_50',['MusicBackend',['../classMusicBackend.html',1,'']]], + ['musicbackend_2eh_51',['MusicBackend.h',['../MusicBackend_8h.html',1,'']]] ]; diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js index f390f75..d168171 100644 --- a/docs/html/search/all_b.js +++ b/docs/html/search/all_b.js @@ -1,6 +1,9 @@ var searchData= [ - ['setconfigfilepath_46',['setConfigFilePath',['../classConfigHandler.html#a384913951094cc79279cf3b6f13a360a',1,'ConfigHandler']]], - ['spotifybackend_47',['SpotifyBackend',['../classSpotifyBackend.html',1,'']]], - ['spotifybackend_2eh_48',['SpotifyBackend.h',['../SpotifyBackend_8h.html',1,'']]] + ['networkapi_52',['NetworkAPI',['../classNetworkAPI.html',1,'']]], + ['networkapi_2ecpp_53',['NetworkAPI.cpp',['../NetworkAPI_8cpp.html',1,'']]], + ['networkapi_2eh_54',['NetworkAPI.h',['../NetworkAPI_8h.html',1,'']]], + ['networklistener_55',['NetworkListener',['../classNetworkListener.html',1,'']]], + ['networklistener_2eh_56',['NetworkListener.h',['../NetworkListener_8h.html',1,'']]], + ['nexttrack_57',['nextTrack',['../classDataStore.html#a9c56b41891e35f8fab0ddbcb70a7fc25',1,'DataStore::nextTrack()'],['../classSimpleScheduler.html#af78810c915e7a8220fb4d5e8dd8caac0',1,'SimpleScheduler::nextTrack()'],['../classRAMDataStore.html#a78cd87ff7576ed79447497714f1774b0',1,'RAMDataStore::nextTrack()']]] ]; diff --git a/docs/html/search/all_c.js b/docs/html/search/all_c.js index c87b9af..f05e9b0 100644 --- a/docs/html/search/all_c.js +++ b/docs/html/search/all_c.js @@ -1,12 +1,8 @@ var searchData= [ - ['tpassword_49',['TPassword',['../GlobalTypes_8h.html#a0427177b8e88da62a10f9acfcece1359',1,'GlobalTypes.h']]], - ['track_50',['Track',['../classTrack.html',1,'']]], - ['track_2ecpp_51',['Track.cpp',['../Track_8cpp.html',1,'']]], - ['track_2eh_52',['Track.h',['../Track_8h.html',1,'']]], - ['tresult_53',['TResult',['../Result_8h.html#a442760d03514e6c849a35e3f0c768bef',1,'Result.h']]], - ['tresultopt_54',['TResultOpt',['../Result_8h.html#aada7d5476a077b5984176864eefe0c5f',1,'Result.h']]], - ['tsessionid_55',['TSessionID',['../GlobalTypes_8h.html#a0de933f1c954bae9fd7edbff41cf9a91',1,'GlobalTypes.h']]], - ['ttrackid_56',['TTrackID',['../GlobalTypes_8h.html#a913b47270997e628c2767eebc80a2e6a',1,'GlobalTypes.h']]], - ['tvote_57',['TVote',['../GlobalTypes_8h.html#a5842247e6ba9809bdba7898b9fe2b3dd',1,'GlobalTypes.h']]] + ['pause_58',['pause',['../classMusicBackend.html#a8b3eb02f10084c51ab27de3c50e5de33',1,'MusicBackend::pause()'],['../classSpotifyBackend.html#a9eb9e84f3399e3fd67a13fa88e10053b',1,'SpotifyBackend::pause()'],['../classSpotifyApi_1_1SpotifyAPI.html#ace9f4542cf96fe6c544196c6e0403374',1,'SpotifyApi::SpotifyAPI::pause()']]], + ['play_59',['play',['../classMusicBackend.html#acb1ce1a8225076a2a9c0ee9a33e61c15',1,'MusicBackend::play()'],['../classSpotifyBackend.html#afe8f265ec12956750085be2101f468b6',1,'SpotifyBackend::play()'],['../classSpotifyApi_1_1SpotifyAPI.html#a3bd3dcd0260422e8db16fb3c6efb0b06',1,'SpotifyApi::SpotifyAPI::play()']]], + ['playback_60',['Playback',['../classSpotifyApi_1_1Playback.html',1,'SpotifyApi']]], + ['playbacktrack_61',['PlaybackTrack',['../structPlaybackTrack.html',1,'']]], + ['playeraction_62',['PlayerAction',['../GlobalTypes_8h.html#aea132397c26cad8f8637a9422260deca',1,'GlobalTypes.h']]] ]; diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index b90e8c9..68f948e 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -1,5 +1,9 @@ var searchData= [ - ['virtualjukebox_20landing_20page_58',['VirtualJukebox landing page',['../index.html',1,'']]], - ['votetrack_59',['voteTrack',['../classJukeBox.html#a63dd8c5ab590dda4ccd3fe3476134acd',1,'JukeBox::voteTrack()'],['../classNetworkListener.html#a5eaa0385f3f14a0797e47d53aba2a5aa',1,'NetworkListener::voteTrack()']]] + ['querytracks_63',['queryTracks',['../classJukeBox.html#a0ee5230486c8fe35f5153e97dbac7263',1,'JukeBox::queryTracks()'],['../classMusicBackend.html#ad07c6c9389e7e0785cf31e1a962f5c88',1,'MusicBackend::queryTracks()'],['../classNetworkListener.html#a452d6977cab9c55841d2dc9a28e15921',1,'NetworkListener::queryTracks()'],['../classSpotifyBackend.html#a8fc19f0bf05ec06df10521237c3cdc18',1,'SpotifyBackend::queryTracks()']]], + ['queue_64',['Queue',['../structQueue.html',1,'']]], + ['queue_2eh_65',['Queue.h',['../Queue_8h.html',1,'']]], + ['queuedtrack_66',['QueuedTrack',['../structQueuedTrack.html',1,'']]], + ['queuestatus_67',['QueueStatus',['../structQueueStatus.html',1,'']]], + ['queuetype_68',['QueueType',['../GlobalTypes_8h.html#ad18b8aa57b4ec903e6c8684855647be1',1,'GlobalTypes.h']]] ]; diff --git a/docs/html/search/all_e.html b/docs/html/search/all_e.html new file mode 100644 index 0000000..2931618 --- /dev/null +++ b/docs/html/search/all_e.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/all_e.js b/docs/html/search/all_e.js new file mode 100644 index 0000000..8929294 --- /dev/null +++ b/docs/html/search/all_e.js @@ -0,0 +1,21 @@ +var searchData= +[ + ['ramdatastore_69',['RAMDataStore',['../classRAMDataStore.html',1,'']]], + ['ramdatastore_2eh_70',['RAMDataStore.h',['../RAMDataStore_8h.html',1,'']]], + ['refreshaccesstoken_71',['refreshAccessToken',['../classSpotifyApi_1_1SpotifyAPI.html#a1c6cce2f5faa4fbb6b5e8186b0f9ecc8',1,'SpotifyApi::SpotifyAPI::refreshAccessToken()'],['../classSpotifyApi_1_1SpotifyAuthorization.html#a8400b5fe6c53b1499b5da51a0ccc184a',1,'SpotifyApi::SpotifyAuthorization::refreshAccessToken()']]], + ['removetrack_72',['removeTrack',['../classJukeBox.html#a4ef7b0f9ab225fc18b606a1ec3fb830d',1,'JukeBox::removeTrack()'],['../classNetworkListener.html#a017bf4541619e098880ad115fd1ba6e7',1,'NetworkListener::removeTrack()'],['../classDataStore.html#ac1220bd1c0cc8b2f7d696055d8975a4e',1,'DataStore::removeTrack()'],['../classRAMDataStore.html#ab1a6875bb540b05bf999f4518121a765',1,'RAMDataStore::removeTrack()']]], + ['removeuser_73',['removeUser',['../classDataStore.html#a7f8c1781b2bd886c7e1ab12ff27cdb44',1,'DataStore::removeUser()'],['../classRAMDataStore.html#aa02060ffe102d0a6ab87243b8f8a86c5',1,'RAMDataStore::removeUser()']]], + ['requestinformation_74',['RequestInformation',['../structRequestInformation.html',1,'']]], + ['requestinformation_2eh_75',['RequestInformation.h',['../RequestInformation_8h.html',1,'']]], + ['responseinformation_76',['ResponseInformation',['../structResponseInformation.html',1,'']]], + ['rest_20interface_77',['REST interface',['../rest_interface.html',1,'']]], + ['restapi_78',['RestAPI',['../classRestAPI.html',1,'']]], + ['restapi_2ecpp_79',['RestAPI.cpp',['../RestAPI_8cpp.html',1,'']]], + ['restapi_2eh_80',['RestAPI.h',['../RestAPI_8h.html',1,'']]], + ['restendpointhandlers_2ecpp_81',['RestEndpointHandlers.cpp',['../RestEndpointHandlers_8cpp.html',1,'']]], + ['restendpointhandlers_2eh_82',['RestEndpointHandlers.h',['../RestEndpointHandlers_8h.html',1,'']]], + ['restrequesthandler_83',['RestRequestHandler',['../classRestRequestHandler.html',1,'']]], + ['restrequesthandler_2ecpp_84',['RestRequestHandler.cpp',['../RestRequestHandler_8cpp.html',1,'']]], + ['restrequesthandler_2eh_85',['RestRequestHandler.h',['../RestRequestHandler_8h.html',1,'']]], + ['result_2eh_86',['Result.h',['../Result_8h.html',1,'']]] +]; diff --git a/docs/html/search/all_f.html b/docs/html/search/all_f.html new file mode 100644 index 0000000..ca42a52 --- /dev/null +++ b/docs/html/search/all_f.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/all_f.js b/docs/html/search/all_f.js new file mode 100644 index 0000000..0060507 --- /dev/null +++ b/docs/html/search/all_f.js @@ -0,0 +1,33 @@ +var searchData= +[ + ['search_87',['search',['../classSpotifyApi_1_1SpotifyAPI.html#aa7ededcbad860867fa3e483c4d3df741',1,'SpotifyApi::SpotifyAPI']]], + ['serializer_88',['Serializer',['../classSerializer.html',1,'']]], + ['serializer_2ecpp_89',['Serializer.cpp',['../Serializer_8cpp.html',1,'']]], + ['serializer_2eh_90',['Serializer.h',['../Serializer_8h.html',1,'']]], + ['setconfigfilepath_91',['setConfigFilePath',['../classConfigHandler.html#a384913951094cc79279cf3b6f13a360a',1,'ConfigHandler']]], + ['setplayback_92',['setPlayback',['../classMusicBackend.html#af43664f14de0e297e063973d73a1a448',1,'MusicBackend::setPlayback()'],['../classSpotifyBackend.html#a47f725a6b97e12305589631926176eb6',1,'SpotifyBackend::setPlayback()']]], + ['setscopes_93',['setScopes',['../classSpotifyApi_1_1SpotifyAuthorization.html#a327c05232055655fec751cba4e2fef77',1,'SpotifyApi::SpotifyAuthorization']]], + ['setvolume_94',['setVolume',['../classMusicBackend.html#a473a7068198abaccd37635b9cfb58df9',1,'MusicBackend::setVolume()'],['../classSpotifyBackend.html#a4f930b48086a96faa441963dd247af02',1,'SpotifyBackend::setVolume()'],['../classSpotifyApi_1_1SpotifyAPI.html#a43539a16bdcf99d53f1f936c4b892648',1,'SpotifyApi::SpotifyAPI::setVolume()']]], + ['simplescheduler_95',['SimpleScheduler',['../classSimpleScheduler.html',1,'']]], + ['simplescheduler_2ecpp_96',['SimpleScheduler.cpp',['../SimpleScheduler_8cpp.html',1,'']]], + ['simplescheduler_2eh_97',['SimpleScheduler.h',['../SimpleScheduler_8h.html',1,'']]], + ['spotifyapi_98',['SpotifyAPI',['../classSpotifyApi_1_1SpotifyAPI.html',1,'SpotifyApi']]], + ['spotifyapi_2ecpp_99',['SpotifyAPI.cpp',['../SpotifyAPI_8cpp.html',1,'']]], + ['spotifyapi_2eh_100',['SpotifyAPI.h',['../SpotifyAPI_8h.html',1,'']]], + ['spotifyapitypes_2ecpp_101',['SpotifyAPITypes.cpp',['../SpotifyAPITypes_8cpp.html',1,'']]], + ['spotifyapitypes_2eh_102',['SpotifyAPITypes.h',['../SpotifyAPITypes_8h.html',1,'']]], + ['spotifyauthorization_103',['SpotifyAuthorization',['../classSpotifyApi_1_1SpotifyAuthorization.html',1,'SpotifyApi']]], + ['spotifyauthorization_2ecpp_104',['SpotifyAuthorization.cpp',['../SpotifyAuthorization_8cpp.html',1,'']]], + ['spotifyauthorization_2eh_105',['SpotifyAuthorization.h',['../SpotifyAuthorization_8h.html',1,'']]], + ['spotifybackend_106',['SpotifyBackend',['../classSpotifyBackend.html',1,'']]], + ['spotifybackend_2ecpp_107',['SpotifyBackend.cpp',['../SpotifyBackend_8cpp.html',1,'']]], + ['spotifybackend_2eh_108',['SpotifyBackend.h',['../SpotifyBackend_8h.html',1,'']]], + ['spotifydummy_109',['SpotifyDummy',['../classSpotifyApi_1_1SpotifyDummy.html',1,'SpotifyApi']]], + ['spotifyerror_110',['SpotifyError',['../classSpotifyApi_1_1SpotifyError.html',1,'SpotifyApi']]], + ['spotifypaging_111',['SpotifyPaging',['../classSpotifyApi_1_1SpotifyPaging.html',1,'SpotifyApi']]], + ['start_112',['start',['../classJukeBox.html#ae94d3046cc3585b677a123db1e2ae81d',1,'JukeBox::start()'],['../classSimpleScheduler.html#a07d0697ca9f259a871f2ab5df3a41358',1,'SimpleScheduler::start()']]], + ['startserver_113',['startServer',['../classSpotifyApi_1_1SpotifyAuthorization.html#a3d6cc4af8f15cdb6b63f1a597b3b16e9',1,'SpotifyApi::SpotifyAuthorization']]], + ['stopserver_114',['stopServer',['../classSpotifyApi_1_1SpotifyAuthorization.html#a0e8bce76ef2c61447680ad5cbef4a44e',1,'SpotifyApi::SpotifyAuthorization']]], + ['stringbase64encode_115',['stringBase64Encode',['../classSpotifyApi_1_1SpotifyAPI.html#ae606d64659f7e59820986dfa3e766c73',1,'SpotifyApi::SpotifyAPI']]], + ['stringurlencode_116',['stringUrlEncode',['../classSpotifyApi_1_1SpotifyAPI.html#a6aa3086f9b1e71840c1175c6dfb1f4c0',1,'SpotifyApi::SpotifyAPI']]] +]; diff --git a/docs/html/search/classes_0.js b/docs/html/search/classes_0.js index e072fcb..1d87052 100644 --- a/docs/html/search/classes_0.js +++ b/docs/html/search/classes_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['confighandler_60',['ConfigHandler',['../classConfigHandler.html',1,'']]] + ['album_129',['Album',['../classSpotifyApi_1_1Album.html',1,'SpotifyApi']]], + ['artist_130',['Artist',['../classSpotifyApi_1_1Artist.html',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/classes_1.js b/docs/html/search/classes_1.js index 8a23a84..c9aa495 100644 --- a/docs/html/search/classes_1.js +++ b/docs/html/search/classes_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['error_61',['Error',['../classError.html',1,'']]] + ['basetrack_131',['BaseTrack',['../classBaseTrack.html',1,'']]] ]; diff --git a/docs/html/search/classes_2.js b/docs/html/search/classes_2.js index 958f465..d3e27a9 100644 --- a/docs/html/search/classes_2.js +++ b/docs/html/search/classes_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['jukebox_62',['JukeBox',['../classJukeBox.html',1,'']]] + ['confighandler_132',['ConfigHandler',['../classConfigHandler.html',1,'']]] ]; diff --git a/docs/html/search/classes_3.js b/docs/html/search/classes_3.js index 0d62b80..6b17419 100644 --- a/docs/html/search/classes_3.js +++ b/docs/html/search/classes_3.js @@ -1,4 +1,6 @@ var searchData= [ - ['logginghandler_63',['LoggingHandler',['../classLoggingHandler.html',1,'']]] + ['datastore_133',['DataStore',['../classDataStore.html',1,'']]], + ['device_134',['Device',['../classSpotifyApi_1_1Device.html',1,'SpotifyApi']]], + ['devices_135',['Devices',['../classSpotifyApi_1_1Devices.html',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/classes_4.js b/docs/html/search/classes_4.js index 6864318..ba1b607 100644 --- a/docs/html/search/classes_4.js +++ b/docs/html/search/classes_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['musicbackend_64',['MusicBackend',['../classMusicBackend.html',1,'']]] + ['error_136',['Error',['../classError.html',1,'']]] ]; diff --git a/docs/html/search/classes_5.js b/docs/html/search/classes_5.js index 181be31..6817ec9 100644 --- a/docs/html/search/classes_5.js +++ b/docs/html/search/classes_5.js @@ -1,5 +1,4 @@ var searchData= [ - ['networkapi_65',['NetworkAPI',['../classNetworkAPI.html',1,'']]], - ['networklistener_66',['NetworkListener',['../classNetworkListener.html',1,'']]] + ['image_137',['Image',['../classSpotifyApi_1_1Image.html',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/classes_6.js b/docs/html/search/classes_6.js index 247d375..eed634a 100644 --- a/docs/html/search/classes_6.js +++ b/docs/html/search/classes_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['playbacktrack_67',['PlaybackTrack',['../classPlaybackTrack.html',1,'']]] + ['jukebox_138',['JukeBox',['../classJukeBox.html',1,'']]] ]; diff --git a/docs/html/search/classes_7.js b/docs/html/search/classes_7.js index da08a23..a6618e1 100644 --- a/docs/html/search/classes_7.js +++ b/docs/html/search/classes_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['queue_68',['Queue',['../classQueue.html',1,'']]] + ['musicbackend_139',['MusicBackend',['../classMusicBackend.html',1,'']]] ]; diff --git a/docs/html/search/classes_8.js b/docs/html/search/classes_8.js index bf6568d..6f6fdd0 100644 --- a/docs/html/search/classes_8.js +++ b/docs/html/search/classes_8.js @@ -1,5 +1,5 @@ var searchData= [ - ['restapi_69',['RestAPI',['../classRestAPI.html',1,'']]], - ['restendpointhandler_70',['RestEndpointHandler',['../classRestEndpointHandler.html',1,'']]] + ['networkapi_140',['NetworkAPI',['../classNetworkAPI.html',1,'']]], + ['networklistener_141',['NetworkListener',['../classNetworkListener.html',1,'']]] ]; diff --git a/docs/html/search/classes_9.js b/docs/html/search/classes_9.js index b5e53d9..cc06831 100644 --- a/docs/html/search/classes_9.js +++ b/docs/html/search/classes_9.js @@ -1,4 +1,5 @@ var searchData= [ - ['spotifybackend_71',['SpotifyBackend',['../classSpotifyBackend.html',1,'']]] + ['playback_142',['Playback',['../classSpotifyApi_1_1Playback.html',1,'SpotifyApi']]], + ['playbacktrack_143',['PlaybackTrack',['../structPlaybackTrack.html',1,'']]] ]; diff --git a/docs/html/search/classes_a.js b/docs/html/search/classes_a.js index a3486c9..8f50ce2 100644 --- a/docs/html/search/classes_a.js +++ b/docs/html/search/classes_a.js @@ -1,4 +1,6 @@ var searchData= [ - ['track_72',['Track',['../classTrack.html',1,'']]] + ['queue_144',['Queue',['../structQueue.html',1,'']]], + ['queuedtrack_145',['QueuedTrack',['../structQueuedTrack.html',1,'']]], + ['queuestatus_146',['QueueStatus',['../structQueueStatus.html',1,'']]] ]; diff --git a/docs/html/search/classes_b.html b/docs/html/search/classes_b.html new file mode 100644 index 0000000..02927f7 --- /dev/null +++ b/docs/html/search/classes_b.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/classes_b.js b/docs/html/search/classes_b.js new file mode 100644 index 0000000..c0cbf94 --- /dev/null +++ b/docs/html/search/classes_b.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['ramdatastore_147',['RAMDataStore',['../classRAMDataStore.html',1,'']]], + ['requestinformation_148',['RequestInformation',['../structRequestInformation.html',1,'']]], + ['responseinformation_149',['ResponseInformation',['../structResponseInformation.html',1,'']]], + ['restapi_150',['RestAPI',['../classRestAPI.html',1,'']]], + ['restrequesthandler_151',['RestRequestHandler',['../classRestRequestHandler.html',1,'']]] +]; diff --git a/docs/html/search/classes_c.html b/docs/html/search/classes_c.html new file mode 100644 index 0000000..ab9f404 --- /dev/null +++ b/docs/html/search/classes_c.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/classes_c.js b/docs/html/search/classes_c.js new file mode 100644 index 0000000..84c3724 --- /dev/null +++ b/docs/html/search/classes_c.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['serializer_152',['Serializer',['../classSerializer.html',1,'']]], + ['simplescheduler_153',['SimpleScheduler',['../classSimpleScheduler.html',1,'']]], + ['spotifyapi_154',['SpotifyAPI',['../classSpotifyApi_1_1SpotifyAPI.html',1,'SpotifyApi']]], + ['spotifyauthorization_155',['SpotifyAuthorization',['../classSpotifyApi_1_1SpotifyAuthorization.html',1,'SpotifyApi']]], + ['spotifybackend_156',['SpotifyBackend',['../classSpotifyBackend.html',1,'']]], + ['spotifydummy_157',['SpotifyDummy',['../classSpotifyApi_1_1SpotifyDummy.html',1,'SpotifyApi']]], + ['spotifyerror_158',['SpotifyError',['../classSpotifyApi_1_1SpotifyError.html',1,'SpotifyApi']]], + ['spotifypaging_159',['SpotifyPaging',['../classSpotifyApi_1_1SpotifyPaging.html',1,'SpotifyApi']]] +]; diff --git a/docs/html/search/classes_d.html b/docs/html/search/classes_d.html new file mode 100644 index 0000000..7170da2 --- /dev/null +++ b/docs/html/search/classes_d.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/classes_d.js b/docs/html/search/classes_d.js new file mode 100644 index 0000000..317580d --- /dev/null +++ b/docs/html/search/classes_d.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['token_160',['Token',['../classSpotifyApi_1_1Token.html',1,'SpotifyApi']]], + ['track_161',['Track',['../classSpotifyApi_1_1Track.html',1,'SpotifyApi']]] +]; diff --git a/docs/html/search/enums_0.js b/docs/html/search/enums_0.js index b878dea..55a349a 100644 --- a/docs/html/search/enums_0.js +++ b/docs/html/search/enums_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['errorcode_114',['ErrorCode',['../Result_8h.html#a59e56af19e754a6aa26a612ebf91d05f',1,'Result.h']]] + ['errorcode_251',['ErrorCode',['../Result_8h.html#a59e56af19e754a6aa26a612ebf91d05f',1,'Result.h']]] ]; diff --git a/docs/html/search/enums_1.js b/docs/html/search/enums_1.js index 0cfb724..17b51bb 100644 --- a/docs/html/search/enums_1.js +++ b/docs/html/search/enums_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['playeraction_115',['PlayerAction',['../GlobalTypes_8h.html#aea132397c26cad8f8637a9422260deca',1,'GlobalTypes.h']]] + ['granttype_252',['GrantType',['../SpotifyAPITypes_8h.html#a4afaee2515de500ea4bfce9537ca0ceb',1,'SpotifyApi']]] ]; diff --git a/docs/html/search/enums_2.js b/docs/html/search/enums_2.js index 6f875cc..9d4c7e0 100644 --- a/docs/html/search/enums_2.js +++ b/docs/html/search/enums_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['queuetype_116',['QueueType',['../GlobalTypes_8h.html#ad18b8aa57b4ec903e6c8684855647be1',1,'GlobalTypes.h']]] + ['playeraction_253',['PlayerAction',['../GlobalTypes_8h.html#aea132397c26cad8f8637a9422260deca',1,'GlobalTypes.h']]] ]; diff --git a/docs/html/search/enums_3.html b/docs/html/search/enums_3.html new file mode 100644 index 0000000..e7918a6 --- /dev/null +++ b/docs/html/search/enums_3.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/enums_3.js b/docs/html/search/enums_3.js new file mode 100644 index 0000000..beadbd0 --- /dev/null +++ b/docs/html/search/enums_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['queuetype_254',['QueueType',['../GlobalTypes_8h.html#ad18b8aa57b4ec903e6c8684855647be1',1,'GlobalTypes.h']]] +]; diff --git a/docs/html/search/files_0.js b/docs/html/search/files_0.js index 6260462..16db023 100644 --- a/docs/html/search/files_0.js +++ b/docs/html/search/files_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['confighandler_2ecpp_73',['ConfigHandler.cpp',['../ConfigHandler_8cpp.html',1,'']]], - ['confighandler_2eh_74',['ConfigHandler.h',['../ConfigHandler_8h.html',1,'']]] + ['confighandler_2ecpp_162',['ConfigHandler.cpp',['../ConfigHandler_8cpp.html',1,'']]], + ['confighandler_2eh_163',['ConfigHandler.h',['../ConfigHandler_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_1.js b/docs/html/search/files_1.js index 5907170..9cb343b 100644 --- a/docs/html/search/files_1.js +++ b/docs/html/search/files_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['globaltypes_2eh_75',['GlobalTypes.h',['../GlobalTypes_8h.html',1,'']]] + ['datastore_2eh_164',['DataStore.h',['../DataStore_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_2.js b/docs/html/search/files_2.js index 74d37a0..ea3ac72 100644 --- a/docs/html/search/files_2.js +++ b/docs/html/search/files_2.js @@ -1,5 +1,4 @@ var searchData= [ - ['jukebox_2ecpp_76',['JukeBox.cpp',['../JukeBox_8cpp.html',1,'']]], - ['jukebox_2eh_77',['JukeBox.h',['../JukeBox_8h.html',1,'']]] + ['globaltypes_2eh_165',['GlobalTypes.h',['../GlobalTypes_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_3.js b/docs/html/search/files_3.js index 2152b55..3414c2a 100644 --- a/docs/html/search/files_3.js +++ b/docs/html/search/files_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['logginghandler_2ecpp_78',['LoggingHandler.cpp',['../LoggingHandler_8cpp.html',1,'']]], - ['logginghandler_2eh_79',['LoggingHandler.h',['../LoggingHandler_8h.html',1,'']]] + ['jukebox_2ecpp_166',['JukeBox.cpp',['../JukeBox_8cpp.html',1,'']]], + ['jukebox_2eh_167',['JukeBox.h',['../JukeBox_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_4.js b/docs/html/search/files_4.js index 6356ece..8b9874d 100644 --- a/docs/html/search/files_4.js +++ b/docs/html/search/files_4.js @@ -1,5 +1,5 @@ var searchData= [ - ['main_2ecpp_80',['main.cpp',['../main_8cpp.html',1,'']]], - ['musicbackend_2eh_81',['MusicBackend.h',['../MusicBackend_8h.html',1,'']]] + ['logginghandler_2ecpp_168',['LoggingHandler.cpp',['../LoggingHandler_8cpp.html',1,'']]], + ['logginghandler_2eh_169',['LoggingHandler.h',['../LoggingHandler_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_5.js b/docs/html/search/files_5.js index 7e63142..8bea829 100644 --- a/docs/html/search/files_5.js +++ b/docs/html/search/files_5.js @@ -1,6 +1,5 @@ var searchData= [ - ['networkapi_2ecpp_82',['NetworkAPI.cpp',['../NetworkAPI_8cpp.html',1,'']]], - ['networkapi_2eh_83',['NetworkAPI.h',['../NetworkAPI_8h.html',1,'']]], - ['networklistener_2eh_84',['NetworkListener.h',['../NetworkListener_8h.html',1,'']]] + ['main_2ecpp_170',['main.cpp',['../main_8cpp.html',1,'']]], + ['musicbackend_2eh_171',['MusicBackend.h',['../MusicBackend_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_6.js b/docs/html/search/files_6.js index 4e6f3e5..9ccad90 100644 --- a/docs/html/search/files_6.js +++ b/docs/html/search/files_6.js @@ -1,5 +1,6 @@ var searchData= [ - ['queue_2ecpp_85',['Queue.cpp',['../Queue_8cpp.html',1,'']]], - ['queue_2eh_86',['Queue.h',['../Queue_8h.html',1,'']]] + ['networkapi_2ecpp_172',['NetworkAPI.cpp',['../NetworkAPI_8cpp.html',1,'']]], + ['networkapi_2eh_173',['NetworkAPI.h',['../NetworkAPI_8h.html',1,'']]], + ['networklistener_2eh_174',['NetworkListener.h',['../NetworkListener_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_7.js b/docs/html/search/files_7.js index 87c31e2..81b23c1 100644 --- a/docs/html/search/files_7.js +++ b/docs/html/search/files_7.js @@ -1,9 +1,4 @@ var searchData= [ - ['restapi_2ecpp_87',['RestAPI.cpp',['../RestAPI_8cpp.html',1,'']]], - ['restapi_2eh_88',['RestAPI.h',['../RestAPI_8h.html',1,'']]], - ['restendpointhandler_2ecpp_89',['RestEndpointHandler.cpp',['../RestEndpointHandler_8cpp.html',1,'']]], - ['restendpointhandler_2eh_90',['RestEndpointHandler.h',['../RestEndpointHandler_8h.html',1,'']]], - ['result_2ecpp_91',['Result.cpp',['../Result_8cpp.html',1,'']]], - ['result_2eh_92',['Result.h',['../Result_8h.html',1,'']]] + ['queue_2eh_175',['Queue.h',['../Queue_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_8.js b/docs/html/search/files_8.js index 2bf9e89..b6b393d 100644 --- a/docs/html/search/files_8.js +++ b/docs/html/search/files_8.js @@ -1,4 +1,12 @@ var searchData= [ - ['spotifybackend_2eh_93',['SpotifyBackend.h',['../SpotifyBackend_8h.html',1,'']]] + ['ramdatastore_2eh_176',['RAMDataStore.h',['../RAMDataStore_8h.html',1,'']]], + ['requestinformation_2eh_177',['RequestInformation.h',['../RequestInformation_8h.html',1,'']]], + ['restapi_2ecpp_178',['RestAPI.cpp',['../RestAPI_8cpp.html',1,'']]], + ['restapi_2eh_179',['RestAPI.h',['../RestAPI_8h.html',1,'']]], + ['restendpointhandlers_2ecpp_180',['RestEndpointHandlers.cpp',['../RestEndpointHandlers_8cpp.html',1,'']]], + ['restendpointhandlers_2eh_181',['RestEndpointHandlers.h',['../RestEndpointHandlers_8h.html',1,'']]], + ['restrequesthandler_2ecpp_182',['RestRequestHandler.cpp',['../RestRequestHandler_8cpp.html',1,'']]], + ['restrequesthandler_2eh_183',['RestRequestHandler.h',['../RestRequestHandler_8h.html',1,'']]], + ['result_2eh_184',['Result.h',['../Result_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_9.js b/docs/html/search/files_9.js index 35dd2d6..d4567ba 100644 --- a/docs/html/search/files_9.js +++ b/docs/html/search/files_9.js @@ -1,5 +1,15 @@ var searchData= [ - ['track_2ecpp_94',['Track.cpp',['../Track_8cpp.html',1,'']]], - ['track_2eh_95',['Track.h',['../Track_8h.html',1,'']]] + ['serializer_2ecpp_185',['Serializer.cpp',['../Serializer_8cpp.html',1,'']]], + ['serializer_2eh_186',['Serializer.h',['../Serializer_8h.html',1,'']]], + ['simplescheduler_2ecpp_187',['SimpleScheduler.cpp',['../SimpleScheduler_8cpp.html',1,'']]], + ['simplescheduler_2eh_188',['SimpleScheduler.h',['../SimpleScheduler_8h.html',1,'']]], + ['spotifyapi_2ecpp_189',['SpotifyAPI.cpp',['../SpotifyAPI_8cpp.html',1,'']]], + ['spotifyapi_2eh_190',['SpotifyAPI.h',['../SpotifyAPI_8h.html',1,'']]], + ['spotifyapitypes_2ecpp_191',['SpotifyAPITypes.cpp',['../SpotifyAPITypes_8cpp.html',1,'']]], + ['spotifyapitypes_2eh_192',['SpotifyAPITypes.h',['../SpotifyAPITypes_8h.html',1,'']]], + ['spotifyauthorization_2ecpp_193',['SpotifyAuthorization.cpp',['../SpotifyAuthorization_8cpp.html',1,'']]], + ['spotifyauthorization_2eh_194',['SpotifyAuthorization.h',['../SpotifyAuthorization_8h.html',1,'']]], + ['spotifybackend_2ecpp_195',['SpotifyBackend.cpp',['../SpotifyBackend_8cpp.html',1,'']]], + ['spotifybackend_2eh_196',['SpotifyBackend.h',['../SpotifyBackend_8h.html',1,'']]] ]; diff --git a/docs/html/search/files_a.html b/docs/html/search/files_a.html new file mode 100644 index 0000000..118985d --- /dev/null +++ b/docs/html/search/files_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/files_a.js b/docs/html/search/files_a.js new file mode 100644 index 0000000..bea420d --- /dev/null +++ b/docs/html/search/files_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['tracks_2eh_197',['Tracks.h',['../Tracks_8h.html',1,'']]] +]; diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js index 3a88cd0..c0a1416 100644 --- a/docs/html/search/functions_0.js +++ b/docs/html/search/functions_0.js @@ -1,4 +1,6 @@ var searchData= [ - ['addtracktoqueue_96',['addTrackToQueue',['../classJukeBox.html#acbf8e845d6b8ca1e150a91a5c329820b',1,'JukeBox::addTrackToQueue()'],['../classNetworkListener.html#a37a93e71aa983e86260345e5e4982359',1,'NetworkListener::addTrackToQueue()']]] + ['addtrack_198',['addTrack',['../classDataStore.html#af31bb3ea7dd37ea7412a0d7c66e614a8',1,'DataStore::addTrack()'],['../classRAMDataStore.html#a4b944bdbcf5ad9dbb83310c3e331b059',1,'RAMDataStore::addTrack()']]], + ['addtracktoqueue_199',['addTrackToQueue',['../classJukeBox.html#acbf8e845d6b8ca1e150a91a5c329820b',1,'JukeBox::addTrackToQueue()'],['../classNetworkListener.html#a37a93e71aa983e86260345e5e4982359',1,'NetworkListener::addTrackToQueue()']]], + ['adduser_200',['addUser',['../classDataStore.html#ab386aa5aaf7b83fc7eecbe5916ea9c9c',1,'DataStore::addUser()'],['../classRAMDataStore.html#af448bf43df0110b43a40e7ee4b5cb3ac',1,'RAMDataStore::addUser()']]] ]; diff --git a/docs/html/search/functions_1.js b/docs/html/search/functions_1.js index 25bedb6..2630b2b 100644 --- a/docs/html/search/functions_1.js +++ b/docs/html/search/functions_1.js @@ -1,5 +1,7 @@ var searchData= [ - ['checkoptionalerror_97',['checkOptionalError',['../Result_8cpp.html#a65516cd58ee6ae0d9b3e5f4fc4c4a5cb',1,'checkOptionalError(TResultOpt ret): Result.cpp'],['../Result_8h.html#a65516cd58ee6ae0d9b3e5f4fc4c4a5cb',1,'checkOptionalError(TResultOpt ret): Result.cpp']]], - ['controlplayer_98',['controlPlayer',['../classJukeBox.html#a2141a7b4645dde1155b696d7258cd8c1',1,'JukeBox::controlPlayer()'],['../classNetworkListener.html#aafbc105ce3b3008f19fd373df4ebc383',1,'NetworkListener::controlPlayer()']]] + ['checkalternativeerror_201',['checkAlternativeError',['../Result_8h.html#a6b675dd28f1987a6202a29614e0bdae3',1,'Result.h']]], + ['checkforinconsistency_202',['checkForInconsistency',['../classSimpleScheduler.html#a9f86bd605e4c10cacf065b5753e27240',1,'SimpleScheduler']]], + ['controlplayer_203',['controlPlayer',['../classJukeBox.html#a2141a7b4645dde1155b696d7258cd8c1',1,'JukeBox::controlPlayer()'],['../classNetworkListener.html#aafbc105ce3b3008f19fd373df4ebc383',1,'NetworkListener::controlPlayer()']]], + ['createbasetrack_204',['createBaseTrack',['../classMusicBackend.html#a1239cd230929373e2bfb754f36b9f709',1,'MusicBackend::createBaseTrack()'],['../classSpotifyBackend.html#aa00eb1214463bc77ca207e5cf9f22deb',1,'SpotifyBackend::createBaseTrack()']]] ]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js index b9b5c8b..aa9be2e 100644 --- a/docs/html/search/functions_2.js +++ b/docs/html/search/functions_2.js @@ -1,6 +1,19 @@ var searchData= [ - ['generatesession_99',['generateSession',['../classJukeBox.html#a09250e342b2dd69438abf04d9f1b194f',1,'JukeBox::generateSession()'],['../classNetworkListener.html#a9a43c5dff18af1a206adb9cb33c9c652',1,'NetworkListener::generateSession()']]], - ['getvalueint_100',['getValueInt',['../classConfigHandler.html#aec101acc1e0961ec88c6897d9393da3f',1,'ConfigHandler']]], - ['getvaluestring_101',['getValueString',['../classConfigHandler.html#a0739c6cfe676547dfba163bfdcfe8974',1,'ConfigHandler']]] + ['generatesession_205',['generateSession',['../classJukeBox.html#a42a91fa2ca2060a1481e5be03c909332',1,'JukeBox::generateSession()'],['../classNetworkListener.html#a9c987d6bf2bfb3ac32528c19e1cd9317',1,'NetworkListener::generateSession()']]], + ['getaccesstoken_206',['getAccessToken',['../classSpotifyApi_1_1SpotifyAPI.html#af1167ea72c6bae03deec8d8d3325ba54',1,'SpotifyApi::SpotifyAPI::getAccessToken()'],['../classSpotifyApi_1_1SpotifyAuthorization.html#a4f585bfa111c73298109d6a43e02450b',1,'SpotifyApi::SpotifyAuthorization::getAccessToken()']]], + ['getavailabledevices_207',['getAvailableDevices',['../classSpotifyApi_1_1SpotifyAPI.html#a8c53faad5ef80cd0121ede0c48aca28d',1,'SpotifyApi::SpotifyAPI']]], + ['getcurrentplayback_208',['getCurrentPlayback',['../classMusicBackend.html#a25a901920a84a9834152c2aacf28efbf',1,'MusicBackend::getCurrentPlayback()'],['../classSpotifyBackend.html#a36c663bbf4f607a40af21b5213a9a0b9',1,'SpotifyBackend::getCurrentPlayback()'],['../classSpotifyApi_1_1SpotifyAPI.html#ac44c5580af168ab1b71139774c19a582',1,'SpotifyApi::SpotifyAPI::getCurrentPlayback()']]], + ['getcurrentqueues_209',['getCurrentQueues',['../classJukeBox.html#ab4552d328bbc8ddf9bfda905061d98dd',1,'JukeBox::getCurrentQueues()'],['../classNetworkListener.html#a5a04722db64e24631450f9ca5d1ef7dd',1,'NetworkListener::getCurrentQueues()']]], + ['getexpiresat_210',['getExpiresAt',['../classSpotifyApi_1_1SpotifyAuthorization.html#a1fe628cb5c782e6ed2b3dc43cf892f7d',1,'SpotifyApi::SpotifyAuthorization']]], + ['getlastplayback_211',['getLastPlayback',['../classSimpleScheduler.html#a0f6396c941bcfb0102d57dfcdb9f4c30',1,'SimpleScheduler']]], + ['getplayingtrack_212',['getPlayingTrack',['../classDataStore.html#a26e949891a194a7126017fc4493e7657',1,'DataStore::getPlayingTrack()'],['../classRAMDataStore.html#a590c3f45a352599f4ba164c1f05ac6c0',1,'RAMDataStore::getPlayingTrack()']]], + ['getqueue_213',['getQueue',['../classDataStore.html#afeebbf533d0b21aca9fcba83754b1f4a',1,'DataStore::getQueue()'],['../classRAMDataStore.html#acb413affd5c8fcad837f0f817ded8f20',1,'RAMDataStore::getQueue()']]], + ['getrefreshtoken_214',['getRefreshToken',['../classSpotifyApi_1_1SpotifyAuthorization.html#a6f9572508052dae2a5a445854263f39e',1,'SpotifyApi::SpotifyAuthorization']]], + ['getscopes_215',['getScopes',['../classSpotifyApi_1_1SpotifyAuthorization.html#af14742b62d6de55558a39d2c5aec5f03',1,'SpotifyApi::SpotifyAuthorization']]], + ['gettrack_216',['getTrack',['../classSpotifyApi_1_1SpotifyAPI.html#a7c239d1b61c8e80fdc01f757197100e8',1,'SpotifyApi::SpotifyAPI']]], + ['getuser_217',['getUser',['../classDataStore.html#ae2101b1f6b1f8fd00b0216bbca112691',1,'DataStore::getUser()'],['../classRAMDataStore.html#a6b1d53b36ee4e9d401342c0853206f7c',1,'RAMDataStore::getUser()']]], + ['getvalueint_218',['getValueInt',['../classConfigHandler.html#aec101acc1e0961ec88c6897d9393da3f',1,'ConfigHandler']]], + ['getvaluestring_219',['getValueString',['../classConfigHandler.html#a0739c6cfe676547dfba163bfdcfe8974',1,'ConfigHandler']]], + ['getvolume_220',['getVolume',['../classMusicBackend.html#a9c6d972426ee071034a7ab2c3cae990e',1,'MusicBackend::getVolume()'],['../classSpotifyBackend.html#a54530275a3787b8d22b99369b07f53fa',1,'SpotifyBackend::getVolume()']]] ]; diff --git a/docs/html/search/functions_3.js b/docs/html/search/functions_3.js index abecb67..0171990 100644 --- a/docs/html/search/functions_3.js +++ b/docs/html/search/functions_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['movetrack_102',['moveTrack',['../classJukeBox.html#acbf13a27d1dfe0922389b3871739a52b',1,'JukeBox::moveTrack()'],['../classNetworkListener.html#aa40327e801fb55a41362afe09825396c',1,'NetworkListener::moveTrack()']]] + ['hastrack_221',['hasTrack',['../classDataStore.html#a3e86350d2533c5e8fe4a3cc294819ba7',1,'DataStore::hasTrack()'],['../classRAMDataStore.html#abc3b8321530d0398f4ec1bd707410d07',1,'RAMDataStore::hasTrack()']]], + ['hasuser_222',['hasUser',['../classDataStore.html#a534c91e2d79168a6fd1bd582b6692514',1,'DataStore::hasUser()'],['../classRAMDataStore.html#aa121f84da8d284abee666d835a133af8',1,'RAMDataStore::hasUser()']]] ]; diff --git a/docs/html/search/functions_4.js b/docs/html/search/functions_4.js index 8970874..8bdcdc0 100644 --- a/docs/html/search/functions_4.js +++ b/docs/html/search/functions_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['querytracks_103',['queryTracks',['../classJukeBox.html#a5d9708b771a667cec6b960319c1b0813',1,'JukeBox::queryTracks()'],['../classNetworkListener.html#a5d27adf3626f08e552a0f1c2f3daab74',1,'NetworkListener::queryTracks()']]] + ['initbackend_223',['initBackend',['../classMusicBackend.html#a9c20d8af1a5dd01766cb1595a2546ece',1,'MusicBackend::initBackend()'],['../classSpotifyBackend.html#ad1cb12d1fa585e6d4e25d7437bdbdde4',1,'SpotifyBackend::initBackend()']]], + ['issessionexpired_224',['isSessionExpired',['../classDataStore.html#aa7582a831e7f5b10d52ffd42526acd4b',1,'DataStore::isSessionExpired()'],['../classRAMDataStore.html#a5741d23da3acb2de51a9789be973997f',1,'RAMDataStore::isSessionExpired()']]] ]; diff --git a/docs/html/search/functions_5.js b/docs/html/search/functions_5.js index c9b7720..d8096df 100644 --- a/docs/html/search/functions_5.js +++ b/docs/html/search/functions_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['removetrack_104',['removeTrack',['../classJukeBox.html#a4ef7b0f9ab225fc18b606a1ec3fb830d',1,'JukeBox::removeTrack()'],['../classNetworkListener.html#a017bf4541619e098880ad115fd1ba6e7',1,'NetworkListener::removeTrack()']]] + ['movetrack_225',['moveTrack',['../classJukeBox.html#a47da68cdc2e529fc5b74c846ac196db5',1,'JukeBox::moveTrack()'],['../classNetworkListener.html#a2d0015c8ce1c73931662102539709a5f',1,'NetworkListener::moveTrack()']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index 8103c8d..259b76c 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['setconfigfilepath_105',['setConfigFilePath',['../classConfigHandler.html#a384913951094cc79279cf3b6f13a360a',1,'ConfigHandler']]] + ['nexttrack_226',['nextTrack',['../classDataStore.html#a9c56b41891e35f8fab0ddbcb70a7fc25',1,'DataStore::nextTrack()'],['../classSimpleScheduler.html#af78810c915e7a8220fb4d5e8dd8caac0',1,'SimpleScheduler::nextTrack()'],['../classRAMDataStore.html#a78cd87ff7576ed79447497714f1774b0',1,'RAMDataStore::nextTrack()']]] ]; diff --git a/docs/html/search/functions_7.js b/docs/html/search/functions_7.js index 213732e..907d93a 100644 --- a/docs/html/search/functions_7.js +++ b/docs/html/search/functions_7.js @@ -1,4 +1,5 @@ var searchData= [ - ['votetrack_106',['voteTrack',['../classJukeBox.html#a63dd8c5ab590dda4ccd3fe3476134acd',1,'JukeBox::voteTrack()'],['../classNetworkListener.html#a5eaa0385f3f14a0797e47d53aba2a5aa',1,'NetworkListener::voteTrack()']]] + ['pause_227',['pause',['../classMusicBackend.html#a8b3eb02f10084c51ab27de3c50e5de33',1,'MusicBackend::pause()'],['../classSpotifyBackend.html#a9eb9e84f3399e3fd67a13fa88e10053b',1,'SpotifyBackend::pause()'],['../classSpotifyApi_1_1SpotifyAPI.html#ace9f4542cf96fe6c544196c6e0403374',1,'SpotifyApi::SpotifyAPI::pause()']]], + ['play_228',['play',['../classMusicBackend.html#acb1ce1a8225076a2a9c0ee9a33e61c15',1,'MusicBackend::play()'],['../classSpotifyBackend.html#afe8f265ec12956750085be2101f468b6',1,'SpotifyBackend::play()'],['../classSpotifyApi_1_1SpotifyAPI.html#a3bd3dcd0260422e8db16fb3c6efb0b06',1,'SpotifyApi::SpotifyAPI::play()']]] ]; diff --git a/docs/html/search/functions_8.html b/docs/html/search/functions_8.html new file mode 100644 index 0000000..75fc0be --- /dev/null +++ b/docs/html/search/functions_8.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/functions_8.js b/docs/html/search/functions_8.js new file mode 100644 index 0000000..e3c5f95 --- /dev/null +++ b/docs/html/search/functions_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['querytracks_229',['queryTracks',['../classJukeBox.html#a0ee5230486c8fe35f5153e97dbac7263',1,'JukeBox::queryTracks()'],['../classMusicBackend.html#ad07c6c9389e7e0785cf31e1a962f5c88',1,'MusicBackend::queryTracks()'],['../classNetworkListener.html#a452d6977cab9c55841d2dc9a28e15921',1,'NetworkListener::queryTracks()'],['../classSpotifyBackend.html#a8fc19f0bf05ec06df10521237c3cdc18',1,'SpotifyBackend::queryTracks()']]] +]; diff --git a/docs/html/search/functions_9.html b/docs/html/search/functions_9.html new file mode 100644 index 0000000..7541c9e --- /dev/null +++ b/docs/html/search/functions_9.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/functions_9.js b/docs/html/search/functions_9.js new file mode 100644 index 0000000..f10f6fe --- /dev/null +++ b/docs/html/search/functions_9.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['refreshaccesstoken_230',['refreshAccessToken',['../classSpotifyApi_1_1SpotifyAPI.html#a1c6cce2f5faa4fbb6b5e8186b0f9ecc8',1,'SpotifyApi::SpotifyAPI::refreshAccessToken()'],['../classSpotifyApi_1_1SpotifyAuthorization.html#a8400b5fe6c53b1499b5da51a0ccc184a',1,'SpotifyApi::SpotifyAuthorization::refreshAccessToken()']]], + ['removetrack_231',['removeTrack',['../classJukeBox.html#a4ef7b0f9ab225fc18b606a1ec3fb830d',1,'JukeBox::removeTrack()'],['../classNetworkListener.html#a017bf4541619e098880ad115fd1ba6e7',1,'NetworkListener::removeTrack()'],['../classDataStore.html#ac1220bd1c0cc8b2f7d696055d8975a4e',1,'DataStore::removeTrack()'],['../classRAMDataStore.html#ab1a6875bb540b05bf999f4518121a765',1,'RAMDataStore::removeTrack()']]], + ['removeuser_232',['removeUser',['../classDataStore.html#a7f8c1781b2bd886c7e1ab12ff27cdb44',1,'DataStore::removeUser()'],['../classRAMDataStore.html#aa02060ffe102d0a6ab87243b8f8a86c5',1,'RAMDataStore::removeUser()']]] +]; diff --git a/docs/html/search/functions_a.html b/docs/html/search/functions_a.html new file mode 100644 index 0000000..5a5be63 --- /dev/null +++ b/docs/html/search/functions_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/functions_a.js b/docs/html/search/functions_a.js new file mode 100644 index 0000000..68b7fcc --- /dev/null +++ b/docs/html/search/functions_a.js @@ -0,0 +1,13 @@ +var searchData= +[ + ['search_233',['search',['../classSpotifyApi_1_1SpotifyAPI.html#aa7ededcbad860867fa3e483c4d3df741',1,'SpotifyApi::SpotifyAPI']]], + ['setconfigfilepath_234',['setConfigFilePath',['../classConfigHandler.html#a384913951094cc79279cf3b6f13a360a',1,'ConfigHandler']]], + ['setplayback_235',['setPlayback',['../classMusicBackend.html#af43664f14de0e297e063973d73a1a448',1,'MusicBackend::setPlayback()'],['../classSpotifyBackend.html#a47f725a6b97e12305589631926176eb6',1,'SpotifyBackend::setPlayback()']]], + ['setscopes_236',['setScopes',['../classSpotifyApi_1_1SpotifyAuthorization.html#a327c05232055655fec751cba4e2fef77',1,'SpotifyApi::SpotifyAuthorization']]], + ['setvolume_237',['setVolume',['../classMusicBackend.html#a473a7068198abaccd37635b9cfb58df9',1,'MusicBackend::setVolume()'],['../classSpotifyBackend.html#a4f930b48086a96faa441963dd247af02',1,'SpotifyBackend::setVolume()'],['../classSpotifyApi_1_1SpotifyAPI.html#a43539a16bdcf99d53f1f936c4b892648',1,'SpotifyApi::SpotifyAPI::setVolume()']]], + ['start_238',['start',['../classJukeBox.html#ae94d3046cc3585b677a123db1e2ae81d',1,'JukeBox::start()'],['../classSimpleScheduler.html#a07d0697ca9f259a871f2ab5df3a41358',1,'SimpleScheduler::start()']]], + ['startserver_239',['startServer',['../classSpotifyApi_1_1SpotifyAuthorization.html#a3d6cc4af8f15cdb6b63f1a597b3b16e9',1,'SpotifyApi::SpotifyAuthorization']]], + ['stopserver_240',['stopServer',['../classSpotifyApi_1_1SpotifyAuthorization.html#a0e8bce76ef2c61447680ad5cbef4a44e',1,'SpotifyApi::SpotifyAuthorization']]], + ['stringbase64encode_241',['stringBase64Encode',['../classSpotifyApi_1_1SpotifyAPI.html#ae606d64659f7e59820986dfa3e766c73',1,'SpotifyApi::SpotifyAPI']]], + ['stringurlencode_242',['stringUrlEncode',['../classSpotifyApi_1_1SpotifyAPI.html#a6aa3086f9b1e71840c1175c6dfb1f4c0',1,'SpotifyApi::SpotifyAPI']]] +]; diff --git a/docs/html/search/functions_b.html b/docs/html/search/functions_b.html new file mode 100644 index 0000000..fc2d5aa --- /dev/null +++ b/docs/html/search/functions_b.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/functions_b.js b/docs/html/search/functions_b.js new file mode 100644 index 0000000..1d35df6 --- /dev/null +++ b/docs/html/search/functions_b.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['transferusersplayback_243',['transferUsersPlayback',['../classSpotifyApi_1_1SpotifyAPI.html#a88c9245d103e8ca354ada6716cfbd71b',1,'SpotifyApi::SpotifyAPI']]] +]; diff --git a/docs/html/search/functions_c.html b/docs/html/search/functions_c.html new file mode 100644 index 0000000..a1a1437 --- /dev/null +++ b/docs/html/search/functions_c.html @@ -0,0 +1,30 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/html/search/functions_c.js b/docs/html/search/functions_c.js new file mode 100644 index 0000000..2bc3997 --- /dev/null +++ b/docs/html/search/functions_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['votetrack_244',['voteTrack',['../classJukeBox.html#a63dd8c5ab590dda4ccd3fe3476134acd',1,'JukeBox::voteTrack()'],['../classNetworkListener.html#a5eaa0385f3f14a0797e47d53aba2a5aa',1,'NetworkListener::voteTrack()'],['../classDataStore.html#a6138d338385475e34bcbbb76434a0069',1,'DataStore::voteTrack()'],['../classRAMDataStore.html#ad3fcb14a48c0cea4c39699025526d51a',1,'RAMDataStore::voteTrack()']]] +]; diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js index 97362a5..84ecc9d 100644 --- a/docs/html/search/pages_0.js +++ b/docs/html/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['class_20diagram_117',['Class diagram',['../class_diagram.html',1,'']]] + ['class_20diagram_255',['Class diagram',['../class_diagram.html',1,'']]] ]; diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js index 0777a65..a0a5b91 100644 --- a/docs/html/search/pages_1.js +++ b/docs/html/search/pages_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['rest_20interface_118',['REST interface',['../rest_interface.html',1,'']]] + ['rest_20interface_256',['REST interface',['../rest_interface.html',1,'']]] ]; diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js index 86b445a..05c42f1 100644 --- a/docs/html/search/pages_2.js +++ b/docs/html/search/pages_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['virtualjukebox_20landing_20page_119',['VirtualJukebox landing page',['../index.html',1,'']]] + ['virtualjukebox_20landing_20page_257',['VirtualJukebox landing page',['../index.html',1,'']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 28d9032..79d6bc3 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,11 +1,11 @@ var indexSectionsWithContent = { - 0: "acegjlmnpqrstv", - 1: "cejlmnpqrst", - 2: "cgjlmnqrst", - 3: "acgmqrsv", - 4: "qt", - 5: "epq", + 0: "abcdeghijlmnpqrstv", + 1: "abcdeijmnpqrst", + 2: "cdgjlmnqrst", + 3: "acghimnpqrstv", + 4: "t", + 5: "egpq", 6: "crv" }; diff --git a/docs/html/search/typedefs_0.js b/docs/html/search/typedefs_0.js index c14aeda..dc4be8a 100644 --- a/docs/html/search/typedefs_0.js +++ b/docs/html/search/typedefs_0.js @@ -1,4 +1,9 @@ var searchData= [ - ['queues_107',['Queues',['../NetworkListener_8h.html#adcc80250835bc2b99ce350f7cc40730b',1,'NetworkListener.h']]] + ['tpassword_245',['TPassword',['../GlobalTypes_8h.html#a0427177b8e88da62a10f9acfcece1359',1,'GlobalTypes.h']]], + ['tresult_246',['TResult',['../Result_8h.html#a442760d03514e6c849a35e3f0c768bef',1,'Result.h']]], + ['tresultopt_247',['TResultOpt',['../Result_8h.html#aada7d5476a077b5984176864eefe0c5f',1,'Result.h']]], + ['tsessionid_248',['TSessionID',['../GlobalTypes_8h.html#a0de933f1c954bae9fd7edbff41cf9a91',1,'GlobalTypes.h']]], + ['ttrackid_249',['TTrackID',['../GlobalTypes_8h.html#a913b47270997e628c2767eebc80a2e6a',1,'GlobalTypes.h']]], + ['tvote_250',['TVote',['../GlobalTypes_8h.html#a5842247e6ba9809bdba7898b9fe2b3dd',1,'GlobalTypes.h']]] ]; diff --git a/docs/html/structPlaybackTrack-members.html b/docs/html/structPlaybackTrack-members.html new file mode 100644 index 0000000..74ee88a --- /dev/null +++ b/docs/html/structPlaybackTrack-members.html @@ -0,0 +1,89 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +
      PlaybackTrack Member List
      +
      +
      + +

      This is the complete list of members for PlaybackTrack, including all inherited members.

      + + + + + + + + + + + +
      addedBy (defined in BaseTrack)BaseTrack
      album (defined in BaseTrack)BaseTrack
      artist (defined in BaseTrack)BaseTrack
      durationMs (defined in BaseTrack)BaseTrack
      iconUri (defined in BaseTrack)BaseTrack
      isPlaying (defined in PlaybackTrack)PlaybackTrack
      operator==(const BaseTrack &tr) (defined in BaseTrack)BaseTrackinline
      progressMs (defined in PlaybackTrack)PlaybackTrack
      title (defined in BaseTrack)BaseTrack
      trackId (defined in BaseTrack)BaseTrack
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structPlaybackTrack.html b/docs/html/structPlaybackTrack.html new file mode 100644 index 0000000..574325e --- /dev/null +++ b/docs/html/structPlaybackTrack.html @@ -0,0 +1,137 @@ + + + + + + + +VirtualJukebox: PlaybackTrack Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Public Attributes | +List of all members
      +
      +
      PlaybackTrack Struct Reference
      +
      +
      + +

      Specialized track representing the currently playing track. + More...

      + +

      #include <Tracks.h>

      +
      +Inheritance diagram for PlaybackTrack:
      +
      +
      + + +BaseTrack + +
      + + + + + + + + + + + + + + + + + + + + + +

      +Public Attributes

      +int progressMs
       
      +bool isPlaying
       
      - Public Attributes inherited from BaseTrack
      +TTrackID trackId
       
      +std::string title
       
      +std::string album
       
      +std::string artist
       
      +unsigned durationMs
       
      +std::string iconUri
       
      +std::string addedBy
       
      + + + + +

      +Additional Inherited Members

      - Public Member Functions inherited from BaseTrack
      +bool operator== (const BaseTrack &tr)
       
      +

      Detailed Description

      +

      Specialized track representing the currently playing track.

      +
      The documentation for this struct was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structPlaybackTrack.png b/docs/html/structPlaybackTrack.png new file mode 100644 index 0000000000000000000000000000000000000000..cfcbea1af6330c009b3169030a66ccb9886e844f GIT binary patch literal 481 zcmV<70UrK|P)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0004SNklw8=LZLrC30d-paQvjWx8tV*~IVk%&0*?NEPDx$4 z3{h%YY6D1J?*q!FyZH78Y5*^U=$Rb!fI3D}Tl^e6n(eY!x2W|SoTRp_w@8v)Er2As z`U*gdF-{b~OS%Ef)NH`*HkmLRa9@8eVLIRoZqWh&_*wt}R|^2(Y5@RTEdYS41psih z006H3As~bhW{LnXPYVFx>h}OCo3o@MJuo80$W zygVT^YI?K{&(UCvS!D&h#!5sM(WBJDuTAGrtk$RpwaKJ!Se=NiD(R{%l?VWNHj X$YK>3l2RyQ00000NkvXXu0mjfL0QcI literal 0 HcmV?d00001 diff --git a/docs/html/structQueue-members.html b/docs/html/structQueue-members.html new file mode 100644 index 0000000..a3bb5b6 --- /dev/null +++ b/docs/html/structQueue-members.html @@ -0,0 +1,80 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +
      Queue Member List
      +
      +
      + +

      This is the complete list of members for Queue, including all inherited members.

      + + +
      tracks (defined in Queue)Queue
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structQueue.html b/docs/html/structQueue.html new file mode 100644 index 0000000..b6ef788 --- /dev/null +++ b/docs/html/structQueue.html @@ -0,0 +1,96 @@ + + + + + + + +VirtualJukebox: Queue Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Public Attributes | +List of all members
      +
      +
      Queue Struct Reference
      +
      +
      + +

      Respresents a queue which is returned to the clients. + More...

      + +

      #include <Queue.h>

      + + + + +

      +Public Attributes

      +std::vector< QueuedTrack > tracks
       
      +

      Detailed Description

      +

      Respresents a queue which is returned to the clients.

      +
      The documentation for this struct was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structQueueStatus-members.html b/docs/html/structQueueStatus-members.html new file mode 100644 index 0000000..86874ef --- /dev/null +++ b/docs/html/structQueueStatus-members.html @@ -0,0 +1,82 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +
      QueueStatus Member List
      +
      +
      + +

      This is the complete list of members for QueueStatus, including all inherited members.

      + + + + +
      adminQueue (defined in QueueStatus)QueueStatus
      currentTrack (defined in QueueStatus)QueueStatus
      normalQueue (defined in QueueStatus)QueueStatus
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structQueueStatus.html b/docs/html/structQueueStatus.html new file mode 100644 index 0000000..87d7bfc --- /dev/null +++ b/docs/html/structQueueStatus.html @@ -0,0 +1,102 @@ + + + + + + + +VirtualJukebox: QueueStatus Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Public Attributes | +List of all members
      +
      +
      QueueStatus Struct Reference
      +
      +
      + +

      Wraps all information to return if a client requests the current queue status. + More...

      + +

      #include <Queue.h>

      + + + + + + + + +

      +Public Attributes

      +Queue normalQueue
       
      +Queue adminQueue
       
      +std::optional< PlaybackTrack > currentTrack
       
      +

      Detailed Description

      +

      Wraps all information to return if a client requests the current queue status.

      +
      The documentation for this struct was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structQueuedTrack-members.html b/docs/html/structQueuedTrack-members.html new file mode 100644 index 0000000..c2bffff --- /dev/null +++ b/docs/html/structQueuedTrack-members.html @@ -0,0 +1,91 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +
      QueuedTrack Member List
      +
      +
      + +

      This is the complete list of members for QueuedTrack, including all inherited members.

      + + + + + + + + + + + + + +
      addedBy (defined in BaseTrack)BaseTrack
      album (defined in BaseTrack)BaseTrack
      artist (defined in BaseTrack)BaseTrack
      durationMs (defined in BaseTrack)BaseTrack
      iconUri (defined in BaseTrack)BaseTrack
      insertedAt (defined in QueuedTrack)QueuedTrack
      operator<(const QueuedTrack tr) (defined in QueuedTrack)QueuedTrackinline
      operator==(const BaseTrack &tr) (defined in BaseTrack)BaseTrackinline
      title (defined in BaseTrack)BaseTrack
      trackId (defined in BaseTrack)BaseTrack
      userHasVoted (defined in QueuedTrack)QueuedTrack
      votes (defined in QueuedTrack)QueuedTrack
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structQueuedTrack.html b/docs/html/structQueuedTrack.html new file mode 100644 index 0000000..6fd6096 --- /dev/null +++ b/docs/html/structQueuedTrack.html @@ -0,0 +1,144 @@ + + + + + + + +VirtualJukebox: QueuedTrack Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Public Member Functions | +Public Attributes | +List of all members
      +
      +
      QueuedTrack Struct Reference
      +
      +
      + +

      Specialized track which is found inside queues. + More...

      + +

      #include <Tracks.h>

      +
      +Inheritance diagram for QueuedTrack:
      +
      +
      + + +BaseTrack + +
      + + + + + + + +

      +Public Member Functions

      +bool operator< (const QueuedTrack tr)
       
      - Public Member Functions inherited from BaseTrack
      +bool operator== (const BaseTrack &tr)
       
      + + + + + + + + + + + + + + + + + + + + + + +

      +Public Attributes

      +int votes
       
      +TVote userHasVoted
       
      +uint64_t insertedAt
       
      - Public Attributes inherited from BaseTrack
      +TTrackID trackId
       
      +std::string title
       
      +std::string album
       
      +std::string artist
       
      +unsigned durationMs
       
      +std::string iconUri
       
      +std::string addedBy
       
      +

      Detailed Description

      +

      Specialized track which is found inside queues.

      +
      The documentation for this struct was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structQueuedTrack.png b/docs/html/structQueuedTrack.png new file mode 100644 index 0000000000000000000000000000000000000000..2cbaa774c867132ed596bea260caeb12cbcfcf44 GIT binary patch literal 443 zcmV;s0Yv_ZP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0003>Nkl$@TCa;vHu)B&u5W$rom|P+yzGpb^|*DT zh4FO*x!w8!xwmONv|AX+J8tawY{^=)=kpor2zawG=7;y>{{}O&rzAgsTuLbs0)TD3 z03bwRQ8y%0x#|MCm^rn()+(F+KI%Ey!RaNcEu8uI0>!N3*w3AlkRS=FCI2Wh~pOS6Q z<|%oXLzbrGs(mDPWyqRYlf}1-UCwGGFWmKJL%g)kE_}9R-Lo^#Z48`gSj>iG`iS&R l<^Ki%J(BzYG7(XPz5tp-6Pw-sv~K_a002ovPDHLkV1l#L&J+Lu literal 0 HcmV?d00001 diff --git a/docs/html/structRequestInformation-members.html b/docs/html/structRequestInformation-members.html new file mode 100644 index 0000000..2849c25 --- /dev/null +++ b/docs/html/structRequestInformation-members.html @@ -0,0 +1,83 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +
      RequestInformation Member List
      +
      +
      + +

      This is the complete list of members for RequestInformation, including all inherited members.

      + + + + + +
      args (defined in RequestInformation)RequestInformation
      body (defined in RequestInformation)RequestInformation
      method (defined in RequestInformation)RequestInformation
      path (defined in RequestInformation)RequestInformation
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structRequestInformation.html b/docs/html/structRequestInformation.html new file mode 100644 index 0000000..4e2aa92 --- /dev/null +++ b/docs/html/structRequestInformation.html @@ -0,0 +1,105 @@ + + + + + + + +VirtualJukebox: RequestInformation Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Public Attributes | +List of all members
      +
      +
      RequestInformation Struct Reference
      +
      +
      + +

      Wraps all relevant pieces of information provided by a HTTP request. + More...

      + +

      #include <RequestInformation.h>

      + + + + + + + + + + +

      +Public Attributes

      +std::string path
       
      +std::string method
       
      +std::string body
       
      +std::map< std::string, std::string, httpserver::http::arg_comparator > args
       
      +

      Detailed Description

      +

      Wraps all relevant pieces of information provided by a HTTP request.

      +
      The documentation for this struct was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structResponseInformation-members.html b/docs/html/structResponseInformation-members.html new file mode 100644 index 0000000..a069afd --- /dev/null +++ b/docs/html/structResponseInformation-members.html @@ -0,0 +1,81 @@ + + + + + + + +VirtualJukebox: Member List + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +
      ResponseInformation Member List
      +
      +
      + +

      This is the complete list of members for ResponseInformation, including all inherited members.

      + + + +
      body (defined in ResponseInformation)ResponseInformation
      code (defined in ResponseInformation)ResponseInformation
      + +
      +Generated by   +doxygen + 1.8.16 +
      + + diff --git a/docs/html/structResponseInformation.html b/docs/html/structResponseInformation.html new file mode 100644 index 0000000..62acee0 --- /dev/null +++ b/docs/html/structResponseInformation.html @@ -0,0 +1,99 @@ + + + + + + + +VirtualJukebox: ResponseInformation Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      VirtualJukebox +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Public Attributes | +List of all members
      +
      +
      ResponseInformation Struct Reference
      +
      +
      + +

      Wraps all needed pieces of information to form a proper HTTP response. + More...

      + +

      #include <RequestInformation.h>

      + + + + + + +

      +Public Attributes

      +std::string body
       
      +int code = 200
       
      +

      Detailed Description

      +

      Wraps all needed pieces of information to form a proper HTTP response.

      +
      The documentation for this struct was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.16 +
      + +