Skip to content

WebcamsNamespace

pymoonraker.api.WebcamsNamespace

Webcam configuration.

Auto-generated from schema/moonraker_api.yaml.

Source code in src/pymoonraker/api/_generated.py
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
class WebcamsNamespace:
    """Webcam configuration.

    Auto-generated from schema/moonraker_api.yaml.
    """

    def __init__(self, client: MoonrakerClient) -> None:
        self._client = client

    async def list(self) -> WebcamsListResponse:
        """List configured webcams."""
        raw = await self._client.call("server.webcams.list")
        return WebcamsListResponse.model_validate(raw)

    async def get(self, name: str) -> WebcamGetResponse:
        """Get a single webcam configuration.

        Args:
            name: Webcam name

        """
        params: dict[str, Any] = {}
        params["name"] = name
        raw = await self._client.call("server.webcams.get_item", params)
        return WebcamGetResponse.model_validate(raw)

get async

get(name: str) -> WebcamGetResponse

Get a single webcam configuration.

Parameters:

Name Type Description Default
name str

Webcam name

required
Source code in src/pymoonraker/api/_generated.py
774
775
776
777
778
779
780
781
782
783
784
async def get(self, name: str) -> WebcamGetResponse:
    """Get a single webcam configuration.

    Args:
        name: Webcam name

    """
    params: dict[str, Any] = {}
    params["name"] = name
    raw = await self._client.call("server.webcams.get_item", params)
    return WebcamGetResponse.model_validate(raw)

list async

list() -> WebcamsListResponse

List configured webcams.

Source code in src/pymoonraker/api/_generated.py
769
770
771
772
async def list(self) -> WebcamsListResponse:
    """List configured webcams."""
    raw = await self._client.call("server.webcams.list")
    return WebcamsListResponse.model_validate(raw)