octoprint.schema.webcam#
Webcam
#
Bases: BaseModel
canSnapshot: bool = False
class-attribute
instance-attribute
#
Whether this webcam can take a snapshot.
compat: Optional[WebcamCompatibility] = None
class-attribute
instance-attribute
#
A compatibility configuration to allow older clients to make use of this webcam
displayName: str
instance-attribute
#
Displayable name for this webcam
extras: dict = {}
class-attribute
instance-attribute
#
Unstructured data describing this webcam
flipH: bool = False
class-attribute
instance-attribute
#
Whether to flip the webcam horizontally.
flipV: bool = False
class-attribute
instance-attribute
#
Whether to flip the webcam vertically.
name: str
instance-attribute
#
Identifier of this webcam
rotate90: bool = False
class-attribute
instance-attribute
#
Whether to rotate the webcam 90° counter clockwise.
snapshotDisplay: str = None
class-attribute
instance-attribute
#
Human readable information about how a snapshot is captured or a HTTP URL from which the snapshot is loaded (optional, only for user reference)
WebcamCompatibility
#
Bases: BaseModel
cacheBuster: bool = False
class-attribute
instance-attribute
#
Whether the the URL should be randomized to bust caches
snapshot: str = None
class-attribute
instance-attribute
#
The URL to get the snapshot from
snapshotSslValidation: bool = True
class-attribute
instance-attribute
#
Whether to validate SSL certificates when retrieving a snapshot
snapshotTimeout: int = 5
class-attribute
instance-attribute
#
The timeout when retrieving snapshots
stream: str
instance-attribute
#
The URL to get an MJPEG stream from
streamRatio: RatioEnum = RatioEnum.sixteen_nine
class-attribute
instance-attribute
#
The stream's native aspect ratio
streamTimeout: int = 5
class-attribute
instance-attribute
#
The timeout of the stream in seconds
streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302']
class-attribute
instance-attribute
#
The WebRTC STUN and TURN servers