Class RecordVideoOptions
The keyword arguments of RecordVideo<TObs, TAct>'s constructor as a typed record (DR-34), generated
from the constructor so it cannot drift from it. A property that is set becomes a keyword argument by its Python
name; one left unset is not passed, so make keeps the registered spec's value and the constructor its default.
public sealed record RecordVideoOptions : IGymOptions, IEquatable<RecordVideoOptions>
- Inheritance
-
RecordVideoOptions
- Implements
- Inherited Members
- Extension Methods
Properties
DisableLogger
moviepy's logger switch, kept for Gymnasium's signature.
The disable_logger keyword argument, passed on only once set.
public bool DisableLogger { get; init; }
Property Value
EpisodeTrigger
Whether to start recording at an episode (by number from 0); with no trigger at all, CappedCubicVideoSchedule(long).
The episode_trigger keyword argument, passed on only once set.
public Func<long, bool>? EpisodeTrigger { get; init; }
Property Value
Fps
The frame rate; null takes metadata["render_fps"], else 30.
The fps keyword argument, passed on only once set.
public double? Fps { get; init; }
Property Value
GcTrigger
Whether to collect garbage after a video of an episode; null always does.
The gc_trigger keyword argument, passed on only once set.
public Func<long, bool>? GcTrigger { get; init; }
Property Value
NamePrefix
The prefix of the video names.
The name_prefix keyword argument, passed on only once set.
public string NamePrefix { get; init; }
Property Value
StepTrigger
Whether to start recording at a step (counted across episodes from 0).
The step_trigger keyword argument, passed on only once set.
public Func<long, bool>? StepTrigger { get; init; }
Property Value
VideoFolder
The folder of the videos, created if needed (a warning when it exists).
The video_folder keyword argument, passed on only once set.
public string VideoFolder { get; init; }
Property Value
VideoLength
The frames per video; 0 records whole episodes.
The video_length keyword argument, passed on only once set.
public long VideoLength { get; init; }
Property Value
VideoWriter
The encoder; null for PngVideoWriter.
The video_writer keyword argument, passed on only once set.
public IVideoWriter? VideoWriter { get; init; }
Property Value
Methods
ToKwargs()
The set properties as keyword arguments by Python name, in constructor order.
public Info ToKwargs()
Returns
- Info
A new dict the caller owns.