Struct PlaybackState

Struct Documentation

struct PlaybackState

The state of the server playing back data.

Should be sent in response to a PlaybackControlRequest, or any time the state of playback has changed; for example, reaching the end of data, or an external mechanism causes playback to pause.

Only relevant if the PlaybackControl capability is enabled.

Public Members

PlaybackStatus status

The status of server data playback.

uint64_t current_time

The current time of playback, in absolute nanoseconds.

float playback_speed

The speed of playback, as a factor of realtime.

bool did_seek

Whether a seek forward or backward in time triggered this message to be emitted.

std::optional<std::string> request_id

If this message is being emitted in response to a PlaybackControlRequest message, the request_id from that message. Set this to std::nullopt if the state of playback has been changed by any other condition.