from __future__ import annotations
from abc import ABCMeta, abstractmethod
from dataclasses import dataclass, field
from typing import Any
from ..utils.time import Time
from .interface import Interface
[docs]
@dataclass
class WindowState:
x: int
y: int
width: int
height: int
time: Time = field(default_factory=Time.now)
[docs]
@dataclass
class WindowCapabilities:
full_frame_x: int = 0
full_frame_y: int = 0
full_frame_width: int = 0
full_frame_height: int = 0
class IWindow(Interface, metaclass=ABCMeta):
"""The camera supports windows, to be used together with :class:`~pyobs.interfaces.ICamera`."""
__module__ = "pyobs.interfaces"
state = WindowState
capabilities = WindowCapabilities
[docs]
@abstractmethod
async def set_window(self, left: int, top: int, width: int, height: int, **kwargs: Any) -> None:
"""Set the camera window.
Args:
left: X offset of window.
top: Y offset of window.
width: Width of window.
height: Height of window.
Raises:
ValueError: If window could not be set.
"""
...
__all__ = ["IWindow", "WindowState", "WindowCapabilities"]