mixer.Sample
pykraken.mixer.Sample A sound effect sample loaded entirely into memory.
More about mixer.Sample
Samples support polyphony (multiple simultaneous instances). If tracks are full, samples attempt to steal tracks from lower-priority or older sounds.
Attributes
- priority (
AudioPriority) — Acquisition priority level. Defaults to SFX. - can_steal (
bool) — Whether this sound can interrupt others to acquire a track. Defaults to True. - max_polyphony (
int) — Maximum simultaneous instances of this specific sample (Range 1-32). Defaults to 1.
Inherits Audio
At a glance
8 membersReference
PYTHON APIConstructor
methodmixer.Sample(/, *args, **kwargs)Initialize self. See help(type(self)) for accurate signature.
can_steal
propertycan_steal: boolWhether can interrupt others to acquire a track.
max_polyphony
propertymax_polyphony: intMax simultaneous instances of sample (1-32).
playing
propertyplaying: boolTrue if currently playing.
priority
propertypriority: mixer.AudioPriorityAcquisition priority level.
volume
propertyvolume: floatVolume scalar (0.0 to 1.0).
play
methodplay(self, fade_in: float = 0.0) -> NoneStart audio playback.
Args
- fade_in (
float) — Fade in duration in seconds. Defaults to 0.0.
stop
methodstop(self, fade_out: float = 0.0) -> NoneStop all playing instances of this audio.
Args
- fade_out (
float) — Fade out duration in seconds. Defaults to 0.0.