Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rfc(feature): Video replay envelope #129

Merged
merged 26 commits into from
Feb 9, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update text/0129-video-replay-envelope.md
  • Loading branch information
romtsn authored Feb 9, 2024
commit 1e20ad4da451884b21368faa943d14f7eca4b42d
2 changes: 1 addition & 1 deletion text/0129-video-replay-envelope.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ We need this to to capture replays on platforms where it's not possible/feasible
> Note: these dimensions may be different than the video dimensions in case only part of the screen is captured.
In that case, the following video event will have non-zero `data.payload.left` & `data.payload.top` fields (see below).

- The RRWeb JSON must contain a single event of type [`EventType.Custom`](https://github.com/rrweb-io/rrweb/blob/8aea5b00a4dfe5a6f59bd2ae72bb624f45e51e81/packages/types/src/index.ts#L8-L16), with `data.tag == 'vido'`.
- The RRWeb JSON must contain a single event of type [`EventType.Custom`](https://github.com/rrweb-io/rrweb/blob/8aea5b00a4dfe5a6f59bd2ae72bb624f45e51e81/packages/types/src/index.ts#L8-L16), with `data.tag == 'video'`.
This event must come at the second position in the array, right after the `EventType.Meta` event.
vaind marked this conversation as resolved.
Show resolved Hide resolved
If there's other data the UI needs, we can add it alongside the `type` to the `data` field. Because there's only a single `ReplayVideo` sent with a single `ReplayRecording`, there's a one-to-one mapping without further details necessary in the actual RRWeb JSON.

Expand Down