+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+DataStore.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defines types and constants that are used globally.
virtual TResult< BaseTrack > removeTrack(TTrackID const &tID, QueueType q)=0
Remove Track from one of the internal Queues.
virtual TResultOpt addTrack(BaseTrack const &track, QueueType q)=0
Add Track to one of the internal Queues.
Defines function return values and types.
virtual TResult< bool > hasTrack(TTrackID const &tID, QueueType q)=0
Check for Track in one of the internal Queues.
Class Queue definition.
virtual bool hasUser(TSessionID const &sID)=0
Query the internal user list whether a certain user exists.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
virtual TResultOpt voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote)=0
Upvote/remove Upvote from a track.
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
virtual TResult< std::optional< QueuedTrack > > getPlayingTrack()=0
Get the currently playing track.
virtual TResult< bool > isSessionExpired(TSessionID const &sID)=0
Check if user session is expired.
virtual TResultOpt addUser(User const &user)=0
Add a User to the internal List of registered Users.
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...
Definitions of all track related structs.
virtual TResult< User > getUser(TSessionID const &sID)=0
Get a User from the internal List of registered Users.
+Generated by +
+ 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 @@
-
@@ -91,7 +91,7 @@
using TTrackID = std::string Track ID type.
Track ID type.
using TPassword = std::string 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 @@
-
-
+
+
+
+
-
-
+
+
+
+
+
+
+
-
-
+
+
+
-
+
-
-
-
-
+
+
+
+
+
+
-
-
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 @@
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 @@
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
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 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + -
-
+
+
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 @@
@@ -78,10 +77,9 @@
-
-
-
-
+
+
+
@@ -90,13 +88,6 @@
-
-
+
-
+
+
-
-
+
-
-
-
+
+
+
-
-
-
+
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 @@
+
+
+
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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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 @@
-
+
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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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 @@
Valid error codes enumerator.
VirtualJukebox: src/Result.h Source File
+VirtualJukebox: src/Types/Result.h Source File
@@ -61,7 +61,7 @@
-
-
-
-
-
+
+
+
+
+
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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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 @@
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 @@ -
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
- 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
- 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 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + +Defines types and constants that are used globally.
TResultOpt voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote) override
Vote for a track or revoke a vote.
Definition: JukeBox.cpp:50
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
Class DataStore definition.
Definition of class NetworkAPI.
TResultOpt voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote) override
Vote for a track or revoke a vote.
Definition: JukeBox.cpp:262
TResult< QueueStatus > getCurrentQueues(TSessionID const &sid)
Query the content of the current queues.
Definition: JukeBox.cpp:136
TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action) override
Controls the behaviour of the music player.
Definition: JukeBox.cpp:66
TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action) override
Controls the behaviour of the music player.
Definition: JukeBox.cpp:364
TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue) override
Move a track between queues.
Definition: JukeBox.cpp:322
Interface for MusicBackend.
Defines function return values and types.
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
TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type) override
Move a track between queues.
Definition: JukeBox.cpp:60
TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid) override
Remove a track from a queue.
Definition: JukeBox.cpp:56
TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid) override
Remove a track from a queue.
Definition: JukeBox.cpp:272
bool start(std::string const &exeName, std::string const &configFilePath)
Initializes ConfigHandler, LoggingHandler as well as the MusicBackend.
Definition: JukeBox.cpp:41
A simple track scheduler (for presentation purposes).
Definition: SimpleScheduler.h:24
Provides interface methods for all supported requests.
Definition: NetworkListener.h:34
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
Class Queue definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
Definition: JukeBox.h:29
TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type) override
Querie the content of the current queues.
Definition: JukeBox.cpp:44
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
Core class which combines all interface implementations in a working server application.
Definition: JukeBox.h:33
Class SimpleScheduler definition.
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
TResult< TSessionID > generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname) override
Definition: JukeBox.cpp:87
Interface Class NetworkListener definition.
TResult< TSessionID > generateSession(TPassword const &pw) override
Generate a session for an user.
Definition: JukeBox.cpp:26
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 @@ -
+
LoggingHandler.cpp File Reference
-
+
+
+
+
+
+
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 @@
Class LoggingHandler implementation. +
LoggingHandler implementation. More...
-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.
LoggingHandler.h File Reference
-
-
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 @@
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.
@@ -72,20 +72,24 @@
Go to the documentation of this file.
-
-
-
+
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
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 @@
-
-
-
-
-
-
+
+
+
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 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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.
Defines types and constants that are used globally.
Definition: Track.h:12
Definition: MusicBackend.h:21
virtual TResult< BaseTrack > createBaseTrack(TTrackID const &trackID)=0
Creates a new BaseTrack instance with the given trackID.
virtual TResult< std::vector< BaseTrack > > queryTracks(std::string const &pattern, size_t const num)=0
Queries the backend for all tracks given a pattern.
Defines function return values and types.
virtual TResult< std::optional< PlaybackTrack > > getCurrentPlayback()=0
Returns the current playback of the active device as a playback track.
Class Queue definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
Class Track definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
virtual TResultOpt setPlayback(BaseTrack const &track)=0
Set the given track as playback (means the track gets played).
virtual TResult< size_t > getVolume()=0
Returns the volume of the actual device in percent.
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 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + -
Provides interface methods for all supported requests.
Definition: NetworkListener.h:34
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
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 @@
NetworkListener.h File Reference
#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.
| 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 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Defines types and constants that are used globally.
virtual TResult< QueueStatus > getCurrentQueues(TSessionID const &sid)=0
Query the content of the current queues.
Defines function return values and types.
virtual TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
Querie the content of the current queues.
virtual TResultOpt addTrackToQueue(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
Add a track to a given queue (normal or admin).
virtual TResultOpt removeTrack(TSessionID const &sid, TTrackID const &trkid)=0
Remove a track from a queue.
virtual TResult< TSessionID > generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname)=0
Generate a session for an user.
virtual TResultOpt voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0
Vote for a track or revoke a vote.
virtual TResultOpt moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0
Move a track between queues.
Provides interface methods for all supported requests.
Definition: NetworkListener.h:34
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
Class Queue definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
virtual TResult< TSessionID > generateSession(TPassword const &pw)=0
Generate a session for an user.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
virtual TResult< std::vector< BaseTrack > > queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0
Query available tracks using different music backends.
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
virtual TResultOpt controlPlayer(TSessionID const &sid, PlayerAction action)=0
Controls the behaviour of the music player.
Definition: Queue.h:12
virtual TResult< std::vector< Track > > queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0
Query available tracks using different music backends.
Class Track definition.
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 @@ -
@@ -72,18 +72,25 @@
-
VirtualJukebox: src/Queue.h Source File
+VirtualJukebox: src/Types/Queue.h Source File
@@ -61,7 +61,7 @@
Class Queue definition. +
Class Queue definition. More...
- +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
- 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 @@ -
@@ -75,14 +75,27 @@
-
-
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
-Definition: Queue.h:12
Definitions of all track related structs.
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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+RAMDataStore.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defines types and constants that are used globally.
Class DataStore definition.
bool hasUser(TSessionID const &ID) override
Query the internal user list whether a certain user exists.
Definition: RAMDataStore.cpp:283
TResultOpt addUser(User const &user) override
Add a User to the internal List of registered Users.
Definition: RAMDataStore.cpp:31
TResult< bool > hasTrack(TTrackID const &ID, QueueType q) override
Check for Track in one of the internal Queues.
Definition: RAMDataStore.cpp:176
TResult< User > getUser(TSessionID const &ID) override
Get a User from the internal List of registered Users.
Definition: RAMDataStore.cpp:46
TResultOpt addTrack(BaseTrack const &track, QueueType q) override
Add Track to one of the internal Queues.
Definition: RAMDataStore.cpp:105
TResult< bool > isSessionExpired(TSessionID const &ID) override
Check if user session is expired.
Definition: RAMDataStore.cpp:84
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
Defines function return values and types.
TResult< BaseTrack > removeTrack(TTrackID const &ID, QueueType q) override
Remove Track from one of the internal Queues.
Definition: RAMDataStore.cpp:146
Class Queue definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
TResult< std::optional< QueuedTrack > > getPlayingTrack() override
Get the currently playing track.
Definition: RAMDataStore.cpp:276
TResultOpt voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) override
Upvote/remove Upvote from a track.
Definition: RAMDataStore.cpp:197
TResult< Queue > getQueue(QueueType q) override
Get entire Queue.
Definition: RAMDataStore.cpp:262
TResultOpt nextTrack() override
Play next Track in Queue.
Definition: RAMDataStore.cpp:298
Definitions of all track related structs.
Implements a DataStore which stores its data purly in RAM (no persistance).
Definition: RAMDataStore.h:29
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+RequestInformation.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Wraps all needed pieces of information to form a proper HTTP response.
Definition: RequestInformation.h:29
Wraps all relevant pieces of information provided by a HTTP request.
Definition: RequestInformation.h:19
+Generated by +
+ 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 @@
-
@@ -74,8 +74,8 @@
More...
-
-
+
+
VirtualJukebox: src/RestAPI.h File Reference
+VirtualJukebox: src/Network/RestAPI.h File Reference
@@ -61,7 +61,7 @@
#include "RestAPI.h"#include <sstream>-
#include "ConfigHandler.h"-
#include "RestEndpointHandler.h"+
#include "RestRequestHandler.h"+
#include "Utils/ConfigHandler.h"Detailed Description
Implementation of class RestAPI.
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 @@ -
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 @@
-
+
-
+
+
+
+
+
Definition of class NetworkAPI.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Handler functions for all available REST endpoints. +More...
+#include "RestEndpointHandlers.h"+
#include <iostream>+
#include "Utils/Serializer.h"+
#include "json/json.hpp"+
+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.
+ +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( \
+
+ } \
+ 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( \
+
+ } \
+ 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( \
+
+ } \
+ name = args.at(#name); \
+ } while (0)
++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Handler functions for all available REST endpoints. +More...
+ +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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+RestEndpointHandlers.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Definition of class RequestInformation.
Wraps all needed pieces of information to form a proper HTTP response.
Definition: RequestInformation.h:29
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
Interface Class NetworkListener definition.
Wraps all relevant pieces of information provided by a HTTP request.
Definition: RequestInformation.h:19
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+RestRequestHandler.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Definition of class RequestInformation.
Provides a REST request handler for incoming connections.
Definition: RestRequestHandler.h:25
Provides interface methods for all supported requests.
Definition: NetworkListener.h:25
Interface Class NetworkListener definition.
Wraps all relevant pieces of information provided by a HTTP request.
Definition: RequestInformation.h:19
+Generated by +
+ 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 @@
-
@@ -77,7 +77,8 @@
+
+
@@ -109,7 +110,24 @@ InvalidFormat,
InvalidValue, -KeyNotFound +KeyNotFound, +NotImplemented, +NotInitialized, +
+ SpotifyNotFound, +SpotifyAccessDenied, +SpotifyAccessExpired, +SpotifyForbidden, +
+ SpotifyParseError, +SpotifyAPIError, +SpotifyBadRequest, +SpotifyHttpTimeout, +
+ SpotifyNoDevice, +AlreadyExists, +DoesntExist, +WrongPassword
}
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
}
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 | ) |
-
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 @@
-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
@@ -75,52 +75,84 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
bool checkOptionalError(TResultOpt ret)
Checks if given parameter contains optional error value. If so, it prints the containing error messag...
Definition: Result.cpp:11
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
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
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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Serializer.cpp File Reference
+
+
+
+
+
+Implementation of class Serializer. +More...
++Typedefs | |
| +using | json = nlohmann::json |
Detailed Description
+Implementation of class Serializer.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+Serializer.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Template class which can be used as a central class for serialization routines for different data typ...
Definition: Serializer.h:17
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+SimpleScheduler.cpp File Reference
+
+
+
+Class SimpleScheduler implementation. +More...
+Detailed Description
+Class SimpleScheduler implementation.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+SimpleScheduler.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class DataStore definition.
Interface for MusicBackend.
Defines function return values and types.
TResult< std::optional< PlaybackTrack > > const & getLastPlayback()
returns the last polled playback status
Definition: SimpleScheduler.cpp:53
A simple track scheduler (for presentation purposes).
Definition: SimpleScheduler.h:24
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
bool checkForInconsistency()
returns true if actual track from datastore and playback needs to be checked if they are equal
Definition: SimpleScheduler.cpp:73
TResultOpt nextTrack()
plays the next song from the queue
Definition: SimpleScheduler.cpp:58
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyAPITypes.cpp File Reference
+
+
+
+Contains Structures for the Spotify Api implementation. +More...
+Detailed Description
+Contains Structures for the Spotify Api implementation.
+ +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 +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ +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 +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyAPITypes.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Type gets used, when no content data or Error is received.
Definition: SpotifyAPITypes.h:273
GrantType
Possible Autorization Flows (until now only AuthorizationCode gets implemented)
Definition: SpotifyAPITypes.h:26
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyAPI.cpp File Reference
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+Classes |
+Enumerations
+
+
+SpotifyAPI.h File Reference
+
+
+
+
+
+
+Class SpotifyAPI definition. +More...
+ +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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyAPI.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TResultOpt setVolume(std::string const &accessToken, int volume, Device const &device=Device())
sets a volume
Definition: SpotifyAPI.cpp:200
static std::string stringUrlEncode(std::string const &str)
encodes the given string with http special characters
Definition: SpotifyAPI.cpp:484
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
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
Defines function return values and types.
GrantType
Possible Autorization Flows (until now only AuthorizationCode gets implemented)
Definition: SpotifyAPITypes.h:26
TResult< std::vector< Device > > getAvailableDevices(std::string const &accessToken)
returns vector of available spotify devices
Definition: SpotifyAPI.cpp:126
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
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
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
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
TResultOpt pause(std::string const &accessToken, Device const &device=Device())
pauses the acutal track
Definition: SpotifyAPI.cpp:237
Contains Structures for the Spotify Api.
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
static std::string stringBase64Encode(std::string const &str)
encodes the given string with base64
Definition: SpotifyAPI.cpp:512
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 +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyAuthorization.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
handles the 3 parties user authentication
Definition: SpotifyAuthorization.h:23
TResultOpt refreshAccessToken()
refreshes the access token (!! not implemented yet!!)
Definition: SpotifyAuthorization.cpp:58
Defines function return values and types.
Class SpotifyAPI definition.
void setScopes(std::string const &scopes)
sets the scopes to ask on the permission
Definition: SpotifyAuthorization.cpp:101
TResultOpt startServer()
starts the server, on which the user can connect
Definition: SpotifyAuthorization.cpp:24
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
const std::string & getAccessToken()
returns access token
Definition: SpotifyAuthorization.cpp:55
Contains Structures for the Spotify Api.
void stopServer()
stops the server
Definition: SpotifyAuthorization.cpp:46
const std::string & getRefreshToken()
returns refresh token
Definition: SpotifyAuthorization.cpp:52
__int64_t getExpiresAt()
returns when the token expires
Definition: SpotifyAuthorization.cpp:96
std::string getScopes()
return scopes
Definition: SpotifyAuthorization.cpp:105
+Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ +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 +
+ 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 @@
-
@@ -74,18 +74,20 @@
+
-
-
-
-
+
+
+
+
+
VirtualJukebox: src/SpotifyBackend.h Source File
+VirtualJukebox: src/Spotify/SpotifyBackend.h Source File
@@ -61,7 +61,7 @@
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 @@ -
@@ -75,38 +75,71 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defines types and constants that are used globally.
Definition: Track.h:12
Definition: MusicBackend.h:21
Interface for MusicBackends.
handles the 3 parties user authentication
Definition: SpotifyAuthorization.h:23
Class SpotifyAuthorization definition.
virtual TResultOpt setVolume(size_t const percent) override
Sets a new volume.
Definition: SpotifyBackend.cpp:280
virtual TResult< std::optional< PlaybackTrack > > getCurrentPlayback() override
Returns the current playback of the active device as a playback track.
Definition: SpotifyBackend.cpp:166
Interface for MusicBackend.
Defines function return values and types.
Definition: SpotifyBackend.h:19
Class SpotifyAPI definition.
spotify music backend class which handles api calls and starts the authentication process
Definition: SpotifyBackend.h:26
virtual TResultOpt pause() override
Pauses the current playback.
Definition: SpotifyBackend.cpp:211
virtual TResultOpt initBackend() override
Initalizes the backend.
Definition: SpotifyBackend.cpp:56
Class Queue definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:69
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:59
Class Track definition.
std::optional< Error > TResultOpt
Used as an optional return type of functions.
Definition: Result.h:85
std::variant< GOOD_TYPE, Error > TResult
Used as return type of functions.
Definition: Result.h:75
virtual TResultOpt setPlayback(BaseTrack const &track) override
Set the given track as playback (means the track gets played).
Definition: SpotifyBackend.cpp:105
virtual TResult< BaseTrack > createBaseTrack(TTrackID const &trackID) override
Creates a new BaseTrack instance with the given trackID.
Definition: SpotifyBackend.cpp:318
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
virtual TResult< size_t > getVolume() override
Returns the volume of the actual device in percent.
Definition: SpotifyBackend.cpp:259
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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ ++Generated by +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+Tracks.h
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defines types and constants that are used globally.
+Generated by +
+ 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:
-
-
+
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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 1.8.16
+
+
+
diff --git a/docs/html/classBaseTrack.png b/docs/html/classBaseTrack.png
new file mode 100644
index 0000000..da15ef7
Binary files /dev/null and b/docs/html/classBaseTrack.png differ
diff --git a/docs/html/classConfigHandler-members.html b/docs/html/classConfigHandler-members.html
index 2f22cbf..35aae72 100644
--- a/docs/html/classConfigHandler-members.html
+++ b/docs/html/classConfigHandler-members.html
@@ -71,8 +71,9 @@
getInstance() (defined in ConfigHandler) ConfigHandler static getValueInt(std::string const §ion, std::string const &key) ConfigHandler getValueString(std::string const §ion, 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
| CConfigHandler | ||
| CError | A customized error type | |
| CJukeBox | ||
| CLoggingHandler | ||
| CMusicBackend | ||
| CNetworkAPI | Base class for all implementations of network interfaces | |
| CNetworkListener | Provides interface methods for all supported requests | |
| CPlaybackTrack | ||
| CQueue | ||
| CRestAPI | Implementation of the REST API | |
| CRestEndpointHandler | Provides REST endpoints for incoming connections | |
| CSpotifyBackend | ||
| CTrack | ||
| ▼NSpotifyApi | |
| CAlbum | Simplified Spotify Album class |
| CArtist | Simplified artist object |
| CDevice | Device Object |
| CDevices | Wrapper class for multiple devices |
| CImage | Spotify Image Class |
| CPlayback | Contains infos about the actual playback |
| CSpotifyAPI | Handles the calls with the spotify web api |
| CSpotifyAuthorization | Handles the 3 parties user authentication |
| CSpotifyDummy | Type gets used, when no content data or Error is received |
| CSpotifyError | Error type |
| CSpotifyPaging | Represents one page of search results |
| CToken | Return type on valid token request |
| CTrack | Simplified track object |
| CBaseTrack | The most basic representation of a track |
| CConfigHandler | Singleton class which provides shared access to the configuration file used |
| CDataStore | Interface for storing Data such as Tracks, Users, Votes, etc |
| CError | A customized error type |
| CJukeBox | Core class which combines all interface implementations in a working server application |
| CMusicBackend | Provides an abstracted interface to a MusicBackend s |
| CNetworkAPI | Base class for all implementations of network interfaces |
| CNetworkListener | Provides interface methods for all supported requests |
| CPlaybackTrack | Specialized track representing the currently playing track |
| CQueue | Respresents a queue which is returned to the clients |
| CQueuedTrack | Specialized track which is found inside queues |
| CQueueStatus | Wraps all information to return if a client requests the current queue status |
| CRAMDataStore | Implements a DataStore which stores its data purly in RAM (no persistance) |
| CRequestInformation | Wraps all relevant pieces of information provided by a HTTP request |
| CResponseInformation | Wraps all needed pieces of information to form a proper HTTP response |
| CRestAPI | Implementation of the REST API |
| CRestRequestHandler | Provides a REST request handler for incoming connections |
| CSerializer | Template class which can be used as a central class for serialization routines for different data types |
| CSimpleScheduler | A simple track scheduler (for presentation purposes) |
| CSpotifyBackend | Spotify music backend class which handles api calls and starts the authentication process |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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) | BaseTrack | inline |
| title (defined in BaseTrack) | BaseTrack | |
| trackId (defined in BaseTrack) | BaseTrack |
+Generated by +
+ 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
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+The most basic representation of a track. + More...
+ +#include <Tracks.h>
+Inheritance diagram for BaseTrack:
+
+
+
+ 
+
+
+
++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:
-
+
- src/Types/Tracks.h +
+Generated by +
+ 1.8.16
+
+
+
diff --git a/docs/html/classBaseTrack.png b/docs/html/classBaseTrack.png
new file mode 100644
index 0000000..da15ef7
Binary files /dev/null and b/docs/html/classBaseTrack.png differ
diff --git a/docs/html/classConfigHandler-members.html b/docs/html/classConfigHandler-members.html
index 2f22cbf..35aae72 100644
--- a/docs/html/classConfigHandler-members.html
+++ b/docs/html/classConfigHandler-members.html
@@ -71,8 +71,9 @@
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
+
+
-ConfigHandler.h
-
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 @@
+
+
+
+
+
+
+
+Singleton class which provides shared access to the configuration file used. + More...
+ +#include <ConfigHandler.h>
Public Member Functions | |
| TResult< int > | getValueInt (std::string const §ion, std::string const &key) |
| Returns value of a key as integer. More... | |
| +bool | isInitialized () |
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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+DataStore Member List
+
+
+
+
+This is the complete list of members for DataStore, including all inherited members.
+| addTrack(BaseTrack const &track, QueueType q)=0 | DataStore | pure virtual |
| addUser(User const &user)=0 | DataStore | pure virtual |
| cSessionTimeoutAfterSeconds (defined in DataStore) | DataStore | static |
| getPlayingTrack()=0 | DataStore | pure virtual |
| getQueue(QueueType q)=0 | DataStore | pure virtual |
| getUser(TSessionID const &sID)=0 | DataStore | pure virtual |
| hasTrack(TTrackID const &tID, QueueType q)=0 | DataStore | pure virtual |
| hasUser(TSessionID const &sID)=0 | DataStore | pure virtual |
| isSessionExpired(TSessionID const &sID)=0 | DataStore | pure virtual |
| nextTrack()=0 | DataStore | pure virtual |
| removeTrack(TTrackID const &tID, QueueType q)=0 | DataStore | pure virtual |
| removeUser(TSessionID const &sID)=0 | DataStore | pure virtual |
| voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote)=0 | DataStore | pure virtual |
| ~DataStore() (defined in DataStore) | DataStore | inlinevirtual |
+Generated by +
+ 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 Referenceabstract
+
+
+
+
+
The documentation for this class was generated from the following file:
+
+Interface for storing Data such as Tracks, Users, Votes, etc. + More...
+ +#include <DataStore.h>
+Inheritance diagram for DataStore:
+
+
+
+ 
+
+
+
++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()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Add Track to one of the internal Queues.
+- Parameters
-
+
+
+track The Track to add q Identifier for determining which Queue the Track should be added to
+
- Returns
- An Error message or nothing at all (at success).
Implemented in RAMDataStore.
+ +◆ addUser()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Add a User to the internal List of registered Users.
+- Parameters
-
+
+
+user The User class to add
+
- Returns
- An Error message or nothing at all (at success).
Implemented in RAMDataStore.
+ +◆ getPlayingTrack()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Get the currently playing track.
+- Returns
- Returns the currently playing track (if any) or an Error message.
Implemented in RAMDataStore.
+ +◆ getQueue()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Get entire Queue.
+- Parameters
-
+
+
+q Identifier for determining which Queue should be returned
+
Implemented in RAMDataStore.
+ +◆ getUser()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Get a User from the internal List of registered Users.
+- Parameters
-
+
+
+sID The ID of the User we want to get
+
- Returns
- Either the requested user or an Error message.
Implemented in RAMDataStore.
+ +◆ hasTrack()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Check for Track in one of the internal Queues.
+- Parameters
-
+
+
+tID The ID of the Track to check for q Identifier for determining which Queue should be checked for the Track
+
- Returns
- Either a boolean answer or an Error message.
Implemented in RAMDataStore.
+ +◆ hasUser()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Query the internal user list whether a certain user exists.
+- Parameters
-
+
+
+sID The ID of the user to check for
+
- Returns
trueif an user with this ID exists,falseotherwise
Implemented in RAMDataStore.
+ +◆ isSessionExpired()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Check if user session is expired.
+- Parameters
-
+
+
+sID Session ID of the user to check
+
- Return values
-
+
+
+Returns false if session is not expired yet. Returns an Error object on session expiration or error.
+
Implemented in RAMDataStore.
+ +◆ nextTrack()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Play next Track in Queue.
+- Returns
- An Error message or nothing at all (at success).
Implemented in RAMDataStore.
+ +◆ removeTrack()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Remove Track from one of the internal Queues.
+- Parameters
-
+
+
+tID The ID of the Track to remove q Identifier for determining which Queue the Track should be removed from
+
- Returns
- Either the removed track or an Error message.
Implemented in RAMDataStore.
+ +◆ removeUser()
+ +
+
+
+
+
+
+
+
|
+ +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
-
+
+
+sID ID number of the User to remove
+
- Returns
- Either the user that was removed or an Error message.
Implemented in RAMDataStore.
+ +◆ voteTrack()
+ +
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Upvote/remove Upvote from a track.
+- Parameters
-
+
+
+sID The ID of the User who wants to vote tID The ID of the Track to vote for vote The 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:
-
+
- src/DataStore.h +
+Generated by +
+ 1.8.16
+
+
+
diff --git a/docs/html/classDataStore.png b/docs/html/classDataStore.png
new file mode 100644
index 0000000..e4d0dbb
Binary files /dev/null and b/docs/html/classDataStore.png differ
diff --git a/docs/html/classError-members.html b/docs/html/classError-members.html
index 6b56d11..cc49a94 100644
--- a/docs/html/classError-members.html
+++ b/docs/html/classError-members.html
@@ -69,8 +69,8 @@
This is the complete list of members for Error, including all inherited members.
| Error(ErrorCode code, std::string msg) (defined in Error) | Error | inline |
| getErrorCode() (defined in Error) | Error | inline |
| getErrorMessage() (defined in Error) | Error | inline |
| getErrorCode() const (defined in Error) | Error | inline |
| getErrorMessage() const (defined in Error) | Error | inline |
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 @@
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) override | JukeBox | virtual |
| controlPlayer(TSessionID const &sid, PlayerAction action) override | JukeBox | virtual |
| generateSession(TPassword const &pw) override | JukeBox | virtual |
| moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type) override | JukeBox | virtual |
| queryTracks(std::string const &searchPattern, size_t const nrOfEntries) override | JukeBox | virtual |
| generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname) override | JukeBox | virtual |
| getCurrentQueues(TSessionID const &sid) | JukeBox | virtual |
| JukeBox() (defined in JukeBox) | JukeBox | |
| moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue) override | JukeBox | virtual |
| queryTracks(std::string const &searchPattern, size_t const nrOfEntries) override | JukeBox | virtual |
| removeTrack(TSessionID const &sid, TTrackID const &trkid) override | JukeBox | virtual |
| 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) override | JukeBox | virtual |
| ~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 @@
-
-
+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.
+
+
Error otherwise.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.| ( | -TPassword const & | -pw | ) | +std::optional< TPassword > const & | +pw, | + +
| + | std::optional< std::string > const & | +nickname | +|
| + | ) | +
+Implementations of the network endpoints defined in NetworkListener
+
+Implements NetworkListener.
+
+
◆ getCurrentQueues()
+ +
+
-
-
+
+
+
+
|
+ +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
-
-
pw The password used to authenticate as admin user. sid The 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
Errorotherwise.
- Returns
- On success the current queues and the current track are returned, an
Errorotherwise.
Implements NetworkListener.
+Implements NetworkListener.
◆ moveTrack()
+ +◆ moveTrack()
@@ -278,7 +327,7 @@
QueueType
- type
+ toQueue
sid The session ID of the user. Used to authenticate as admin. trkid The track to be moved. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be moved. toQueue Determines 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 @@
This is the complete list of members for MusicBackend, including all inherited members.
- getCurrentPlayback(void)=0 (defined in MusicBackend) MusicBackend pure virtual getVolume(void)=0 (defined in MusicBackend) MusicBackend pure virtual initBackend(void)=0 (defined in MusicBackend) MusicBackend pure virtual pause(void)=0 (defined in MusicBackend) MusicBackend pure virtual play()=0 (defined in MusicBackend) MusicBackend pure virtual queryTracks(std::string const &pattern, size_t const num)=0 (defined in MusicBackend) MusicBackend pure virtual setPlayback(Track const &track)=0 (defined in MusicBackend) MusicBackend pure virtual setVolume(size_t const percent)=0 (defined in MusicBackend) MusicBackend pure virtual createBaseTrack(TTrackID const &trackID)=0 MusicBackend pure virtual getCurrentPlayback()=0 MusicBackend pure virtual getVolume()=0 MusicBackend pure virtual initBackend()=0 MusicBackend pure virtual pause()=0 MusicBackend pure virtual play()=0 MusicBackend pure virtual queryTracks(std::string const &pattern, size_t const num)=0 MusicBackend pure virtual setPlayback(BaseTrack const &track)=0 MusicBackend pure virtual setVolume(size_t const percent)=0 MusicBackend pure virtual ~MusicBackend() (defined in MusicBackend) MusicBackend inlinevirtual
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:
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
-
+
+ trackID Unique track ID (returned for example by queryTracks).
+
+
+
+
+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
-
+
+ pattern Search patten (wildcard support depends on the backend). num Maximum number of returned tracks (maximum is 50).
+
+
+
+
+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
-
+
+ track track 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
-
+
+ percent Volume in percent.
+
+
+- Returns
- Returns an Error on failure.
+
+Implemented in SpotifyBackend.
+
+
+
The documentation for this class was generated from the following file:
- src/MusicBackend.h
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) NetworkAPI protected NetworkAPI() (defined in NetworkAPI) NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI) NetworkAPI ~NetworkAPI() (defined in NetworkAPI) NetworkAPI inlinevirtual
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)=0 NetworkListener pure virtual controlPlayer(TSessionID const &sid, PlayerAction action)=0 NetworkListener pure virtual generateSession(TPassword const &pw)=0 NetworkListener pure virtual moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0 NetworkListener pure virtual queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0 NetworkListener pure virtual removeTrack(TSessionID const &sid, TTrackID const &trkid)=0 NetworkListener pure virtual voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0 NetworkListener pure virtual generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname)=0 NetworkListener pure virtual getCurrentQueues(TSessionID const &sid)=0 NetworkListener pure virtual moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue)=0 NetworkListener pure virtual queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0 NetworkListener pure virtual removeTrack(TSessionID const &sid, TTrackID const &trkid)=0 NetworkListener pure virtual voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0 NetworkListener pure 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 @@
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
-
- pw The 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
-
+
+ sid The 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
sid The session ID of the user. Used to authenticate as admin. trkid The track to be moved. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be moved. toQueue Determines 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 @@
- virtual TResult<std::vector<Track> > NetworkListener::queryTracks
+ virtual TResult<std::vector<BaseTrack> > NetworkListener::queryTracks
(
std::string const &
searchPattern,
@@ -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 @@
sid The session ID of the user. Used to authenticate as admin if needed. trkid The ID of the track to add to a queue. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be added. vote Determines 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) override RAMDataStore virtual addUser(User const &user) override RAMDataStore virtual cSessionTimeoutAfterSeconds (defined in DataStore) DataStore static getPlayingTrack() override RAMDataStore virtual getQueue(QueueType q) override RAMDataStore virtual getUser(TSessionID const &ID) override RAMDataStore virtual hasTrack(TTrackID const &ID, QueueType q) override RAMDataStore virtual hasUser(TSessionID const &ID) override RAMDataStore virtual isSessionExpired(TSessionID const &ID) override RAMDataStore virtual nextTrack() override RAMDataStore virtual removeTrack(TTrackID const &ID, QueueType q) override RAMDataStore virtual removeUser(TSessionID const &ID) override RAMDataStore virtual voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) override RAMDataStore virtual ~DataStore() (defined in DataStore) DataStore inlinevirtual
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+RAMDataStore Class Reference
+
+
+
+Implements a DataStore which stores its data purly in RAM (no persistance).
+ More...
+
+#include <RAMDataStore.h>
+
+Inheritance diagram for RAMDataStore:
+
+
+ 
+
+
+
+
+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
+
+
+
+
+
+◆ addUser()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::addUser
+ (
+ User const &
+ user )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ getPlayingTrack()
+
+
+
+
+
+
+
+
+ TResult< optional< QueuedTrack > > RAMDataStore::getPlayingTrack
+ (
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ getQueue()
+
+
+
+
+
+◆ getUser()
+
+
+
+
+
+
+
+
+ TResult< User > RAMDataStore::getUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ hasTrack()
+
+
+
+
+
+◆ hasUser()
+
+
+
+
+
+
+
+
+ bool RAMDataStore::hasUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+Query the internal user list whether a certain user exists.
+- Parameters
-
+
+ sID The 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
+
+
+
+
+
+◆ nextTrack()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::nextTrack
+ (
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ removeTrack()
+
+
+
+
+
+◆ removeUser()
+
+
+
+
+
+
+
+
+ TResult< User > RAMDataStore::removeUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ voteTrack()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::voteTrack
+ (
+ TSessionID const &
+ sID,
+
+
+ TTrackID const &
+ tID,
+
+
+ TVote
+ vote
+
+
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+Upvote/remove Upvote from a track.
+- Parameters
-
+
+ sID The ID of the User who wants to vote tID The ID of the Track to vote for vote The 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:
+- src/Datastore/RAMDataStore.h
+- src/Datastore/RAMDataStore.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classRAMDataStore.png b/docs/html/classRAMDataStore.png
new file mode 100644
index 0000000..48283f4
Binary files /dev/null and b/docs/html/classRAMDataStore.png differ
diff --git a/docs/html/classRestAPI-members.html b/docs/html/classRestAPI-members.html
index ca40c72..b9f84df 100644
--- a/docs/html/classRestAPI-members.html
+++ b/docs/html/classRestAPI-members.html
@@ -72,6 +72,8 @@
listener (defined in NetworkAPI) NetworkAPI protected NetworkAPI() (defined in NetworkAPI) NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI) NetworkAPI stopServer() (defined in RestAPI) RestAPI ~NetworkAPI() (defined in NetworkAPI) NetworkAPI inlinevirtual
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 *) Implementation of the REST API.
- See also
- NetworkAPI, NetworkListener
The documentation for this class was generated from the following files:
-- src/RestAPI.h
-- src/RestAPI.cpp
+- src/Network/RestAPI.h
+- src/Network/RestAPI.cpp
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) RestRequestHandler static NotAllowedHandler(httpserver::http_request const &req) (defined in RestRequestHandler) RestRequestHandler static NotFoundHandler(httpserver::http_request const &req) (defined in RestRequestHandler) RestRequestHandler static RestRequestHandler(NetworkListener *listener) (defined in RestRequestHandler) RestRequestHandler
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Network/RestRequestHandler.h
+- src/Network/RestRequestHandler.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classRestRequestHandler.png b/docs/html/classRestRequestHandler.png
new file mode 100644
index 0000000..cd147f1
Binary files /dev/null and b/docs/html/classRestRequestHandler.png differ
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) Serializer static serialize(BaseTrack const &track) (defined in Serializer) Serializer static serialize(QueuedTrack const &track) (defined in Serializer) Serializer static serialize(PlaybackTrack const &track) (defined in Serializer) Serializer static
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Utils/Serializer.h
+- src/Utils/Serializer.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Utils/SimpleScheduler.h
+- src/Utils/SimpleScheduler.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyApi::Device Class Reference
+
+
+
+
+
+#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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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::Devices inline mDevices (defined in SpotifyApi::Devices) SpotifyApi::Devices
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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::SpotifyAPI static stringUrlEncode(std::string const &str) SpotifyApi::SpotifyAPI static transferUsersPlayback(std::string const &accessToken, std::vector< Device > const &devices, bool play=false) SpotifyApi::SpotifyAPI
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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
-
+
+ grantType which authorization type to use code authentification code (received from Spotify Authorization) redirectUri redirection url (only for comparing) clientID clientID (from spotify developers dashboard) clientSecret clientSecret (from spotify developers dashboard)
+
+
+this function fetches a token from the spotify web api. until now, only the GrantType AuthorizationCode is implemented.
+
+
+
+
+◆ getAvailableDevices()
+
+
+
+
+
+◆ 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
-
+
+ accessToken valid access token market specifies, 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..
+
+
+
+
+◆ 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
-
+
+ accessToken valid access token spotifyID spotify id of the song (without "spotify:track:" string) market only return tracks, which are valid in the given market
+
+
+
+
+
+
+
+◆ pause()
+
+
+
+
+
+ TResultOpt SpotifyAPI::pause
+ (
+ std::string const &
+ accessToken,
+
+
+ Device const &
+ device = Device()
+
+
+ )
+
+
+
+
+pauses the acutal track
+- Parameters
-
+
+ accessToken valid access token device select 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
-
+
+ accessToken valid access token uris a vector of spotify uris (ids) which will be queued and played device select on which device to play (if not given, the current active device will be used) positionMs set 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
-
+
+ refreshToken the refresh token gathered from getAccessToken(..) clientID clientID (from spotify developers dashboard) clientSecret clientSecret (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!!
+
+
+
+
+◆ 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
-
+
+ accessToken valid access token queryKey the search string type specifies if it gets searched for tracks, artists, albums, or playlists limit sets the limit of maximum number returned tracks,.. offset number offset market only 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
-
+
+ accessToken valid access token volume volume in percent (0-100) device select 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
-
+
+ str string to encode
+
+
+- Returns
- encoded string
+
+
+
+
+◆ stringUrlEncode()
+
+
+
+
+
+
+
+
+ std::string SpotifyAPI::stringUrlEncode
+ (
+ std::string const &
+ str )
+
+
+
+
+static
+
+
+
+
+encodes the given string with http special characters
+- Parameters
-
+
+ str string 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
-
+
+ accessToken valid access token devices its possible to set an array, but until now only a single device is currently supported play true 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:
+- src/Spotify/SpotifyAPI.h
+- src/Spotify/SpotifyAPI.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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
-
+
+ scopes scopes
+
+
+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:
+- src/Spotify/SpotifyAuthorization.h
+- src/Spotify/SpotifyAuthorization.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png
new file mode 100644
index 0000000..85bce22
Binary files /dev/null and b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png differ
diff --git a/docs/html/classSpotifyApi_1_1SpotifyDummy-members.html b/docs/html/classSpotifyApi_1_1SpotifyDummy-members.html
new file mode 100644
index 0000000..7c46842
--- /dev/null
+++ b/docs/html/classSpotifyApi_1_1SpotifyDummy-members.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+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::SpotifyDummy inline
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyApi::SpotifyError Class Reference
+
+
+
+
+
+#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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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) SpotifyBackend virtual getVolume(void) override (defined in SpotifyBackend) SpotifyBackend virtual initBackend(void) override (defined in SpotifyBackend) SpotifyBackend virtual pause(void) override (defined in SpotifyBackend) SpotifyBackend virtual play() override (defined in SpotifyBackend) SpotifyBackend virtual queryTracks(std::string const &pattern, size_t const num) override (defined in SpotifyBackend) SpotifyBackend virtual setPlayback(Track const &track) override (defined in SpotifyBackend) SpotifyBackend virtual setVolume(size_t const percent) override (defined in SpotifyBackend) SpotifyBackend virtual createBaseTrack(TTrackID const &trackID) override SpotifyBackend virtual getCurrentPlayback() override SpotifyBackend virtual getVolume() override SpotifyBackend virtual initBackend() override SpotifyBackend virtual pause() override SpotifyBackend virtual play() override SpotifyBackend virtual queryTracks(std::string const &pattern, size_t const num) override SpotifyBackend virtual setPlayback(BaseTrack const &track) override SpotifyBackend virtual setVolume(size_t const percent) override SpotifyBackend virtual ~MusicBackend() (defined in MusicBackend) MusicBackend inlinevirtual
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:
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
-
+
+ trackID Unique track ID (returned for example by queryTracks).
+
+
+
+
+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
-
+
+ pattern Search patten (wildcard support depends on the backend). num Maximum number of returned tracks (maximum is 50).
+
+
+
+
+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
-
+
+ track track 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
-
+
+ percent Volume in percent.
+
+
+- Returns
- Returns an Error on failure.
+
+Implements MusicBackend.
+
+
+
The documentation for this class was generated from the following files:
-- src/SpotifyBackend.h
-- src/SpotifyBackend.cpp
+- src/Spotify/SpotifyBackend.h
+- src/Spotify/SpotifyBackend.cpp
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
+ 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
-
+
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
+
+ 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
+
+ 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
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
+
+ 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
+
+ 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
+
+ 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.cpp Class ConfigHandler implementation ConfigHandler.h Class ConfigHandler definition GlobalTypes.h Defines types and constants that are used globally JukeBox.cpp Class JukeBox implementation JukeBox.h Class JukeBox definition LoggingHandler.cpp Class LoggingHandler implementation LoggingHandler.h Class LoggingHandler definition main.cpp Main program for project "Virtual JukeBox" MusicBackend.h Interface for MusicBackends NetworkAPI.cpp Implementation of class NetworkAPI NetworkAPI.h Definition of class NetworkAPI NetworkListener.h Interface Class NetworkListener definition PlaybackTrack.h Queue.cpp Class Queue implementation Queue.h Class Queue definition RestAPI.cpp Implementation of class RestAPI RestAPI.h Definition of class RestAPI RestEndpointHandler.cpp Implementation of class RestEndpointHandler RestEndpointHandler.h Definition of class RestEndpointHandler Result.cpp Implements functions Result.h Defines function return values and types SpotifyBackend.h Class handles Music Playback with a Spotify Backend Track.cpp Class Track implementation Track.h Class Track definition ▼ Datastore RAMDataStore.h Class RAMDataStore implementation ▼ Network RequestInformation.h Definition of class RequestInformation RestAPI.cpp Implementation of class RestAPI RestAPI.h Definition of class RestAPI RestEndpointHandlers.cpp Handler functions for all available REST endpoints RestEndpointHandlers.h Handler functions for all available REST endpoints RestRequestHandler.cpp Implementation of class RestRequestHandler RestRequestHandler.h Definition of class RestRequestHandler ▼ Spotify SpotifyAPI.cpp Class SpotifyAPI definition SpotifyAPI.h Class SpotifyAPI definition SpotifyAPITypes.cpp Contains Structures for the Spotify Api implementation SpotifyAPITypes.h Contains Structures for the Spotify Api SpotifyAuthorization.cpp Class SpotifyAuthorization implementation SpotifyAuthorization.h Class SpotifyAuthorization definition SpotifyBackend.cpp Class handles Music Playback with a Spotify Backend SpotifyBackend.h Class handles Music Playback with a Spotify Backend ▼ Types GlobalTypes.h Defines types and constants that are used globally Queue.h Class Queue definition Result.h Defines function return values and types Tracks.h Definitions of all track related structs ▼ Utils ConfigHandler.cpp Class ConfigHandler implementation ConfigHandler.h Class ConfigHandler definition LoggingHandler.cpp LoggingHandler implementation LoggingHandler.h LoggingHandler header file Serializer.cpp Implementation of class Serializer Serializer.h Definition of class Serializer SimpleScheduler.cpp Class SimpleScheduler implementation SimpleScheduler.h Class SimpleScheduler definition DataStore.h Class DataStore definition JukeBox.cpp Class JukeBox implementation JukeBox.h Class JukeBox definition main.cpp Main program for project "VirtualJukeBox" MusicBackend.h Interface for MusicBackend NetworkAPI.cpp Implementation of class NetworkAPI NetworkAPI.h Definition of class NetworkAPI NetworkListener.h Interface 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:
+Here is a list of all documented class members with links to the class documentation for each member:
+
+- a -
+- addTrack()
+: DataStore
+, RAMDataStore
+
- addTrackToQueue()
: JukeBox
, NetworkListener
+- addUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- c -
+- checkForInconsistency()
+: SimpleScheduler
+
- controlPlayer()
: JukeBox
, NetworkListener
+- createBaseTrack()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- g -
- generateSession()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+- getAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
+
+- getAvailableDevices()
+: SpotifyApi::SpotifyAPI
+
+- getCurrentPlayback()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- getCurrentQueues()
+: JukeBox
+, NetworkListener
+
+- getExpiresAt()
+: SpotifyApi::SpotifyAuthorization
+
+- getLastPlayback()
+: SimpleScheduler
+
+- getPlayingTrack()
+: DataStore
+, RAMDataStore
+
+- getQueue()
+: DataStore
+, RAMDataStore
+
+- getRefreshToken()
+: SpotifyApi::SpotifyAuthorization
+
+- getScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- getTrack()
+: SpotifyApi::SpotifyAPI
+
+- getUser()
+: DataStore
+, RAMDataStore
- getValueInt()
: ConfigHandler
@@ -80,24 +148,147 @@
- getValueString()
: ConfigHandler
+- getVolume()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- h -
+- hasTrack()
+: DataStore
+, RAMDataStore
+
+- hasUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- i -
+- initBackend()
+: MusicBackend
+, SpotifyBackend
+
+- isSessionExpired()
+: DataStore
+, RAMDataStore
+
+
+
+
+- m -
- moveTrack()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+
+
+- n -
+- nextTrack()
+: DataStore
+, RAMDataStore
+, SimpleScheduler
+
+
+
+
+- p -
+- pause()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- play()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+
+
+
+- q -
- queryTracks()
-: JukeBox
-, NetworkListener
+: JukeBox
+, MusicBackend
+, NetworkListener
+, SpotifyBackend
+
+
+
+
+- r -
+- refreshAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
- removeTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
+
+- removeUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- s -
+- search()
+: SpotifyApi::SpotifyAPI
- setConfigFilePath()
: ConfigHandler
+- setPlayback()
+: MusicBackend
+, SpotifyBackend
+
+- setScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- setVolume()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- start()
+: JukeBox
+, SimpleScheduler
+
+- startServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stopServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stringBase64Encode()
+: SpotifyApi::SpotifyAPI
+
+- stringUrlEncode()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- t -
+- transferUsersPlayback()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- v -
- voteTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
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 @@
-
+
+
+- a -
+- addTrack()
+: DataStore
+, RAMDataStore
+
- addTrackToQueue()
: JukeBox
, NetworkListener
+- addUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- c -
+- checkForInconsistency()
+: SimpleScheduler
+
- controlPlayer()
: JukeBox
, NetworkListener
+- createBaseTrack()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- g -
- generateSession()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+- getAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
+
+- getAvailableDevices()
+: SpotifyApi::SpotifyAPI
+
+- getCurrentPlayback()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- getCurrentQueues()
+: JukeBox
+, NetworkListener
+
+- getExpiresAt()
+: SpotifyApi::SpotifyAuthorization
+
+- getLastPlayback()
+: SimpleScheduler
+
+- getPlayingTrack()
+: DataStore
+, RAMDataStore
+
+- getQueue()
+: DataStore
+, RAMDataStore
+
+- getRefreshToken()
+: SpotifyApi::SpotifyAuthorization
+
+- getScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- getTrack()
+: SpotifyApi::SpotifyAPI
+
+- getUser()
+: DataStore
+, RAMDataStore
- getValueInt()
: ConfigHandler
@@ -80,24 +148,147 @@
- getValueString()
: ConfigHandler
+- getVolume()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- h -
+- hasTrack()
+: DataStore
+, RAMDataStore
+
+- hasUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- i -
+- initBackend()
+: MusicBackend
+, SpotifyBackend
+
+- isSessionExpired()
+: DataStore
+, RAMDataStore
+
+
+
+
+- m -
- moveTrack()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+
+
+- n -
+- nextTrack()
+: DataStore
+, RAMDataStore
+, SimpleScheduler
+
+
+
+
+- p -
+- pause()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- play()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+
+
+
+- q -
- queryTracks()
-: JukeBox
-, NetworkListener
+: JukeBox
+, MusicBackend
+, NetworkListener
+, SpotifyBackend
+
+
+
+
+- r -
+- refreshAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
- removeTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
+
+- removeUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- s -
+- search()
+: SpotifyApi::SpotifyAPI
- setConfigFilePath()
: ConfigHandler
+- setPlayback()
+: MusicBackend
+, SpotifyBackend
+
+- setScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- setVolume()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- start()
+: JukeBox
+, SimpleScheduler
+
+- startServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stopServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stringBase64Encode()
+: SpotifyApi::SpotifyAPI
+
+- stringUrlEncode()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- t -
+- transferUsersPlayback()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- v -
- voteTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
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 @@
-- checkOptionalError()
-: Result.cpp
-, Result.h
+
- checkAlternativeError()
+: Result.h
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 @@
-- Queues
-: NetworkListener.h
-
- TPassword
: GlobalTypes.h
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 8878a93..5396185 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -67,20 +67,40 @@
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
- CConfigHandler CError A customized error type ▼Chttp_resource CRestEndpointHandler Provides REST endpoints for incoming connections CLoggingHandler ▼CMusicBackend CSpotifyBackend ▼CNetworkAPI Base class for all implementations of network interfaces CRestAPI Implementation of the REST API ▼CNetworkListener Provides interface methods for all supported requests CJukeBox CPlaybackTrack CQueue CTrack CSpotifyApi::Album Simplified Spotify Album class CSpotifyApi::Artist Simplified artist object ▼CBaseTrack The most basic representation of a track CPlaybackTrack Specialized track representing the currently playing track CQueuedTrack Specialized track which is found inside queues CConfigHandler Singleton class which provides shared access to the configuration file used ▼CDataStore Interface for storing Data such as Tracks, Users, Votes, etc CRAMDataStore Implements a DataStore which stores its data purly in RAM (no persistance) CSpotifyApi::Device Device Object CSpotifyApi::Devices Wrapper class for multiple devices CError A customized error type ▼Chttp_resource CRestRequestHandler Provides a REST request handler for incoming connections CSpotifyApi::SpotifyAuthorization Handles the 3 parties user authentication CSpotifyApi::Image Spotify Image Class ▼CMusicBackend Provides an abstracted interface to a MusicBackend s CSpotifyBackend Spotify music backend class which handles api calls and starts the authentication process ▼CNetworkAPI Base class for all implementations of network interfaces CRestAPI Implementation of the REST API ▼CNetworkListener Provides interface methods for all supported requests CJukeBox Core class which combines all interface implementations in a working server application CSpotifyApi::Playback Contains infos about the actual playback CQueue Respresents a queue which is returned to the clients CQueueStatus Wraps all information to return if a client requests the current queue status CRequestInformation Wraps all relevant pieces of information provided by a HTTP request CResponseInformation Wraps all needed pieces of information to form a proper HTTP response CSerializer Template class which can be used as a central class for serialization routines for different data types CSimpleScheduler A simple track scheduler (for presentation purposes) CSpotifyApi::SpotifyAPI Handles the calls with the spotify web api CSpotifyApi::SpotifyDummy Type gets used, when no content data or Error is received CSpotifyApi::SpotifyError Error type CSpotifyApi::SpotifyPaging Represents one page of search results CSpotifyApi::Token Return type on valid token request CSpotifyApi::Track Simplified track object
diff --git a/docs/html/main_8cpp.html b/docs/html/main_8cpp.html
index b1d6d82..0aa7b2b 100644
--- a/docs/html/main_8cpp.html
+++ b/docs/html/main_8cpp.html
@@ -72,24 +72,26 @@
-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".
-
+Main program for project "VirtualJukeBox".
+
+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.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.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) BaseTrack inline progressMs (defined in PlaybackTrack) PlaybackTrack title (defined in BaseTrack) BaseTrack trackId (defined in BaseTrack) BaseTrack
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+PlaybackTrack Struct Reference
+
+
+
+Specialized track representing the currently playing track.
+ More...
+
+#include <Tracks.h>
+
+Inheritance diagram for PlaybackTrack:
+
+
+ 
+
+
+
+
+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:
+- src/Types/Tracks.h
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/structPlaybackTrack.png b/docs/html/structPlaybackTrack.png
new file mode 100644
index 0000000..cfcbea1
Binary files /dev/null and b/docs/html/structPlaybackTrack.png differ
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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Types/Queue.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Types/Queue.h
+
+
+
+
+Generated by
+
+ 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) QueuedTrack inline operator==(const BaseTrack &tr) (defined in BaseTrack) BaseTrack inline title (defined in BaseTrack) BaseTrack trackId (defined in BaseTrack) BaseTrack userHasVoted (defined in QueuedTrack) QueuedTrack votes (defined in QueuedTrack) QueuedTrack
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+QueuedTrack Struct Reference
+
+
+
+Specialized track which is found inside queues.
+ More...
+
+#include <Tracks.h>
+
+Inheritance diagram for QueuedTrack:
+
+
+ 
+
+
+
+
+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:
+- src/Types/Tracks.h
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/structQueuedTrack.png b/docs/html/structQueuedTrack.png
new file mode 100644
index 0000000..2cbaa77
Binary files /dev/null and b/docs/html/structQueuedTrack.png differ
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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Network/RequestInformation.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Network/RequestInformation.h
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
sid The session ID of the user. Used to authenticate as admin. trkid The track to be moved. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be moved. toQueue Determines 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 @@
This is the complete list of members for MusicBackend, including all inherited members.
- getCurrentPlayback(void)=0 (defined in MusicBackend) MusicBackend pure virtual getVolume(void)=0 (defined in MusicBackend) MusicBackend pure virtual initBackend(void)=0 (defined in MusicBackend) MusicBackend pure virtual pause(void)=0 (defined in MusicBackend) MusicBackend pure virtual play()=0 (defined in MusicBackend) MusicBackend pure virtual queryTracks(std::string const &pattern, size_t const num)=0 (defined in MusicBackend) MusicBackend pure virtual setPlayback(Track const &track)=0 (defined in MusicBackend) MusicBackend pure virtual setVolume(size_t const percent)=0 (defined in MusicBackend) MusicBackend pure virtual createBaseTrack(TTrackID const &trackID)=0 MusicBackend pure virtual getCurrentPlayback()=0 MusicBackend pure virtual getVolume()=0 MusicBackend pure virtual initBackend()=0 MusicBackend pure virtual pause()=0 MusicBackend pure virtual play()=0 MusicBackend pure virtual queryTracks(std::string const &pattern, size_t const num)=0 MusicBackend pure virtual setPlayback(BaseTrack const &track)=0 MusicBackend pure virtual setVolume(size_t const percent)=0 MusicBackend pure virtual ~MusicBackend() (defined in MusicBackend) MusicBackend inlinevirtual
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:
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
-
+
+ trackID Unique track ID (returned for example by queryTracks).
+
+
+
+
+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
-
+
+ pattern Search patten (wildcard support depends on the backend). num Maximum number of returned tracks (maximum is 50).
+
+
+
+
+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
-
+
+ track track 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
-
+
+ percent Volume in percent.
+
+
+- Returns
- Returns an Error on failure.
+
+Implemented in SpotifyBackend.
+
+
+
The documentation for this class was generated from the following file:
- src/MusicBackend.h
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) NetworkAPI protected NetworkAPI() (defined in NetworkAPI) NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI) NetworkAPI ~NetworkAPI() (defined in NetworkAPI) NetworkAPI inlinevirtual
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)=0 NetworkListener pure virtual controlPlayer(TSessionID const &sid, PlayerAction action)=0 NetworkListener pure virtual generateSession(TPassword const &pw)=0 NetworkListener pure virtual moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType type)=0 NetworkListener pure virtual queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0 NetworkListener pure virtual removeTrack(TSessionID const &sid, TTrackID const &trkid)=0 NetworkListener pure virtual voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0 NetworkListener pure virtual generateSession(std::optional< TPassword > const &pw, std::optional< std::string > const &nickname)=0 NetworkListener pure virtual getCurrentQueues(TSessionID const &sid)=0 NetworkListener pure virtual moveTrack(TSessionID const &sid, TTrackID const &trkid, QueueType toQueue)=0 NetworkListener pure virtual queryTracks(std::string const &searchPattern, size_t const nrOfEntries)=0 NetworkListener pure virtual removeTrack(TSessionID const &sid, TTrackID const &trkid)=0 NetworkListener pure virtual voteTrack(TSessionID const &sid, TTrackID const &trkid, TVote vote)=0 NetworkListener pure 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 @@
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
-
- pw The 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
-
+
+ sid The 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
queryMusic beforehand. Error if something went wrong.
@@ -320,7 +369,7 @@
This is the complete list of members for MusicBackend, including all inherited members.
- getCurrentPlayback(void)=0 (defined in MusicBackend) MusicBackend pure virtual getVolume(void)=0 (defined in MusicBackend) MusicBackend pure virtual initBackend(void)=0 (defined in MusicBackend) MusicBackend pure virtual pause(void)=0 (defined in MusicBackend) MusicBackend pure virtual play()=0 (defined in MusicBackend) MusicBackend pure virtual queryTracks(std::string const &pattern, size_t const num)=0 (defined in MusicBackend) MusicBackend pure virtual setPlayback(Track const &track)=0 (defined in MusicBackend) MusicBackend pure virtual setVolume(size_t const percent)=0 (defined in MusicBackend) MusicBackend pure virtual createBaseTrack(TTrackID const &trackID)=0 MusicBackend pure virtual getCurrentPlayback()=0 MusicBackend pure virtual getVolume()=0 MusicBackend pure virtual initBackend()=0 MusicBackend pure virtual pause()=0 MusicBackend pure virtual play()=0 MusicBackend pure virtual queryTracks(std::string const &pattern, size_t const num)=0 MusicBackend pure virtual setPlayback(BaseTrack const &track)=0 MusicBackend pure virtual setVolume(size_t const percent)=0 MusicBackend pure virtual ~MusicBackend() (defined in MusicBackend) MusicBackend inlinevirtual
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:
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()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Creates a new BaseTrack instance with the given trackID.
+- Parameters
-
+
+
+trackID Unique track ID (returned for example by queryTracks).
+
Implemented in SpotifyBackend.
+ +◆ 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()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Returns the volume of the actual device in percent.
+- Returns
- Volume in percent on success, otherwise Error.
Implemented in SpotifyBackend.
+ +◆ pause()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Pauses the current playback.
+- Returns
- Returns an Error on failure.
Implemented in SpotifyBackend.
+ +◆ play()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Resumes the current playback.
+- Returns
- Returns an Error on failure.
Implemented in SpotifyBackend.
+ +◆ queryTracks()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Queries the backend for all tracks given a pattern.
+- Parameters
-
+
+
+pattern Search patten (wildcard support depends on the backend). num Maximum number of returned tracks (maximum is 50).
+
Implemented in SpotifyBackend.
+ +◆ setPlayback()
+ +
+
+
+
+
+
+
+
|
+ +pure virtual | +
+
+
+Set the given track as playback (means the track gets played).
+- Parameters
-
+
+
+track track to play
+
- Returns
- Returns an Error on failure.
Implemented in SpotifyBackend.
+ +◆ setVolume()
+ +
+
+
+
+
+
|
+ +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
-
+
+
+percent Volume in percent.
+
- Returns
- Returns an Error on failure.
Implemented in SpotifyBackend.
+ +The documentation for this class was generated from the following file:
- src/MusicBackend.h
Public Member Functions
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
-
- pw The 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.
Error otherwise.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.| ( | -TPassword const & | -pw | ) | +std::optional< TPassword > const & | +pw, | + +
| + | std::optional< std::string > const & | +nickname | +|
| + | ) | +
- Parameters
-
- pw The 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.
| pw | The 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. |
Error otherwise. Error otherwise.
+
+
+
+
|
+ +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
-
+
+
+sid The 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
Errorotherwise.
Implemented in JukeBox.
+ +
@@ -283,7 +332,7 @@
QueueType
- type
+ toQueue
sid The session ID of the user. Used to authenticate as admin. trkid The track to be moved. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be moved. toQueue Determines 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 @@
- virtual TResult<std::vector<Track> > NetworkListener::queryTracks
+ virtual TResult<std::vector<BaseTrack> > NetworkListener::queryTracks
(
std::string const &
searchPattern,
@@ -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 @@
sid The session ID of the user. Used to authenticate as admin if needed. trkid The ID of the track to add to a queue. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be added. vote Determines 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) override RAMDataStore virtual addUser(User const &user) override RAMDataStore virtual cSessionTimeoutAfterSeconds (defined in DataStore) DataStore static getPlayingTrack() override RAMDataStore virtual getQueue(QueueType q) override RAMDataStore virtual getUser(TSessionID const &ID) override RAMDataStore virtual hasTrack(TTrackID const &ID, QueueType q) override RAMDataStore virtual hasUser(TSessionID const &ID) override RAMDataStore virtual isSessionExpired(TSessionID const &ID) override RAMDataStore virtual nextTrack() override RAMDataStore virtual removeTrack(TTrackID const &ID, QueueType q) override RAMDataStore virtual removeUser(TSessionID const &ID) override RAMDataStore virtual voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) override RAMDataStore virtual ~DataStore() (defined in DataStore) DataStore inlinevirtual
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+RAMDataStore Class Reference
+
+
+
+Implements a DataStore which stores its data purly in RAM (no persistance).
+ More...
+
+#include <RAMDataStore.h>
+
+Inheritance diagram for RAMDataStore:
+
+
+
+
+
+
+
+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
+
+
+
+
+
+◆ addUser()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::addUser
+ (
+ User const &
+ user )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ getPlayingTrack()
+
+
+
+
+
+
+
+
+ TResult< optional< QueuedTrack > > RAMDataStore::getPlayingTrack
+ (
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ getQueue()
+
+
+
+
+
+◆ getUser()
+
+
+
+
+
+
+
+
+ TResult< User > RAMDataStore::getUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ hasTrack()
+
+
+
+
+
+◆ hasUser()
+
+
+
+
+
+
+
+
+ bool RAMDataStore::hasUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+Query the internal user list whether a certain user exists.
+- Parameters
-
+
+ sID The 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
+
+
+
+
+
+◆ nextTrack()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::nextTrack
+ (
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ removeTrack()
+
+
+
+
+
+◆ removeUser()
+
+
+
+
+
+
+
+
+ TResult< User > RAMDataStore::removeUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ voteTrack()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::voteTrack
+ (
+ TSessionID const &
+ sID,
+
+
+ TTrackID const &
+ tID,
+
+
+ TVote
+ vote
+
+
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+Upvote/remove Upvote from a track.
+- Parameters
-
+
+ sID The ID of the User who wants to vote tID The ID of the Track to vote for vote The 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:
+- src/Datastore/RAMDataStore.h
+- src/Datastore/RAMDataStore.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classRAMDataStore.png b/docs/html/classRAMDataStore.png
new file mode 100644
index 0000000..48283f4
Binary files /dev/null and b/docs/html/classRAMDataStore.png differ
diff --git a/docs/html/classRestAPI-members.html b/docs/html/classRestAPI-members.html
index ca40c72..b9f84df 100644
--- a/docs/html/classRestAPI-members.html
+++ b/docs/html/classRestAPI-members.html
@@ -72,6 +72,8 @@
listener (defined in NetworkAPI) NetworkAPI protected NetworkAPI() (defined in NetworkAPI) NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI) NetworkAPI stopServer() (defined in RestAPI) RestAPI ~NetworkAPI() (defined in NetworkAPI) NetworkAPI inlinevirtual
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 *) Implementation of the REST API.
- See also
- NetworkAPI, NetworkListener
The documentation for this class was generated from the following files:
-- src/RestAPI.h
-- src/RestAPI.cpp
+- src/Network/RestAPI.h
+- src/Network/RestAPI.cpp
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) RestRequestHandler static NotAllowedHandler(httpserver::http_request const &req) (defined in RestRequestHandler) RestRequestHandler static NotFoundHandler(httpserver::http_request const &req) (defined in RestRequestHandler) RestRequestHandler static RestRequestHandler(NetworkListener *listener) (defined in RestRequestHandler) RestRequestHandler
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Network/RestRequestHandler.h
+- src/Network/RestRequestHandler.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classRestRequestHandler.png b/docs/html/classRestRequestHandler.png
new file mode 100644
index 0000000..cd147f1
Binary files /dev/null and b/docs/html/classRestRequestHandler.png differ
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) Serializer static serialize(BaseTrack const &track) (defined in Serializer) Serializer static serialize(QueuedTrack const &track) (defined in Serializer) Serializer static serialize(PlaybackTrack const &track) (defined in Serializer) Serializer static
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Utils/Serializer.h
+- src/Utils/Serializer.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Utils/SimpleScheduler.h
+- src/Utils/SimpleScheduler.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyApi::Device Class Reference
+
+
+
+
+
+#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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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::Devices inline mDevices (defined in SpotifyApi::Devices) SpotifyApi::Devices
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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::SpotifyAPI static stringUrlEncode(std::string const &str) SpotifyApi::SpotifyAPI static transferUsersPlayback(std::string const &accessToken, std::vector< Device > const &devices, bool play=false) SpotifyApi::SpotifyAPI
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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
-
+
+ grantType which authorization type to use code authentification code (received from Spotify Authorization) redirectUri redirection url (only for comparing) clientID clientID (from spotify developers dashboard) clientSecret clientSecret (from spotify developers dashboard)
+
+
+this function fetches a token from the spotify web api. until now, only the GrantType AuthorizationCode is implemented.
+
+
+
+
+◆ getAvailableDevices()
+
+
+
+
+
+◆ 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
-
+
+ accessToken valid access token market specifies, 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..
+
+
+
+
+◆ 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
-
+
+ accessToken valid access token spotifyID spotify id of the song (without "spotify:track:" string) market only return tracks, which are valid in the given market
+
+
+
+
+
+
+
+◆ pause()
+
+
+
+
+
+ TResultOpt SpotifyAPI::pause
+ (
+ std::string const &
+ accessToken,
+
+
+ Device const &
+ device = Device()
+
+
+ )
+
+
+
+
+pauses the acutal track
+- Parameters
-
+
+ accessToken valid access token device select 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
-
+
+ accessToken valid access token uris a vector of spotify uris (ids) which will be queued and played device select on which device to play (if not given, the current active device will be used) positionMs set 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
-
+
+ refreshToken the refresh token gathered from getAccessToken(..) clientID clientID (from spotify developers dashboard) clientSecret clientSecret (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!!
+
+
+
+
+◆ 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
-
+
+ accessToken valid access token queryKey the search string type specifies if it gets searched for tracks, artists, albums, or playlists limit sets the limit of maximum number returned tracks,.. offset number offset market only 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
-
+
+ accessToken valid access token volume volume in percent (0-100) device select 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
-
+
+ str string to encode
+
+
+- Returns
- encoded string
+
+
+
+
+◆ stringUrlEncode()
+
+
+
+
+
+
+
+
+ std::string SpotifyAPI::stringUrlEncode
+ (
+ std::string const &
+ str )
+
+
+
+
+static
+
+
+
+
+encodes the given string with http special characters
+- Parameters
-
+
+ str string 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
-
+
+ accessToken valid access token devices its possible to set an array, but until now only a single device is currently supported play true 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:
+- src/Spotify/SpotifyAPI.h
+- src/Spotify/SpotifyAPI.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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
-
+
+ scopes scopes
+
+
+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:
+- src/Spotify/SpotifyAuthorization.h
+- src/Spotify/SpotifyAuthorization.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png
new file mode 100644
index 0000000..85bce22
Binary files /dev/null and b/docs/html/classSpotifyApi_1_1SpotifyAuthorization.png differ
diff --git a/docs/html/classSpotifyApi_1_1SpotifyDummy-members.html b/docs/html/classSpotifyApi_1_1SpotifyDummy-members.html
new file mode 100644
index 0000000..7c46842
--- /dev/null
+++ b/docs/html/classSpotifyApi_1_1SpotifyDummy-members.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+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::SpotifyDummy inline
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+SpotifyApi::SpotifyError Class Reference
+
+
+
+
+
+#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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Spotify/SpotifyAPITypes.h
+- src/Spotify/SpotifyAPITypes.cpp
+
+
+
+
+Generated by
+
+ 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) SpotifyBackend virtual getVolume(void) override (defined in SpotifyBackend) SpotifyBackend virtual initBackend(void) override (defined in SpotifyBackend) SpotifyBackend virtual pause(void) override (defined in SpotifyBackend) SpotifyBackend virtual play() override (defined in SpotifyBackend) SpotifyBackend virtual queryTracks(std::string const &pattern, size_t const num) override (defined in SpotifyBackend) SpotifyBackend virtual setPlayback(Track const &track) override (defined in SpotifyBackend) SpotifyBackend virtual setVolume(size_t const percent) override (defined in SpotifyBackend) SpotifyBackend virtual createBaseTrack(TTrackID const &trackID) override SpotifyBackend virtual getCurrentPlayback() override SpotifyBackend virtual getVolume() override SpotifyBackend virtual initBackend() override SpotifyBackend virtual pause() override SpotifyBackend virtual play() override SpotifyBackend virtual queryTracks(std::string const &pattern, size_t const num) override SpotifyBackend virtual setPlayback(BaseTrack const &track) override SpotifyBackend virtual setVolume(size_t const percent) override SpotifyBackend virtual ~MusicBackend() (defined in MusicBackend) MusicBackend inlinevirtual
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:
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
-
+
+ trackID Unique track ID (returned for example by queryTracks).
+
+
+
+
+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
-
+
+ pattern Search patten (wildcard support depends on the backend). num Maximum number of returned tracks (maximum is 50).
+
+
+
+
+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
-
+
+ track track 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
-
+
+ percent Volume in percent.
+
+
+- Returns
- Returns an Error on failure.
+
+Implements MusicBackend.
+
+
+
The documentation for this class was generated from the following files:
-- src/SpotifyBackend.h
-- src/SpotifyBackend.cpp
+- src/Spotify/SpotifyBackend.h
+- src/Spotify/SpotifyBackend.cpp
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
+ 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
-
+
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
+
+ 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
+
+ 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
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
+
+ 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
+
+ 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
+
+ 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.cpp Class ConfigHandler implementation ConfigHandler.h Class ConfigHandler definition GlobalTypes.h Defines types and constants that are used globally JukeBox.cpp Class JukeBox implementation JukeBox.h Class JukeBox definition LoggingHandler.cpp Class LoggingHandler implementation LoggingHandler.h Class LoggingHandler definition main.cpp Main program for project "Virtual JukeBox" MusicBackend.h Interface for MusicBackends NetworkAPI.cpp Implementation of class NetworkAPI NetworkAPI.h Definition of class NetworkAPI NetworkListener.h Interface Class NetworkListener definition PlaybackTrack.h Queue.cpp Class Queue implementation Queue.h Class Queue definition RestAPI.cpp Implementation of class RestAPI RestAPI.h Definition of class RestAPI RestEndpointHandler.cpp Implementation of class RestEndpointHandler RestEndpointHandler.h Definition of class RestEndpointHandler Result.cpp Implements functions Result.h Defines function return values and types SpotifyBackend.h Class handles Music Playback with a Spotify Backend Track.cpp Class Track implementation Track.h Class Track definition ▼ Datastore RAMDataStore.h Class RAMDataStore implementation ▼ Network RequestInformation.h Definition of class RequestInformation RestAPI.cpp Implementation of class RestAPI RestAPI.h Definition of class RestAPI RestEndpointHandlers.cpp Handler functions for all available REST endpoints RestEndpointHandlers.h Handler functions for all available REST endpoints RestRequestHandler.cpp Implementation of class RestRequestHandler RestRequestHandler.h Definition of class RestRequestHandler ▼ Spotify SpotifyAPI.cpp Class SpotifyAPI definition SpotifyAPI.h Class SpotifyAPI definition SpotifyAPITypes.cpp Contains Structures for the Spotify Api implementation SpotifyAPITypes.h Contains Structures for the Spotify Api SpotifyAuthorization.cpp Class SpotifyAuthorization implementation SpotifyAuthorization.h Class SpotifyAuthorization definition SpotifyBackend.cpp Class handles Music Playback with a Spotify Backend SpotifyBackend.h Class handles Music Playback with a Spotify Backend ▼ Types GlobalTypes.h Defines types and constants that are used globally Queue.h Class Queue definition Result.h Defines function return values and types Tracks.h Definitions of all track related structs ▼ Utils ConfigHandler.cpp Class ConfigHandler implementation ConfigHandler.h Class ConfigHandler definition LoggingHandler.cpp LoggingHandler implementation LoggingHandler.h LoggingHandler header file Serializer.cpp Implementation of class Serializer Serializer.h Definition of class Serializer SimpleScheduler.cpp Class SimpleScheduler implementation SimpleScheduler.h Class SimpleScheduler definition DataStore.h Class DataStore definition JukeBox.cpp Class JukeBox implementation JukeBox.h Class JukeBox definition main.cpp Main program for project "VirtualJukeBox" MusicBackend.h Interface for MusicBackend NetworkAPI.cpp Implementation of class NetworkAPI NetworkAPI.h Definition of class NetworkAPI NetworkListener.h Interface 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:
+Here is a list of all documented class members with links to the class documentation for each member:
+
+- a -
+- addTrack()
+: DataStore
+, RAMDataStore
+
- addTrackToQueue()
: JukeBox
, NetworkListener
+- addUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- c -
+- checkForInconsistency()
+: SimpleScheduler
+
- controlPlayer()
: JukeBox
, NetworkListener
+- createBaseTrack()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- g -
- generateSession()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+- getAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
+
+- getAvailableDevices()
+: SpotifyApi::SpotifyAPI
+
+- getCurrentPlayback()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- getCurrentQueues()
+: JukeBox
+, NetworkListener
+
+- getExpiresAt()
+: SpotifyApi::SpotifyAuthorization
+
+- getLastPlayback()
+: SimpleScheduler
+
+- getPlayingTrack()
+: DataStore
+, RAMDataStore
+
+- getQueue()
+: DataStore
+, RAMDataStore
+
+- getRefreshToken()
+: SpotifyApi::SpotifyAuthorization
+
+- getScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- getTrack()
+: SpotifyApi::SpotifyAPI
+
+- getUser()
+: DataStore
+, RAMDataStore
- getValueInt()
: ConfigHandler
@@ -80,24 +148,147 @@
- getValueString()
: ConfigHandler
+- getVolume()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- h -
+- hasTrack()
+: DataStore
+, RAMDataStore
+
+- hasUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- i -
+- initBackend()
+: MusicBackend
+, SpotifyBackend
+
+- isSessionExpired()
+: DataStore
+, RAMDataStore
+
+
+
+
+- m -
- moveTrack()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+
+
+- n -
+- nextTrack()
+: DataStore
+, RAMDataStore
+, SimpleScheduler
+
+
+
+
+- p -
+- pause()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- play()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+
+
+
+- q -
- queryTracks()
-: JukeBox
-, NetworkListener
+: JukeBox
+, MusicBackend
+, NetworkListener
+, SpotifyBackend
+
+
+
+
+- r -
+- refreshAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
- removeTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
+
+- removeUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- s -
+- search()
+: SpotifyApi::SpotifyAPI
- setConfigFilePath()
: ConfigHandler
+- setPlayback()
+: MusicBackend
+, SpotifyBackend
+
+- setScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- setVolume()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- start()
+: JukeBox
+, SimpleScheduler
+
+- startServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stopServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stringBase64Encode()
+: SpotifyApi::SpotifyAPI
+
+- stringUrlEncode()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- t -
+- transferUsersPlayback()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- v -
- voteTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
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 @@
-
+
+
+- a -
+- addTrack()
+: DataStore
+, RAMDataStore
+
- addTrackToQueue()
: JukeBox
, NetworkListener
+- addUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- c -
+- checkForInconsistency()
+: SimpleScheduler
+
- controlPlayer()
: JukeBox
, NetworkListener
+- createBaseTrack()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- g -
- generateSession()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+- getAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
+
+- getAvailableDevices()
+: SpotifyApi::SpotifyAPI
+
+- getCurrentPlayback()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- getCurrentQueues()
+: JukeBox
+, NetworkListener
+
+- getExpiresAt()
+: SpotifyApi::SpotifyAuthorization
+
+- getLastPlayback()
+: SimpleScheduler
+
+- getPlayingTrack()
+: DataStore
+, RAMDataStore
+
+- getQueue()
+: DataStore
+, RAMDataStore
+
+- getRefreshToken()
+: SpotifyApi::SpotifyAuthorization
+
+- getScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- getTrack()
+: SpotifyApi::SpotifyAPI
+
+- getUser()
+: DataStore
+, RAMDataStore
- getValueInt()
: ConfigHandler
@@ -80,24 +148,147 @@
- getValueString()
: ConfigHandler
+- getVolume()
+: MusicBackend
+, SpotifyBackend
+
+
+
+
+- h -
+- hasTrack()
+: DataStore
+, RAMDataStore
+
+- hasUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- i -
+- initBackend()
+: MusicBackend
+, SpotifyBackend
+
+- isSessionExpired()
+: DataStore
+, RAMDataStore
+
+
+
+
+- m -
- moveTrack()
-: JukeBox
-, NetworkListener
+: JukeBox
+, NetworkListener
+
+
+
+- n -
+- nextTrack()
+: DataStore
+, RAMDataStore
+, SimpleScheduler
+
+
+
+
+- p -
+- pause()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- play()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+
+
+
+- q -
- queryTracks()
-: JukeBox
-, NetworkListener
+: JukeBox
+, MusicBackend
+, NetworkListener
+, SpotifyBackend
+
+
+
+
+- r -
+- refreshAccessToken()
+: SpotifyApi::SpotifyAPI
+, SpotifyApi::SpotifyAuthorization
- removeTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
+
+- removeUser()
+: DataStore
+, RAMDataStore
+
+
+
+
+- s -
+- search()
+: SpotifyApi::SpotifyAPI
- setConfigFilePath()
: ConfigHandler
+- setPlayback()
+: MusicBackend
+, SpotifyBackend
+
+- setScopes()
+: SpotifyApi::SpotifyAuthorization
+
+- setVolume()
+: MusicBackend
+, SpotifyApi::SpotifyAPI
+, SpotifyBackend
+
+- start()
+: JukeBox
+, SimpleScheduler
+
+- startServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stopServer()
+: SpotifyApi::SpotifyAuthorization
+
+- stringBase64Encode()
+: SpotifyApi::SpotifyAPI
+
+- stringUrlEncode()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- t -
+- transferUsersPlayback()
+: SpotifyApi::SpotifyAPI
+
+
+
+
+- v -
- voteTrack()
-: JukeBox
+: DataStore
+, JukeBox
, NetworkListener
+, RAMDataStore
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 @@
-- checkOptionalError()
-: Result.cpp
-, Result.h
+
- checkAlternativeError()
+: Result.h
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 @@
-- Queues
-: NetworkListener.h
-
- TPassword
: GlobalTypes.h
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 8878a93..5396185 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -67,20 +67,40 @@
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
- CConfigHandler CError A customized error type ▼Chttp_resource CRestEndpointHandler Provides REST endpoints for incoming connections CLoggingHandler ▼CMusicBackend CSpotifyBackend ▼CNetworkAPI Base class for all implementations of network interfaces CRestAPI Implementation of the REST API ▼CNetworkListener Provides interface methods for all supported requests CJukeBox CPlaybackTrack CQueue CTrack CSpotifyApi::Album Simplified Spotify Album class CSpotifyApi::Artist Simplified artist object ▼CBaseTrack The most basic representation of a track CPlaybackTrack Specialized track representing the currently playing track CQueuedTrack Specialized track which is found inside queues CConfigHandler Singleton class which provides shared access to the configuration file used ▼CDataStore Interface for storing Data such as Tracks, Users, Votes, etc CRAMDataStore Implements a DataStore which stores its data purly in RAM (no persistance) CSpotifyApi::Device Device Object CSpotifyApi::Devices Wrapper class for multiple devices CError A customized error type ▼Chttp_resource CRestRequestHandler Provides a REST request handler for incoming connections CSpotifyApi::SpotifyAuthorization Handles the 3 parties user authentication CSpotifyApi::Image Spotify Image Class ▼CMusicBackend Provides an abstracted interface to a MusicBackend s CSpotifyBackend Spotify music backend class which handles api calls and starts the authentication process ▼CNetworkAPI Base class for all implementations of network interfaces CRestAPI Implementation of the REST API ▼CNetworkListener Provides interface methods for all supported requests CJukeBox Core class which combines all interface implementations in a working server application CSpotifyApi::Playback Contains infos about the actual playback CQueue Respresents a queue which is returned to the clients CQueueStatus Wraps all information to return if a client requests the current queue status CRequestInformation Wraps all relevant pieces of information provided by a HTTP request CResponseInformation Wraps all needed pieces of information to form a proper HTTP response CSerializer Template class which can be used as a central class for serialization routines for different data types CSimpleScheduler A simple track scheduler (for presentation purposes) CSpotifyApi::SpotifyAPI Handles the calls with the spotify web api CSpotifyApi::SpotifyDummy Type gets used, when no content data or Error is received CSpotifyApi::SpotifyError Error type CSpotifyApi::SpotifyPaging Represents one page of search results CSpotifyApi::Token Return type on valid token request CSpotifyApi::Track Simplified track object
diff --git a/docs/html/main_8cpp.html b/docs/html/main_8cpp.html
index b1d6d82..0aa7b2b 100644
--- a/docs/html/main_8cpp.html
+++ b/docs/html/main_8cpp.html
@@ -72,24 +72,26 @@
-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".
-
+Main program for project "VirtualJukeBox".
+
+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.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.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) BaseTrack inline progressMs (defined in PlaybackTrack) PlaybackTrack title (defined in BaseTrack) BaseTrack trackId (defined in BaseTrack) BaseTrack
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+PlaybackTrack Struct Reference
+
+
+
+Specialized track representing the currently playing track.
+ More...
+
+#include <Tracks.h>
+
+Inheritance diagram for PlaybackTrack:
+
+
+
+
+
+
+
+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:
+- src/Types/Tracks.h
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/structPlaybackTrack.png b/docs/html/structPlaybackTrack.png
new file mode 100644
index 0000000..cfcbea1
Binary files /dev/null and b/docs/html/structPlaybackTrack.png differ
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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Types/Queue.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Types/Queue.h
+
+
+
+
+Generated by
+
+ 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) QueuedTrack inline operator==(const BaseTrack &tr) (defined in BaseTrack) BaseTrack inline title (defined in BaseTrack) BaseTrack trackId (defined in BaseTrack) BaseTrack userHasVoted (defined in QueuedTrack) QueuedTrack votes (defined in QueuedTrack) QueuedTrack
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+QueuedTrack Struct Reference
+
+
+
+Specialized track which is found inside queues.
+ More...
+
+#include <Tracks.h>
+
+Inheritance diagram for QueuedTrack:
+
+
+
+
+
+
+
+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:
+- src/Types/Tracks.h
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/structQueuedTrack.png b/docs/html/structQueuedTrack.png
new file mode 100644
index 0000000..2cbaa77
Binary files /dev/null and b/docs/html/structQueuedTrack.png differ
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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Network/RequestInformation.h
+
+
+
+
+Generated by
+
+ 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
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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:
+- src/Network/RequestInformation.h
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
queryMusic beforehand. Error if something went wrong.
@@ -325,7 +374,7 @@
- virtual TResult<std::vector<Track> > NetworkListener::queryTracks
+ virtual TResult<std::vector<BaseTrack> > NetworkListener::queryTracks
(
std::string const &
searchPattern,
@@ -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 @@
sid The session ID of the user. Used to authenticate as admin if needed. trkid The ID of the track to add to a queue. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be added. vote Determines 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) override RAMDataStore virtual addUser(User const &user) override RAMDataStore virtual cSessionTimeoutAfterSeconds (defined in DataStore) DataStore static getPlayingTrack() override RAMDataStore virtual getQueue(QueueType q) override RAMDataStore virtual getUser(TSessionID const &ID) override RAMDataStore virtual hasTrack(TTrackID const &ID, QueueType q) override RAMDataStore virtual hasUser(TSessionID const &ID) override RAMDataStore virtual isSessionExpired(TSessionID const &ID) override RAMDataStore virtual nextTrack() override RAMDataStore virtual removeTrack(TTrackID const &ID, QueueType q) override RAMDataStore virtual removeUser(TSessionID const &ID) override RAMDataStore virtual voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) override RAMDataStore virtual ~DataStore() (defined in DataStore) DataStore inlinevirtual
+
+
+Generated by
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+RAMDataStore Class Reference
+
+
+
+Implements a DataStore which stores its data purly in RAM (no persistance).
+ More...
+
+#include <RAMDataStore.h>
+
+Inheritance diagram for RAMDataStore:
+
+
+
+
+
+
+
+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
+
+
+
+
+
+◆ addUser()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::addUser
+ (
+ User const &
+ user )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ getPlayingTrack()
+
+
+
+
+
+
+
+
+ TResult< optional< QueuedTrack > > RAMDataStore::getPlayingTrack
+ (
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ getQueue()
+
+
+
+
+
+◆ getUser()
+
+
+
+
+
+
+
+
+ TResult< User > RAMDataStore::getUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ hasTrack()
+
+
+
+
+
+◆ hasUser()
+
+
+
+
+
+
+
+
+ bool RAMDataStore::hasUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+Query the internal user list whether a certain user exists.
+- Parameters
-
+
+ sID The 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
+
+
+
+
+
+◆ nextTrack()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::nextTrack
+ (
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ removeTrack()
+
+
+
+
+
+◆ removeUser()
+
+
+
+
+
+
+
+
+ TResult< User > RAMDataStore::removeUser
+ (
+ TSessionID const &
+ sID )
+
+
+
+
+overridevirtual
+
+
+
+
+
+◆ voteTrack()
+
+
+
+
+
+
+
+
+ TResultOpt RAMDataStore::voteTrack
+ (
+ TSessionID const &
+ sID,
+
+
+ TTrackID const &
+ tID,
+
+
+ TVote
+ vote
+
+
+ )
+
+
+
+
+overridevirtual
+
+
+
+
+Upvote/remove Upvote from a track.
+- Parameters
-
+
+ sID The ID of the User who wants to vote tID The ID of the Track to vote for vote The 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:
+- src/Datastore/RAMDataStore.h
+- src/Datastore/RAMDataStore.cpp
+
+
+
+
+Generated by
+
+ 1.8.16
+
+
+
diff --git a/docs/html/classRAMDataStore.png b/docs/html/classRAMDataStore.png
new file mode 100644
index 0000000..48283f4
Binary files /dev/null and b/docs/html/classRAMDataStore.png differ
diff --git a/docs/html/classRestAPI-members.html b/docs/html/classRestAPI-members.html
index ca40c72..b9f84df 100644
--- a/docs/html/classRestAPI-members.html
+++ b/docs/html/classRestAPI-members.html
@@ -72,6 +72,8 @@
listener (defined in NetworkAPI) NetworkAPI protected NetworkAPI() (defined in NetworkAPI) NetworkAPI setListener(NetworkListener *) (defined in NetworkAPI) NetworkAPI stopServer() (defined in RestAPI) RestAPI ~NetworkAPI() (defined in NetworkAPI) NetworkAPI inlinevirtual
Returns On success the a maximum of nrOfEntries tracks are returned, an Error otherwise.
-Implemented in JukeBox.
+Implemented in JukeBox.
@@ -459,7 +508,6 @@
sid The session ID of the user. Used to authenticate as admin if needed. trkid The ID of the track to add to a queue. Has to be queried using queryMusic beforehand. type Determines to which queue the track should be added. vote Determines 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!
nrOfEntries tracks are returned, an Error otherwise. queryMusic beforehand.
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+RAMDataStore Member List
This is the complete list of members for RAMDataStore, including all inherited members.
+| addTrack(BaseTrack const &track, QueueType q) override | RAMDataStore | virtual |
| addUser(User const &user) override | RAMDataStore | virtual |
| cSessionTimeoutAfterSeconds (defined in DataStore) | DataStore | static |
| getPlayingTrack() override | RAMDataStore | virtual |
| getQueue(QueueType q) override | RAMDataStore | virtual |
| getUser(TSessionID const &ID) override | RAMDataStore | virtual |
| hasTrack(TTrackID const &ID, QueueType q) override | RAMDataStore | virtual |
| hasUser(TSessionID const &ID) override | RAMDataStore | virtual |
| isSessionExpired(TSessionID const &ID) override | RAMDataStore | virtual |
| nextTrack() override | RAMDataStore | virtual |
| removeTrack(TTrackID const &ID, QueueType q) override | RAMDataStore | virtual |
| removeUser(TSessionID const &ID) override | RAMDataStore | virtual |
| voteTrack(TSessionID const &sID, TTrackID const &tID, TVote vote) override | RAMDataStore | virtual |
| ~DataStore() (defined in DataStore) | DataStore | inlinevirtual |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+RAMDataStore Class Reference
Implements a DataStore which stores its data purly in RAM (no persistance). + More...
+ +#include <RAMDataStore.h>
+Inheritance diagram for RAMDataStore:
+
+
+
+
+
+
+
++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()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ addUser()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ getPlayingTrack()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ getQueue()
+ +
+
+
+
+◆ getUser()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ hasTrack()
+ +
+
+
+
+◆ hasUser()
+ +
+
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Query the internal user list whether a certain user exists.
+- Parameters
-
+
+
+sID The ID of the user to check for
+
- Returns
trueif an user with this ID exists,falseotherwise
Implements DataStore.
+ +◆ isSessionExpired()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ nextTrack()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ removeTrack()
+ +
+
+
+
+◆ removeUser()
+ +
+
+
+
+
+
+
+
+
|
+ +overridevirtual | +
◆ voteTrack()
+ +
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Upvote/remove Upvote from a track.
+- Parameters
-
+
+
+sID The ID of the User who wants to vote tID The ID of the Track to vote for vote The 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:
-
+
- src/Datastore/RAMDataStore.h +
- src/Datastore/RAMDataStore.cpp +
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 @@
Public Member Functions inherited from NetworkAPIImplementation of the REST API.
- See also
- NetworkAPI, NetworkListener
The documentation for this class was generated from the following files:
-
-
- src/RestAPI.h -
- src/RestAPI.cpp +
- src/Network/RestAPI.h +
- src/Network/RestAPI.cpp
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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) | RestRequestHandler | static |
| NotAllowedHandler(httpserver::http_request const &req) (defined in RestRequestHandler) | RestRequestHandler | static |
| NotFoundHandler(httpserver::http_request const &req) (defined in RestRequestHandler) | RestRequestHandler | static |
| RestRequestHandler(NetworkListener *listener) (defined in RestRequestHandler) | RestRequestHandler |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Network/RestRequestHandler.h +
- src/Network/RestRequestHandler.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+Serializer Member List
This is the complete list of members for Serializer, including all inherited members.
+| serialize(T const &) (defined in Serializer) | Serializer | static |
| serialize(BaseTrack const &track) (defined in Serializer) | Serializer | static |
| serialize(QueuedTrack const &track) (defined in Serializer) | Serializer | static |
| serialize(PlaybackTrack const &track) (defined in Serializer) | Serializer | static |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Utils/Serializer.h +
- src/Utils/Serializer.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Utils/SimpleScheduler.h +
- src/Utils/SimpleScheduler.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+SpotifyApi::Device Class Reference
#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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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::Devices | inline |
| mDevices (defined in SpotifyApi::Devices) | SpotifyApi::Devices |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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::SpotifyAPI | static |
| stringUrlEncode(std::string const &str) | SpotifyApi::SpotifyAPI | static |
| transferUsersPlayback(std::string const &accessToken, std::vector< Device > const &devices, bool play=false) | SpotifyApi::SpotifyAPI |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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
-
+
+
+grantType which authorization type to use code authentification code (received from Spotify Authorization) redirectUri redirection url (only for comparing) clientID clientID (from spotify developers dashboard) clientSecret clientSecret (from spotify developers dashboard)
+
this function fetches a token from the spotify web api. until now, only the GrantType AuthorizationCode is implemented.
+ +◆ getAvailableDevices()
+ +
+
+
+
+◆ 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
-
+
+
+accessToken valid access token market specifies, 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..
+ +◆ 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
-
+
+
+accessToken valid access token spotifyID spotify id of the song (without "spotify:track:" string) market only return tracks, which are valid in the given market
+
◆ pause()
+ +
+
+
+
+
+
+
| TResultOpt SpotifyAPI::pause | +( | +std::string const & | +accessToken, | +
| + | + | Device const & | +device = Device() |
+
| + | ) | ++ |
+
+
+pauses the acutal track
+- Parameters
-
+
+
+accessToken valid access token device select 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
-
+
+
+accessToken valid access token uris a vector of spotify uris (ids) which will be queued and played device select on which device to play (if not given, the current active device will be used) positionMs set 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
-
+
+
+refreshToken the refresh token gathered from getAccessToken(..) clientID clientID (from spotify developers dashboard) clientSecret clientSecret (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!!
+ +◆ 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
-
+
+
+accessToken valid access token queryKey the search string type specifies if it gets searched for tracks, artists, albums, or playlists limit sets the limit of maximum number returned tracks,.. offset number offset market only 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
-
+
+
+accessToken valid access token volume volume in percent (0-100) device select 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()
+ +
+
+
+
+
+
+
+
|
+ +static | +
+
+
+encodes the given string with base64
+- Parameters
-
+
+
+str string to encode
+
- Returns
- encoded string
◆ stringUrlEncode()
+ +
+
+
+
+
+
+
+
|
+ +static | +
+
+
+encodes the given string with http special characters
+- Parameters
-
+
+
+str string 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
-
+
+
+accessToken valid access token devices its possible to set an array, but until now only a single device is currently supported play true 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:
-
+
- src/Spotify/SpotifyAPI.h +
- src/Spotify/SpotifyAPI.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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
-
+
+
+scopes scopes
+
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:
-
+
- src/Spotify/SpotifyAuthorization.h +
- src/Spotify/SpotifyAuthorization.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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::SpotifyDummy | inline |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+SpotifyApi::SpotifyError Class Reference
#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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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 |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+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:
-
+
- src/Spotify/SpotifyAPITypes.h +
- src/Spotify/SpotifyAPITypes.cpp +
spotify music backend class which handles api calls and starts the authentication process + More...
+ +#include <SpotifyBackend.h>
Inheritance diagram for SpotifyBackend:
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()
+ +
+
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Creates a new BaseTrack instance with the given trackID.
+the trackID is the same as the spotify uri string
- Parameters
-
+
+
+trackID Unique track ID (returned for example by queryTracks).
+
Implements MusicBackend.
+ +◆ 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()
+ +
+
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Returns the volume of the actual device in percent.
+- Returns
- Volume in percent on success, otherwise Error.
Implements MusicBackend.
+ +◆ 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()
+ +
+
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Pauses the current playback.
+- Returns
- Returns an Error on failure.
Implements MusicBackend.
+ +◆ play()
+ +
+
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Resumes the current playback.
+- Returns
- Returns an Error on failure.
Implements MusicBackend.
+ +◆ queryTracks()
+ +
+
+
+
+
+
+
+
|
+ +overridevirtual | +
+
+
+Queries the backend for all tracks given a pattern.
+- Parameters
-
+
+
+pattern Search patten (wildcard support depends on the backend). num Maximum number of returned tracks (maximum is 50).
+
Implements MusicBackend.
+ +◆ setPlayback()
+ +
+
+
+
+
+
+
+
|
+ +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
-
+
+
+track track to play
+
- Returns
- Returns an Error on failure.
Implements MusicBackend.
+ +◆ setVolume()
+ +
+
+
+
+
+
|
+ +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
-
+
+
+percent Volume in percent.
+
- Returns
- Returns an Error on failure.
Implements MusicBackend.
+ +The documentation for this class was generated from the following files:
-
-
- src/SpotifyBackend.h -
- src/SpotifyBackend.cpp +
- src/Spotify/SpotifyBackend.h +
- src/Spotify/SpotifyBackend.cpp
| ||||||||||||
|
-
| Device (SpotifyApi) | +
|
-NetworkListener |
|
-
| SpotifyBackend | +|||||
| Devices (SpotifyApi) | +SpotifyDummy (SpotifyApi) | +|||||||||||
| Album (SpotifyApi) | +
|
+NetworkAPI | +RAMDataStore | +SpotifyError (SpotifyApi) | ||||||||
| ||||||||||||
| Artist (SpotifyApi) | +NetworkListener | +RequestInformation | +SpotifyPaging (SpotifyApi) | +|||||||||
|
+Error | +
|
+ResponseInformation | +
|
||||||||
| ConfigHandler | -LoggingHandler | +|||||||||||
|
RestAPI | -Track | ||||||||||
| ||||||||||||
| BaseTrack | +Playback (SpotifyApi) | +RestRequestHandler | +Token (SpotifyApi) | +|||||||||
|
-
| Image (SpotifyApi) | +PlaybackTrack | +
|
-PlaybackTrack | -RestEndpointHandler | -||||||
| Track (SpotifyApi) | +|||||||||||
|
-
|
|
||||||||||
| Error | -MusicBackend | +|||||||||||
| ConfigHandler | +Serializer | |||||||||||
| ||||||||||||
|
-
| JukeBox | +Queue | +SimpleScheduler | +||||||||
|
-Queue | -SpotifyBackend | +QueuedTrack | +SpotifyAPI (SpotifyApi) | ||||||||
| JukeBox | -NetworkAPI | +|||||||||||
| DataStore | +QueueStatus | +SpotifyAuthorization (SpotifyApi) | +||||||||||
| MusicBackend | ||||||||||||
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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. | |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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. | |
+Directories |
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. | |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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. | |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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. | |
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ VirtualJukebox
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+Datastore Directory Reference
+Files | |
| file | RAMDataStore.h [code] |
| Class RAMDataStore implementation. | |
Here is a list of all documented files with brief descriptions:
-
+
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 @@
[detail level 12]
| ▼ src | |
| ConfigHandler.cpp | Class ConfigHandler implementation |
| ConfigHandler.h | Class ConfigHandler definition |
| GlobalTypes.h | Defines types and constants that are used globally |
| JukeBox.cpp | Class JukeBox implementation |
| JukeBox.h | Class JukeBox definition |
| LoggingHandler.cpp | Class LoggingHandler implementation |
| LoggingHandler.h | Class LoggingHandler definition |
| main.cpp | Main program for project "Virtual JukeBox" |
| MusicBackend.h | Interface for MusicBackends |
| NetworkAPI.cpp | Implementation of class NetworkAPI |
| NetworkAPI.h | Definition of class NetworkAPI |
| NetworkListener.h | Interface Class NetworkListener definition |
| PlaybackTrack.h | |
| Queue.cpp | Class Queue implementation |
| Queue.h | Class Queue definition |
| RestAPI.cpp | Implementation of class RestAPI |
| RestAPI.h | Definition of class RestAPI |
| RestEndpointHandler.cpp | Implementation of class RestEndpointHandler |
| RestEndpointHandler.h | Definition of class RestEndpointHandler |
| Result.cpp | Implements functions |
| Result.h | Defines function return values and types |
| SpotifyBackend.h | Class handles Music Playback with a Spotify Backend |
| Track.cpp | Class Track implementation |
| Track.h | Class Track definition |
| ▼ Datastore | |
| RAMDataStore.h | Class RAMDataStore implementation |
| ▼ Network | |
| RequestInformation.h | Definition of class RequestInformation |
| RestAPI.cpp | Implementation of class RestAPI |
| RestAPI.h | Definition of class RestAPI |
| RestEndpointHandlers.cpp | Handler functions for all available REST endpoints |
| RestEndpointHandlers.h | Handler functions for all available REST endpoints |
| RestRequestHandler.cpp | Implementation of class RestRequestHandler |
| RestRequestHandler.h | Definition of class RestRequestHandler |
| ▼ Spotify | |
| SpotifyAPI.cpp | Class SpotifyAPI definition |
| SpotifyAPI.h | Class SpotifyAPI definition |
| SpotifyAPITypes.cpp | Contains Structures for the Spotify Api implementation |
| SpotifyAPITypes.h | Contains Structures for the Spotify Api |
| SpotifyAuthorization.cpp | Class SpotifyAuthorization implementation |
| SpotifyAuthorization.h | Class SpotifyAuthorization definition |
| SpotifyBackend.cpp | Class handles Music Playback with a Spotify Backend |
| SpotifyBackend.h | Class handles Music Playback with a Spotify Backend |
| ▼ Types | |
| GlobalTypes.h | Defines types and constants that are used globally |
| Queue.h | Class Queue definition |
| Result.h | Defines function return values and types |
| Tracks.h | Definitions of all track related structs |
| ▼ Utils | |
| ConfigHandler.cpp | Class ConfigHandler implementation |
| ConfigHandler.h | Class ConfigHandler definition |
| LoggingHandler.cpp | LoggingHandler implementation |
| LoggingHandler.h | LoggingHandler header file |
| Serializer.cpp | Implementation of class Serializer |
| Serializer.h | Definition of class Serializer |
| SimpleScheduler.cpp | Class SimpleScheduler implementation |
| SimpleScheduler.h | Class SimpleScheduler definition |
| DataStore.h | Class DataStore definition |
| JukeBox.cpp | Class JukeBox implementation |
| JukeBox.h | Class JukeBox definition |
| main.cpp | Main program for project "VirtualJukeBox" |
| MusicBackend.h | Interface for MusicBackend |
| NetworkAPI.cpp | Implementation of class NetworkAPI |
| NetworkAPI.h | Definition of class NetworkAPI |
| NetworkListener.h | Interface Class NetworkListener definition |
-
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 @@
Here is a list of all documented class members with links to the class documentation for each member:
-
+
- addTrack() +: DataStore +, RAMDataStore +
- addTrackToQueue() : JukeBox , NetworkListener +
- addUser() +: DataStore +, RAMDataStore + +
- checkForInconsistency() +: SimpleScheduler +
- controlPlayer() : JukeBox , NetworkListener +
- createBaseTrack() +: MusicBackend +, SpotifyBackend + +
- generateSession() -: JukeBox -, NetworkListener +: JukeBox +, NetworkListener + +
- getAccessToken() +: SpotifyApi::SpotifyAPI +, SpotifyApi::SpotifyAuthorization + +
- getAvailableDevices() +: SpotifyApi::SpotifyAPI + +
- getCurrentPlayback() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- getCurrentQueues() +: JukeBox +, NetworkListener + +
- getExpiresAt() +: SpotifyApi::SpotifyAuthorization + +
- getLastPlayback() +: SimpleScheduler + +
- getPlayingTrack() +: DataStore +, RAMDataStore + +
- getQueue() +: DataStore +, RAMDataStore + +
- getRefreshToken() +: SpotifyApi::SpotifyAuthorization + +
- getScopes() +: SpotifyApi::SpotifyAuthorization + +
- getTrack() +: SpotifyApi::SpotifyAPI + +
- getUser() +: DataStore +, RAMDataStore
- getValueInt() : ConfigHandler @@ -80,24 +148,147 @@
- getValueString() : ConfigHandler +
- getVolume() +: MusicBackend +, SpotifyBackend + +
- hasTrack() +: DataStore +, RAMDataStore + +
- hasUser() +: DataStore +, RAMDataStore + +
- initBackend() +: MusicBackend +, SpotifyBackend + +
- isSessionExpired() +: DataStore +, RAMDataStore + +
- moveTrack() -: JukeBox -, NetworkListener +: JukeBox +, NetworkListener +
- nextTrack() +: DataStore +, RAMDataStore +, SimpleScheduler + +
- pause() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- play() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- queryTracks() -: JukeBox -, NetworkListener +: JukeBox +, MusicBackend +, NetworkListener +, SpotifyBackend + +
- refreshAccessToken() +: SpotifyApi::SpotifyAPI +, SpotifyApi::SpotifyAuthorization
- removeTrack() -: JukeBox +: DataStore +, JukeBox , NetworkListener +, RAMDataStore + +
- removeUser() +: DataStore +, RAMDataStore + +
- search() +: SpotifyApi::SpotifyAPI
- setConfigFilePath() : ConfigHandler +
- setPlayback() +: MusicBackend +, SpotifyBackend + +
- setScopes() +: SpotifyApi::SpotifyAuthorization + +
- setVolume() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- start() +: JukeBox +, SimpleScheduler + +
- startServer() +: SpotifyApi::SpotifyAuthorization + +
- stopServer() +: SpotifyApi::SpotifyAuthorization + +
- stringBase64Encode() +: SpotifyApi::SpotifyAPI + +
- stringUrlEncode() +: SpotifyApi::SpotifyAPI + +
- transferUsersPlayback() +: SpotifyApi::SpotifyAPI + +
- voteTrack() -: JukeBox +: DataStore +, JukeBox , NetworkListener +, RAMDataStore
Here is a list of all documented class members with links to the class documentation for each member:
+
+- a -
-
+
- c -
-
+
- g -
- h -
-
+
- i -
-
+
- m -
- n -
-
+
- p -
-
+
- q -
- r -
-
+
- s -
-
+
- t -
-
+
- v -
-
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 @@
-
+
+
+
- addTrack() +: DataStore +, RAMDataStore +
- addTrackToQueue() : JukeBox , NetworkListener +
- addUser() +: DataStore +, RAMDataStore + +
- checkForInconsistency() +: SimpleScheduler +
- controlPlayer() : JukeBox , NetworkListener +
- createBaseTrack() +: MusicBackend +, SpotifyBackend + +
- generateSession() -: JukeBox -, NetworkListener +: JukeBox +, NetworkListener + +
- getAccessToken() +: SpotifyApi::SpotifyAPI +, SpotifyApi::SpotifyAuthorization + +
- getAvailableDevices() +: SpotifyApi::SpotifyAPI + +
- getCurrentPlayback() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- getCurrentQueues() +: JukeBox +, NetworkListener + +
- getExpiresAt() +: SpotifyApi::SpotifyAuthorization + +
- getLastPlayback() +: SimpleScheduler + +
- getPlayingTrack() +: DataStore +, RAMDataStore + +
- getQueue() +: DataStore +, RAMDataStore + +
- getRefreshToken() +: SpotifyApi::SpotifyAuthorization + +
- getScopes() +: SpotifyApi::SpotifyAuthorization + +
- getTrack() +: SpotifyApi::SpotifyAPI + +
- getUser() +: DataStore +, RAMDataStore
- getValueInt() : ConfigHandler @@ -80,24 +148,147 @@
- getValueString() : ConfigHandler +
- getVolume() +: MusicBackend +, SpotifyBackend + +
- hasTrack() +: DataStore +, RAMDataStore + +
- hasUser() +: DataStore +, RAMDataStore + +
- initBackend() +: MusicBackend +, SpotifyBackend + +
- isSessionExpired() +: DataStore +, RAMDataStore + +
- moveTrack() -: JukeBox -, NetworkListener +: JukeBox +, NetworkListener +
- nextTrack() +: DataStore +, RAMDataStore +, SimpleScheduler + +
- pause() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- play() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- queryTracks() -: JukeBox -, NetworkListener +: JukeBox +, MusicBackend +, NetworkListener +, SpotifyBackend + +
- refreshAccessToken() +: SpotifyApi::SpotifyAPI +, SpotifyApi::SpotifyAuthorization
- removeTrack() -: JukeBox +: DataStore +, JukeBox , NetworkListener +, RAMDataStore + +
- removeUser() +: DataStore +, RAMDataStore + +
- search() +: SpotifyApi::SpotifyAPI
- setConfigFilePath() : ConfigHandler +
- setPlayback() +: MusicBackend +, SpotifyBackend + +
- setScopes() +: SpotifyApi::SpotifyAuthorization + +
- setVolume() +: MusicBackend +, SpotifyApi::SpotifyAPI +, SpotifyBackend + +
- start() +: JukeBox +, SimpleScheduler + +
- startServer() +: SpotifyApi::SpotifyAuthorization + +
- stopServer() +: SpotifyApi::SpotifyAuthorization + +
- stringBase64Encode() +: SpotifyApi::SpotifyAPI + +
- stringUrlEncode() +: SpotifyApi::SpotifyAPI + +
- transferUsersPlayback() +: SpotifyApi::SpotifyAPI + +
- voteTrack() -: JukeBox +: DataStore +, JukeBox , NetworkListener +, RAMDataStore
- a -
-
+
- c -
-
+
- g -
- h -
-
+
- i -
-
+
- m -
- n -
-
+
- p -
-
+
- q -
- r -
-
+
- s -
-
+
- t -
-
+
- v -
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 @@
- checkOptionalError() -: Result.cpp -, Result.h +
- checkAlternativeError() +: Result.h
- Queues -: NetworkListener.h -
- TPassword : GlobalTypes.h diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 8878a93..5396185 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -67,20 +67,40 @@
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, unknowntrack_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.- Body:
{"password": "<admin_password>",-"nickname" "<nickname>"+"nickname": "<nickname>"}
@@ -320,9 +320,8 @@ "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 @@
+
+- src/Types/Tracks.h +
- src/Types/Queue.h +
- src/Types/Queue.h +
- src/Types/Tracks.h +
- src/Network/RequestInformation.h +
- src/Network/RequestInformation.h +
-
-
-
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
| CConfigHandler | |
| CError | A customized error type |
| ▼Chttp_resource | |
| CRestEndpointHandler | Provides REST endpoints for incoming connections |
| CLoggingHandler | |
| ▼CMusicBackend | |
| CSpotifyBackend | |
| ▼CNetworkAPI | Base class for all implementations of network interfaces |
| CRestAPI | Implementation of the REST API |
| ▼CNetworkListener | Provides interface methods for all supported requests |
| CJukeBox | |
| CPlaybackTrack | |
| CQueue | |
| CTrack | |
| CSpotifyApi::Album | Simplified Spotify Album class |
| CSpotifyApi::Artist | Simplified artist object |
| ▼CBaseTrack | The most basic representation of a track |
| CPlaybackTrack | Specialized track representing the currently playing track |
| CQueuedTrack | Specialized track which is found inside queues |
| CConfigHandler | Singleton class which provides shared access to the configuration file used |
| ▼CDataStore | Interface for storing Data such as Tracks, Users, Votes, etc |
| CRAMDataStore | Implements a DataStore which stores its data purly in RAM (no persistance) |
| CSpotifyApi::Device | Device Object |
| CSpotifyApi::Devices | Wrapper class for multiple devices |
| CError | A customized error type |
| ▼Chttp_resource | |
| CRestRequestHandler | Provides a REST request handler for incoming connections |
| CSpotifyApi::SpotifyAuthorization | Handles the 3 parties user authentication |
| CSpotifyApi::Image | Spotify Image Class |
| ▼CMusicBackend | Provides an abstracted interface to a MusicBackend s |
| CSpotifyBackend | Spotify music backend class which handles api calls and starts the authentication process |
| ▼CNetworkAPI | Base class for all implementations of network interfaces |
| CRestAPI | Implementation of the REST API |
| ▼CNetworkListener | Provides interface methods for all supported requests |
| CJukeBox | Core class which combines all interface implementations in a working server application |
| CSpotifyApi::Playback | Contains infos about the actual playback |
| CQueue | Respresents a queue which is returned to the clients |
| CQueueStatus | Wraps all information to return if a client requests the current queue status |
| CRequestInformation | Wraps all relevant pieces of information provided by a HTTP request |
| CResponseInformation | Wraps all needed pieces of information to form a proper HTTP response |
| CSerializer | Template class which can be used as a central class for serialization routines for different data types |
| CSimpleScheduler | A simple track scheduler (for presentation purposes) |
| CSpotifyApi::SpotifyAPI | Handles the calls with the spotify web api |
| CSpotifyApi::SpotifyDummy | Type gets used, when no content data or Error is received |
| CSpotifyApi::SpotifyError | Error type |
| CSpotifyApi::SpotifyPaging | Represents one page of search results |
| CSpotifyApi::Token | Return type on valid token request |
| CSpotifyApi::Track | Simplified track object |
-
+
+
-
-
-
+
+
+
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 @@
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 1.8.16
+
+
+
diff --git a/docs/html/structPlaybackTrack.png b/docs/html/structPlaybackTrack.png
new file mode 100644
index 0000000..cfcbea1
Binary files /dev/null and b/docs/html/structPlaybackTrack.png differ
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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 1.8.16
+
+
+
diff --git a/docs/html/structQueuedTrack.png b/docs/html/structQueuedTrack.png
new file mode 100644
index 0000000..2cbaa77
Binary files /dev/null and b/docs/html/structQueuedTrack.png differ
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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 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
+
+
+
+
+
+
+
+
+
+
+Generated by +
+ 1.8.16
+
+
+
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".
- +Main program for project "VirtualJukeBox".
+ +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 @@
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:
The value of player_action controls which action the server should take. Valid values are:
-
-
+
+
+
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 @@
+
+
+
+
+
+
+
+Loading...
+
+
+Searching...
+No Matches
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ 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) | BaseTrack | inline |
| progressMs (defined in PlaybackTrack) | PlaybackTrack | |
| title (defined in BaseTrack) | BaseTrack | |
| trackId (defined in BaseTrack) | BaseTrack |
+ 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
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+Specialized track representing the currently playing track. + More...
+ +#include <Tracks.h>
+Inheritance diagram for PlaybackTrack:
+
+
+
+
+
+
+
++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 +
+ 1.8.16
+
+
+
diff --git a/docs/html/structPlaybackTrack.png b/docs/html/structPlaybackTrack.png
new file mode 100644
index 0000000..cfcbea1
Binary files /dev/null and b/docs/html/structPlaybackTrack.png differ
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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+Queue Member List
+
+
+
+
+This is the complete list of members for Queue, including all inherited members.
+| tracks (defined in Queue) | Queue |
+Generated by +
+ 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
+
+
+
+
The documentation for this struct was generated from the following file:
+
+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 +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+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 +
+ 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
+
+
+
+
The documentation for this struct was generated from the following file:
+
+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 +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+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) | QueuedTrack | inline |
| operator==(const BaseTrack &tr) (defined in BaseTrack) | BaseTrack | inline |
| title (defined in BaseTrack) | BaseTrack | |
| trackId (defined in BaseTrack) | BaseTrack | |
| userHasVoted (defined in QueuedTrack) | QueuedTrack | |
| votes (defined in QueuedTrack) | QueuedTrack |
+Generated by +
+ 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
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
+Specialized track which is found inside queues. + More...
+ +#include <Tracks.h>
+Inheritance diagram for QueuedTrack:
+
+
+
+
+
+
+
++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 +
+ 1.8.16
+
+
+
diff --git a/docs/html/structQueuedTrack.png b/docs/html/structQueuedTrack.png
new file mode 100644
index 0000000..2cbaa77
Binary files /dev/null and b/docs/html/structQueuedTrack.png differ
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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+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 +
+ 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
+
+
+
+
The documentation for this struct was generated from the following file:
+
+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 +
+ 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
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+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 +
+ 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
+
+
+
+
The documentation for this struct was generated from the following file:
+
+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 +
+ 1.8.16
+
+
+