aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 7f8ac80ab4b3015583fe8a121ca54739316a487f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Radio Station Emulator
----------------------
That's a small proof-of-concept for radio-station-emulator

For obvious reasons, we don't guarantee that the program/list creator won't be
exploitable. That's why we mentioned the role of Radio Executive. The part that
is automated, it's only for proof-of-concept. We could assume that new shows are
only inserted by the Program Manager or Radio Executive, depending on how the
real radio station works.

Client implementation:
- ./client/index.html
- ./client/js/radio_emulator.js

Server implementation:
- ./server/index.js

Helping scripts:
- ./create_list.sh
- ./create_metadata_show.sh
- ./create_static_list.sh

Deploy scripts:
- ./init.sh
- ./deploy.sh

About
-----
This is a "Radio Station Emulator". We create lists with shows to be played, but
since we are not doing streaming of the playlists, we offer another way of
"tuning in".

Providing the time a list started playing and having pre-calculated the starting
timestamps of each show relevant to the list start timestamp, we can calculate
which show is on and what its current time of playing is.

Ultimately, you are hearing what we would be streaming, as
you would do for a regular radio station.

Steps
-----
First, your browser is going to ask our server here, what is the current list
that plays right now. It will get a response and will fetch that list.

Based on properties of the list overall and the time of visit, your browser will
start comparing each show's properties found in the list, to figure the relative
time of yours on the list. A progress bar labeled "Live progress" will be
indicating the correct time on the show.

Having figured out the show that is playing, it will go and download the whole
show. This would be observable via the "Download progress" bar.

Upon completion of the download, the "Sync" button is auto pressed and the
player start playing the show from the calculated second it calculated
previously.

Notes
-----
Sometimes, you might need to press the "Sync" button more than once. That's
mostly due to bandwidth capabilities of both the server and the client. The
"tune" would be right if you press it multiple times and land near the same
timespace over and over.

Ideally, if "Listening at:" and "Show playback:" have the same value then you
are in sync!