README

rosbag2_interfaces

This file is ai generated. Do not edit this file directly. Instead, edit the package files and run the update-readme command to update this file.

Description

Interface definitions for controlling rosbag2

This package defines ROS2 service and message interfaces for programmatic control of rosbag2 recording and playback. It enables external nodes to start/stop recording, control playback (play, pause, seek, rate control), and receive notifications about bag events.

Maintainers

Michael Orlov (michael.orlov@apex.ai)
Geoffrey Biggs (geoff@openrobotics.org)
Michel Hidalgo (michel@ekumenlabs.com)
Emerson Knapp (me@emersonknapp.com)
ROS Tooling Working Group (ros-tooling@googlegroups.com)

License

Apache License 2.0

Services

Burst.srv

Service for triggering burst recording mode.

GetRate.srv

Service for querying the current playback rate.

IsPaused.srv

Service for checking if playback is currently paused.

IsDiscoveryRunning.srv

Service for checking if topic discovery is running.

Pause.srv

Service for pausing bag playback.

Play.srv

Service for starting bag playback with specified parameters.

PlayNext.srv

Service for advancing playback to the next message.

Record.srv

Service for starting bag recording.

Resume.srv

Service for resuming paused playback.

Seek.srv

Service for seeking to a specific time in the bag.

SetRate.srv

Service for setting the playback rate (speed multiplier).

Snapshot.srv

Service for triggering a snapshot recording.

SplitBagfile.srv

Service for manually triggering a bag file split.

StartDiscovery.srv

Service for starting topic discovery.

Stop.srv

Service for stopping recording or playback.

StopDiscovery.srv

Service for stopping topic discovery.

TogglePaused.srv

Service for toggling between paused and playing states.

Messages

MessagesLostEventTopicStat.msg

Message containing statistics about lost messages for a specific topic.

ReadSplitEvent.msg

Event message published when reading switches to a new split bag file.

WriteSplitEvent.msg

Event message published when writing creates a new split bag file.