Skip to content

Update docs for Session Replay start/stop/pause/resume APIs #5932

Description

@linear-code

Goal

Document the new public Session Replay APIs for Android, matching the existing JavaScript Session Replay docs.

What to document

  • Sentry.replay().start() — starts a session-mode replay
  • Sentry.replay().startBuffering() — starts a buffer-mode replay (rolling window, flushed on error or manual flush())
  • Sentry.replay().stop() — stops recording, stop()start() begins a new session
  • Sentry.replay().pause() — pauses recording, blocks auto-resume until resume() is called
  • Sentry.replay().resume() — resumes a paused recording
  • Sentry.replay().flush() — flushes the buffer and sends it
  • Setting both sample rates to 0 and calling start() / startBuffering() manually
  • All methods are safe to call from any thread

Where

Prerequisites

  • JAVA-325 (public API) must be merged first

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions