Skip to content

octoprint.schema.config.webcam#

TimelapseConfig #

Bases: BaseModel

fps: int = 25 class-attribute #

The framerate at which to render the movie.

options: TimelapseOptions = TimelapseOptions() class-attribute #

Additional options depending on the timelapse type.

postRoll: int = 0 class-attribute #

The number of seconds in the rendered video to add after a finished print. The exact way how the additional images will be recorded depends on timelapse type. zchange timelapses will take one final picture and add it fps * postRoll times. timed timelapses continue to record just like at the beginning, so the recording will continue another fps * postRoll * interval seconds. This behaviour can be overridden by setting the capturePostRoll option to false, in which case the post roll will be created identically to zchange mode.

type: TimelapseTypeEnum = 'off' class-attribute #

The timelapse type.

TimelapseOptions #

Bases: BaseModel

capturePostRoll: Optional[bool] = None class-attribute #

timed timelapses only: Whether to capture the snapshots for the post roll (true) or just copy the last captured snapshot from the print over and over again (false).

interval: Optional[int] = None class-attribute #

timed timelapses only: The interval which to leave between images in seconds.

retractionZHop: Optional[float] = None class-attribute #

zchange timelapses only: z-hop height during retractions to ignore for capturing snapshots.

WebcamConfig #

Bases: BaseModel

bitrate: str = '10000k' class-attribute #

The bitrate to use for rendering the timelapse video. This gets directly passed to ffmpeg.

cleanTmpAfterDays: int = 7 class-attribute #

After how many days unrendered timelapses will be deleted.

ffmpeg: Optional[str] = None class-attribute #

Path to ffmpeg binary to use for creating timelapse recordings. Timelapse support will be disabled if not set.

ffmpegThreads: int = 1 class-attribute #

Number of how many threads to instruct ffmpeg to use for encoding.

ffmpegVideoCodec: str = 'libx264' class-attribute #

Videocodec to be used for encoding.

flipH: bool = False class-attribute #

Whether to flip the webcam horizontally.

flipV: bool = False class-attribute #

Whether to flip the webcam vertically.

rotate90: bool = False class-attribute #

Whether to rotate the webcam 90° counter clockwise.

timelapse: TimelapseConfig = TimelapseConfig() class-attribute #

The default timelapse settings.

timelapseEnabled: bool = True class-attribute #

Use this option to enable timelapse support via snapshot, e.g. via MJPG-Streamer. Timelapse support will be disabled if not set.

watermark: bool = True class-attribute #

Whether to include a "created with OctoPrint" watermark in the generated timelapse recordings.

webcamEnabled: bool = True class-attribute #

Use this option to enable display of a webcam stream in the UI, e.g. via MJPG-Streamer. Webcam support will be disabled if not set.

Back to top