Server settings

This class is accessed via the settings property on a CamillaClient instance.

It provides methods for reading and writing settings of the websocket server.

class: Settings

Bases: _CommandGroup

Methods for various settings

Source code in camilladsp\settings.py

class Settings(_CommandGroup):
    """
    Methods for various settings
    """

    def update_interval(self) -> int:
        """
        Get current update interval in ms.

        Returns:
            int: Current update interval.
        """
        interval = self.client.query("GetUpdateInterval")
        return int(interval)

    def set_update_interval(self, value: int):
        """
        Set current update interval in ms.

        Args:
            value (int): New update interval.
        """
        self.client.query("SetUpdateInterval", arg=value)

set_update_interval(value)

Set current update interval in ms.

Parameters:

Name	Type	Description	Default
value	int	New update interval.	required

Source code in camilladsp\settings.py

def set_update_interval(self, value: int):
    """
    Set current update interval in ms.

    Args:
        value (int): New update interval.
    """
    self.client.query("SetUpdateInterval", arg=value)

update_interval()

Get current update interval in ms.

Returns:

Name	Type	Description
int	int	Current update interval.

Source code in camilladsp\settings.py

def update_interval(self) -> int:
    """
    Get current update interval in ms.

    Returns:
        int: Current update interval.
    """
    interval = self.client.query("GetUpdateInterval")
    return int(interval)