Newer
Older
#
# Aura Engine API (https://gitlab.servus.at/aura/engine-api)
#
# Copyright (C) 2020 - The Aura Engine Team.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class ApiService():
"""
Service handling API actions.
"""
config = None
logger = None
def __init__(self, config, logger):
self.config = config
self.logger = logger
def current_track(self):
"""
Retrieves the currently playing track.
Returns:
(PlayLogEntry)
"""
from models import PlayLog, TrackServiceSchema
track = PlayLog.select_current()
track_schema = TrackServiceSchema()
return track_schema.dump(track)
def list_tracks(self, offset=None, limit=None):
"""
Lists the most recent track-service entries.
Args:
offset (Integer): The number of items to skip before starting to collect the result set
limit (Integer): The numbers of items to return
Returns:
(List[PlayLogEntry])
"""
return "some list of tracks"
def clock_info(self):
"""
Retrieves the currently playing playlist.
"""
return "current playlist"
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def activate_engine(self, engine_number):
"""
Activates one engine and deactivates the other
Args:
engine_number (Integer): Number of the engine
"""
return 'do some magic!'
def get_active_engine(self):
"""
Retrieves the status entry of the currently active engine
Returns:
StatusEntry
"""
return 'do some magic!'
def get_engine_health(self, engine_number):
"""
Retrieves the most recent health info of the requested engine
Args:
engine_number (Integer): Number of the engine
Returns:
(HealthInfo)
"""
return 'do some magic!'
def log_engine_health(self, engine_number):
"""
Logs another health entry for the given engine
Args:
engine_number (Integer): Number of the engine
"""
return 'do some magic!'