"""
MIT License
Copyright (c) 2026-present SonoLink Development Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
from __future__ import annotations
from typing import Iterable
from sonolink.gateway.enums import AutoPlayMode, InactivityMode, SearchProvider
from .base import BaseSettings
from ..utils.snowflake import Snowflake
__all__ = (
"AutoPlaySettings",
"InactivitySettings",
"HistorySettings",
"CacheSettings",
)
[docs]
class AutoPlaySettings(BaseSettings):
"""
Configuration for the player's AutoPlay behavior.
Attributes
----------
mode: :class:`AutoPlayMode`
The default discovery mode when the player starts. Defaults to DISABLED.
max_seeds: :class:`int`
The maximum number of track identifiers to store to prevent duplicates.
Defaults to 100.
provider: :class:`SearchProvider` | :class:`str`
The provider used for discovery. Defaults to SearchProvider.YOUTUBE.
discovery_count: :class:`int`
The maximum number of discovered tracks to add to the queue at once.
Defaults to 10.
"""
__slots__ = (
"mode",
"max_seeds",
"provider",
"discovery_count",
)
def __init__(
self,
*,
mode: AutoPlayMode = AutoPlayMode.DISABLED,
max_seeds: int = 100,
provider: SearchProvider = SearchProvider.YOUTUBE,
discovery_count: int = 10,
) -> None:
self.mode: AutoPlayMode = mode
self.max_seeds: int = max_seeds
self.provider: SearchProvider = provider
self.discovery_count = discovery_count
[docs]
class InactivitySettings(BaseSettings):
"""
Configuration for player inactivity and auto-disconnection.
Attributes
----------
timeout: :class:`int` | :data:`None`
The time in seconds to wait before disconnecting. Defaults to 300.
mode: :class:`InactivityMode`
The strategy used to determine if the channel is "inactive".
user_ids: ``Iterable[Snowflake | int]``
An iterable of user IDs or Discord objects that act as "Keep Alive" members.
"""
__slots__ = (
"timeout",
"mode",
"user_ids",
)
def __init__(
self,
*,
timeout: int | None = 300,
mode: InactivityMode = InactivityMode.ALL_BOTS,
user_ids: Iterable[Snowflake | int] | None = None,
) -> None:
self.timeout: int | None = timeout
self.mode: InactivityMode = mode
self.user_ids: Iterable[Snowflake | int] = user_ids or []
[docs]
class HistorySettings(BaseSettings):
"""
Configuration for player history tracking.
Attributes
----------
enabled: :class:`bool`
Whether history tracking is enabled. Defaults to True.
max_items: :class:`int` | :data:`None`
The maximum number of items to keep in history.
"""
__slots__ = (
"enabled",
"max_items",
)
def __init__(
self,
*,
enabled: bool = True,
max_items: int | None = None,
) -> None:
self.enabled: bool = enabled
self.max_items: int | None = max_items
[docs]
class CacheSettings(BaseSettings):
"""
Configuration for node caching.
Attributes
----------
enabled: :class:`bool`
Whether caching is enabled. Defaults to True.
max_items: :class:`int` | :data:`None`
The maximum number of items to store in the LFU cache.
Defaults to 1000.
"""
__slots__ = (
"enabled",
"max_items",
)
def __init__(
self,
*,
enabled: bool = True,
max_items: int = 1000,
) -> None:
self.enabled: bool = enabled
self.max_items: int = max_items