diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/protocol.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/protocol.md b/doc/protocol.md index 957fe11..3c53a2a 100644 --- a/doc/protocol.md +++ b/doc/protocol.md @@ -4,7 +4,11 @@ Messages init ---- +The streamer-id and tags are optional. All other fields are mandatory. If the streamer-id +is not defined all data-update messages must contain a streamer-id. + { + "version": 1, "hostname": "myhostname", "streamer-id": { "content-id": "av-orig", "format": "flash", "quality": "medium" }, "tags": [ "elevate", "2014", "discourse" ] @@ -14,12 +18,18 @@ init data-update ----------- +All elements inside data are optional. The update must contain all data gathered between +start-time and start-time + duration-ms. +If defined by the init message the streamer-id is optional as well and when present it's +values override the values of the init message. + { "start-time": "2014-08-03T12:34:56.123Z", "duration-ms": 5000, + "streamer-id": { "content-id": "av-orig", "format": "flash", "quality": "medium" }, "data": { "clients": [ - { "ip": "127.0.0.1", "bytes-sent": 12094, "user-agent": "Mozilla Version 28", .... }, + { "ip": "127.0.0.1", "port": 1234, "bytes-sent": 12094, "user-agent": "Mozilla Version 28", .... }, ..... ], "client-count": 12, |