protonphoton/redilysis
11
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[fix] Readme typo

Browse Source
This commit is contained in:
alban 2020-09-29 16:03:08 +02:00
parent bac6076a25
commit 2fe3d2f425
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,14 +9,14 @@ The idea is to share a single audio analysis to many Visual Jockey filters, in o
### Redis Keys and Contents for end users
**Each _word in bold_ is a key which you can query the redis server for.**
**Each _word in bold and italic_ is a key which you can query the redis server for.**
```
# Example:
$ redis-cli get spectrum_10
"[2.21, 0.56, 0.51, 0.32, 0.27, 0.21, 0.18, 0.17, 0.18, 0.23]"
```
**rms**
**_rms_**
* **Mode** spectrum
* **Type** float number
* **Length** scalar(1)
@ -27,7 +27,7 @@ $ redis-cli get spectrum_10
* The audio volume for the scene is pretty low.
* It is obtained by averaging the RMS of every audio frame during the capture.
**spectrum_10**
**_spectrum_10_**
* **Mode** spectrum
* **Type** array of float numbers (0.0-10.0)
* **Length** 10
@ -39,7 +39,7 @@ $ redis-cli get spectrum_10
* That value being `0.27` is pretty low meaning almost no audio volume for that octave.
* It is calculated by averaging the volume of the octave's notes, e.g. `C4, D4, D#4, E4, F4, F#4, G4, G#4, A4, A#4, B4`.
**spectrum_120**
**_spectrum_120_**
* **Mode** spectrum
* **Type** array of float numbers (0.0-10.0)
* **Length** 120
@ -50,7 +50,7 @@ $ redis-cli get spectrum_10
* The audio volume for the `C2` note is `spectrum_10[23]` (12x2 - 1).
* That value being `0.81` is average meaning there is some audio volume for that octave.
**bpm_sample_interval**
**_bpm_sample_interval_**
* **Mode** bpm
* **Type** float
* **Length** scalar(1)
@ -60,7 +60,7 @@ $ redis-cli get spectrum_10
* `"3000.0"`
* Each audio sample used to detect the beats is 3s long.
**bpm_delay**
**_bpm_delay_**
* **Mode** bpm
* **Type** float
* **Length** scalar(1)
@ -71,7 +71,7 @@ $ redis-cli get spectrum_10
* The capture + detection time for this tempo detection was 3.19s
* If the `bpm_sample_interval` is 3.0s, it took 0.19s to analyze and detect beats in the sample.
**bpm**
**_bpm_**
* **Mode** bpm
* **Type** float
* **Length** scalar(1)
@ -88,7 +88,7 @@ $ redis-cli get spectrum_10
* There are ~126 beats per minutes.
**beats**
**_beats_**
* **Mode** bpm
* **Type** list
* **Length** variable