Skip to content

docs(android): Document SurfaceView capture option for Session Replay#17664

Merged
romtsn merged 1 commit intomasterfrom
rz/docs/replay-surface-view-capture
May 7, 2026
Merged

docs(android): Document SurfaceView capture option for Session Replay#17664
romtsn merged 1 commit intomasterfrom
rz/docs/replay-surface-view-capture

Conversation

@romtsn
Copy link
Copy Markdown
Member

@romtsn romtsn commented May 7, 2026

Documents the new experimental captureSurfaceViews option added in getsentry/sentry-java#5333.

  • Added captureSurfaceViews row to the configuration options table in configuration.mdx
  • Added a "SurfaceView Capture" section to the main Session Replay page (index.mdx) with explanation, masking warning, and Kotlin + manifest XML examples
  • Notes that the option only works with the PixelCopy strategy (default) and is experimental

🤖 Generated with Claude Code

…ession Replay

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 7, 2026 8:59am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 7, 2026 8:59am

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team May 7, 2026 08:49
@romtsn romtsn enabled auto-merge (squash) May 7, 2026 08:50
Copy link
Copy Markdown
Member

@markushi markushi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!


## SurfaceView Capture

By default, Android `SurfaceView` components (used by Unity, video players, map SDKs, and other frameworks that render outside the normal View hierarchy) appear as black or transparent regions in session replays. This happens because `SurfaceView` renders to its own surface, which is composited by SurfaceFlinger independently from the Window and is not captured by the standard PixelCopy window capture.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default, Android `SurfaceView` components (used by Unity, video players, map SDKs, and other frameworks that render outside the normal View hierarchy) appear as black or transparent regions in session replays. This happens because `SurfaceView` renders to its own surface, which is composited by SurfaceFlinger independently from the Window and is not captured by the standard PixelCopy window capture.
By default, Android `SurfaceView` components (used by Unity, video players, map SDKs, and other frameworks that render outside the normal View hierarchy) appear as black or transparent regions in session replays. This happens because `SurfaceView` renders to its own surface, which is composited by SurfaceFlinger independently from the Window and is not captured by the standard `PixelCopy` window capture.

@romtsn romtsn merged commit 857a80a into master May 7, 2026
18 checks passed
@romtsn romtsn deleted the rz/docs/replay-surface-view-capture branch May 7, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants