diff options
| author | kaotisk <kaotisk@arching-kaos.org> | 2024-10-14 21:12:45 +0300 |
|---|---|---|
| committer | kaotisk <kaotisk@arching-kaos.org> | 2024-10-14 21:12:45 +0300 |
| commit | 0b451a4d867c22ea7a5cb4625460913960978c31 (patch) | |
| tree | ce95a2d2c0485345975a178a3e7e50047d477058 /client/index.html | |
| parent | f626435e7eada9f4d4cf70658dadd6b7277758e9 (diff) | |
| download | arching-kaos-radio-0b451a4d867c22ea7a5cb4625460913960978c31.tar.gz arching-kaos-radio-0b451a4d867c22ea7a5cb4625460913960978c31.tar.bz2 arching-kaos-radio-0b451a4d867c22ea7a5cb4625460913960978c31.zip | |
Some documentation
Diffstat (limited to 'client/index.html')
| -rw-r--r-- | client/index.html | 75 |
1 files changed, 61 insertions, 14 deletions
diff --git a/client/index.html b/client/index.html index fb473f5..f203c6a 100644 --- a/client/index.html +++ b/client/index.html @@ -17,20 +17,67 @@ </div> <details open> <summary>Info to get you started</summary> - <p> - If you are visiting for the first time, you might need to "Allow Audio" first. - Please do and refresh the page. - </p> - <p> - Sometimes, you will 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. - </p> - <p> - Ideally, if "Listening at:" and "Show playback:" have the same value then you are - in sync! - </p> + <h2>Notice</h2> + <p> + If you are visiting for the first time, you might need to + "Allow Audio" first. Please do and refresh the page. + </p> + <h2>About</h2> + <p> + 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". + </p> + <p> + 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. + </p> + <p> + Ultimately, you are hearing what we would be streaming, as + you would do for a regular radio station. + </p> + <h2>Steps</h2> + <ol> + <li> + 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. + </li> + <li> + 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. + </li> + <li> + Having figured out the show that is playing, it will go + and download the whole show. Progress of that would be + observable via the "Download progress" bar below. + </li> + <li> + 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. + </li> + </ol> + <h2>Notes</h2> + <ul> + <li> + 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. + </li> + <li> + Ideally, if "Listening at:" and "Show playback:" have + the same value then you are in sync! + </li> + </ul> </details> <div> <p>Download progress:</p> |