Skip to content

Status commands

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

It provides methods for reading various status parameters.

class: Status

Bases: _CommandGroup

Collection of methods for reading status

Source code in camilladsp\status.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class Status(_CommandGroup):
    """
    Collection of methods for reading status
    """

    def rate_adjust(self) -> float:
        """
        Get current value for rate adjust, 1.0 means 1:1 resampling.

        Returns:
            float: Rate adjust value.
        """
        adj = self.client.query("GetRateAdjust")
        return float(adj)

    def buffer_level(self) -> int:
        """
        Get current buffer level of the playback device.

        Returns:
            int: Buffer level in frames.
        """
        level = self.client.query("GetBufferLevel")
        return int(level)

    def clipped_samples(self) -> int:
        """
        Get number of clipped samples since the config was loaded.

        Returns:
            int: Number of clipped samples.
        """
        clipped = self.client.query("GetClippedSamples")
        return int(clipped)

    def processing_load(self) -> float:
        """
        Get processing load in percent.

        Returns:
            float: Current load.
        """
        load = self.client.query("GetProcessingLoad")
        return float(load)

buffer_level()

Get current buffer level of the playback device.

Returns:

Name Type Description
int int

Buffer level in frames.
Source code in camilladsp\status.py 
25
26
27
28
29
30
31
32
33
def buffer_level(self) -> int:
    """
    Get current buffer level of the playback device.

    Returns:
        int: Buffer level in frames.
    """
    level = self.client.query("GetBufferLevel")
    return int(level)

clipped_samples()

Get number of clipped samples since the config was loaded.

Returns:

Name Type Description
int int

Number of clipped samples.
Source code in camilladsp\status.py 
35
36
37
38
39
40
41
42
43
def clipped_samples(self) -> int:
    """
    Get number of clipped samples since the config was loaded.

    Returns:
        int: Number of clipped samples.
    """
    clipped = self.client.query("GetClippedSamples")
    return int(clipped)

processing_load()

Get processing load in percent.

Returns:

Name Type Description
float float

Current load.
Source code in camilladsp\status.py 
45
46
47
48
49
50
51
52
53
def processing_load(self) -> float:
    """
    Get processing load in percent.

    Returns:
        float: Current load.
    """
    load = self.client.query("GetProcessingLoad")
    return float(load)

rate_adjust()

Get current value for rate adjust, 1.0 means 1:1 resampling.

Returns:

Name Type Description
float float

Rate adjust value.
Source code in camilladsp\status.py 
15
16
17
18
19
20
21
22
23
def rate_adjust(self) -> float:
    """
    Get current value for rate adjust, 1.0 means 1:1 resampling.

    Returns:
        float: Rate adjust value.
    """
    adj = self.client.query("GetRateAdjust")
    return float(adj)