Skip to content

Media Library Scanning

MediaLibraryScanning(api, subsonic)

Class that contains all the methods needed to interact with the media library scanning endpoints in the Subsonic API.

Source code in .venv/lib/python3.11/site-packages/knuckles/_media_library_scanning.py 
17
18
19
20
21
def __init__(self, api: Api, subsonic: "Subsonic") -> None:
    self.api = api

    # Only to pass it to the models
    self.subsonic = subsonic

get_scan_status()

Get the status of the scanning of the library.

Returns:

Type Description
ScanStatus

An object that holds all the info about the current state of the scanning of the library.
Source code in .venv/lib/python3.11/site-packages/knuckles/_media_library_scanning.py 
23
24
25
26
27
28
29
30
31
32
33
def get_scan_status(self) -> ScanStatus:
    """Get the status of the scanning of the library.

    Returns:
        An object that holds all the info about the
            current state of the scanning of the library.
    """

    response = self.api.json_request("getScanStatus")["scanStatus"]

    return ScanStatus(self.subsonic, **response)

start_scan()

Request to the server to start a scanning of the library.

Returns:

Type Description
ScanStatus

An object that holds all the info about the current state of the scanning of the library.
Source code in .venv/lib/python3.11/site-packages/knuckles/_media_library_scanning.py 
35
36
37
38
39
40
41
42
43
44
45
def start_scan(self) -> ScanStatus:
    """Request to the server to start a scanning of the library.

    Returns:
        An object that holds all the info about the
            current state of the scanning of the library.
    """

    response = self.api.json_request("startScan")["scanStatus"]

    return ScanStatus(self.subsonic, **response)