rusty_desktop_icons.TimelineSession¶

class rusty_desktop_icons.TimelineSession¶

Persistent, seekable playback opened by PreparedAnimation.open_timeline.

Reaching an endpoint pauses without closing the overlay. Use as a context manager to restore original icon positions on exit, including exceptions.

capture() → CapturedFrame¶: Capture the last submitted overlay frame, without changing playback.

close(mode: TimelineCloseMode | None = None) → FinishReason¶: Close the overlay, restoring original positions unless another mode is given.

final_commit() → FinalCommitOutcome | None¶

finish_reason() → FinishReason | None¶

missing_icons() → list[str]¶

pause() → None¶

play_to(position: float, speed: float = 1.0) → PlaybackHandle¶: Play toward a normalized position in [0, 1] at a positive finite speed.

position() → float¶

real_icons_visible() → bool¶

seek(position: float) → None¶: Pause and show the requested normalized position in [0, 1].

seek_and_capture(position: float) → CapturedFrame¶: Pause, seek and capture as one worker operation. Position is normalized.

set_real_icons_visible(visible: bool) → None¶

set_speed(speed: float) → None¶

snapshot() → list[IconAnimationState]¶

speed() → float¶

state() → TimelineState¶