Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 11:48:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Describe main theme behind v2

Browse Source
This commit is contained in:
Marcin Kulik
2017-03-15 17:42:37 +01:00
parent 69898ee377
commit aa32fe258a
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/asciicast-v2.md
View File

@@ -9,6 +9,17 @@ where:
* __all subsequent lines__ form an event stream, _each line_ representing a * __all subsequent lines__ form an event stream, _each line_ representing a
separate event stream item, encoded as JSON array. separate event stream item, encoded as JSON array.
By making the event stream a first class concept in the v2 format we get the
following benefits:
* it enables live, incremental writing to a file during recording (with v1
format the final recording JSON can only be written as a whole after finishing
the recording session),
* it allows the players to start the playback as soon as they read the meta-data
line (contrary to v1 format which requires reading the whole file),
* whether you're recording to a file or streaming via UNIX pipe or WebSocket the
data representation is the same.
## Meta-data ## Meta-data
The following meta-data is **required** in asciicast v2: The following meta-data is **required** in asciicast v2: