CLASS v1.8.0

mixer.Audio

pykraken.mixer.Audio

Abstract base class for all audio resources.

More about mixer.Audio

Common interface for local volume and playback status. Local volume is multiplied by the mixer's master volume. Both default to 1.0.

Attributes

  • volume (float) — Local volume multiplier (0.0 to 1.0). Defaults to 1.0.
  • playing (bool) — (Read-only) Whether the audio is currently playing on any track.

Methods

play(fade_in=0.0): Start audio playback. stop(fade_out=0.0): Stop all instances of this audio resource.

Reference

PYTHON API
mixer.Audio(/, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

playing

property
playing: bool

True if currently playing.

volume

property
volume: float

Volume scalar (0.0 to 1.0).

play

method
play(self, fade_in: float = 0.0) -> None

Start audio playback.

Args

  • fade_in (float) — Fade in duration in seconds. Defaults to 0.0.

stop

method
stop(self, fade_out: float = 0.0) -> None

Stop all playing instances of this audio.

Args

  • fade_out (float) — Fade out duration in seconds. Defaults to 0.0.

Find your next step

Start typing to search the manual.