Video

module:

navground.sim.ui.video

Uses moviepy.

record_video(path: str | pathlib.Path, world: World, time_step: float, duration: float, factor: float = 1.0, fps: int = 30, follow: Agent | None = None, bounds: Rect | None = None, **kwargs: Any) → None

Record a video while performing a simulation.

Parameters:

• path – The path where to save the video. Should have a valid video format suffix supported by ffmpeg (e.g., .mp4) or .gif.

• world – The world to simulate

• time_step – The time step

• duration – The simulation duration

• factor – The real-time factor

• fps – The video fps

• follow – Optional agent to center the view on

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

Para bounds:

Optional view area (relative id follow is specified)

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.

record_video_from_run(path: str | pathlib.Path, run: RecordedExperimentalRun | ExperimentalRun, factor: float = 1.0, fps: int = 30, follow: Agent | None = None, bounds: Rect | None = None, from_time: float = 0, to_time: float | None = None, **kwargs: Any) → None

Create a video from a recorded simulation.

Parameters:

• path – The path where to save the video. Should have a valid video format suffix supported by ffmpeg (e.g., .mp4) or .gif.

• run – The recorded run

• factor – The real-time factor

• fps – The video fps

• follow – Optional agent to center the view on

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

Para bounds:

Optional view area (relative id follow is specified)

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.

display_video(world: World, time_step: float, duration: float, factor: float = 1.0, fps: int = 30, display_width: int = 640, follow: Agent | None = None, bounds: Rect | None = None, **kwargs: Any) → Any

Perform a simulation and displays the recorded video in a notebook

Parameters:

• world – The world to simulate

• time_step – The time step

• duration – The simulation duration

• factor – The real-time factor

• fps – The video fps

• display_width – The size of the video view

• follow – Optional agent to center the view on

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

Para bounds:

Optional view area (relative id follow is specified)

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.

display_video_from_run(run: RecordedExperimentalRun | ExperimentalRun, factor: float = 1.0, fps: int = 30, display_width: int = 640, follow: Agent | None = None, bounds: Rect | None = None, from_time: float = 0, to_time: float | None = None, **kwargs: Any) → Any

Displays a video created from a recorded simulation in a notebook

Parameters:

• run – The recorded run

• factor – The real-time factor

• fps – The video fps

• display_width – The size of the video view

• follow – Optional agent to center the view on

• kwargs – Optional configuration: same fields as navground.sim.ui.RenderConfig.

Para bounds:

Optional view area (relative id follow is specified)

The actual configuration is computed by looking (in order) to

1. the arguments of this function;

2. the world-specific configuration navground.sim.World.render_kwargs;

3. the default configuration navground.sim.ui.render_default_config.