Files
2026-11-04 21:01:26 +01:00

114 lines
3.4 KiB
Python

import sys
from typing import Any, Literal, overload
from pygame.typing import FileLike
from typing_extensions import (
Buffer, # collections.abc 3.12
Self,
deprecated, # added in 3.13
)
from . import mixer_music
# export mixer_music as mixer.music
music = mixer_music
def init(
frequency: int = 44100,
size: int = -16,
channels: int = 2,
buffer: int = 512,
devicename: str | None = None,
allowedchanges: int = 5,
) -> None: ...
def pre_init(
frequency: int = 44100,
size: int = -16,
channels: int = 2,
buffer: int = 512,
devicename: str | None = None,
allowedchanges: int = 5,
) -> None: ...
def quit() -> None: ...
def get_init() -> tuple[int, int, int] | None: ...
def get_driver() -> str: ...
def stop() -> None: ...
def pause() -> None: ...
def unpause() -> None: ...
def fadeout(time: int, /) -> None: ...
def set_num_channels(count: int, /) -> None: ...
def get_num_channels() -> int: ...
def set_reserved(count: int, /) -> int: ...
@overload
def find_channel(force: Literal[True]) -> Channel: ...
@overload
def find_channel(force: bool = False) -> Channel | None: ...
def set_soundfont(paths: str | None = None, /) -> None: ...
def get_soundfont() -> str | None: ...
def get_busy() -> bool: ...
def get_sdl_mixer_version(linked: bool = True) -> tuple[int, int, int]: ...
class Sound:
@overload
def __init__(self, file: FileLike) -> None: ...
@overload
def __init__(self, buffer: Buffer) -> None: ...
def play(
self,
loops: int = 0,
maxtime: int = 0,
fade_ms: int = 0,
) -> Channel: ...
# possibly going to be deprecated/removed soon, in which case these
# typestubs must be removed too
@property
def __array_interface__(self) -> dict[str, Any]: ...
@property
def __array_struct__(self) -> Any: ...
if sys.version_info >= (3, 12):
def __buffer__(self, flags: int, /) -> memoryview[int]: ...
def __release_buffer__(self, view: memoryview[int], /) -> None: ...
def stop(self) -> None: ...
def fadeout(self, time: int, /) -> None: ...
def set_volume(self, value: float, /) -> None: ...
def get_volume(self) -> float: ...
def get_num_channels(self) -> int: ...
def get_length(self) -> float: ...
def get_raw(self) -> bytes: ...
def copy(self) -> Self: ...
def __copy__(self) -> Self: ...
class Channel:
def __init__(self, id: int) -> None: ...
@property
def id(self) -> int: ...
def play(
self,
sound: Sound,
loops: int = 0,
maxtime: int = 0,
fade_ms: int = 0,
) -> None: ...
def stop(self) -> None: ...
def pause(self) -> None: ...
def unpause(self) -> None: ...
def fadeout(self, time: int, /) -> None: ...
def queue(self, sound: Sound, /) -> None: ...
def set_source_location(self, angle: float, distance: float, /) -> None: ...
@overload
def set_volume(self, value: float, /) -> None: ...
@overload
def set_volume(self, left: float, right: float, /) -> None: ...
def get_volume(self) -> float: ...
def get_busy(self) -> bool: ...
def get_sound(self) -> Sound | None: ...
def get_queue(self) -> Sound | None: ...
def set_endevent(self, type: int = 0, /) -> None: ...
def get_endevent(self) -> int: ...
@deprecated("Use `Sound` instead (SoundType is an old alias)")
class SoundType(Sound): ...
@deprecated("Use `Channel` instead (ChannelType is an old alias)")
class ChannelType(Channel): ...