engines.sound module

Provides access to the Sound and StreamSound interfaces.

class engines.sound.Attenuation(*values)[source]

Bases: float, Enum

Attenuation values wrapper enumerator.

GUNFIRE = 0.27000001072883606
IDLE = 2.0
MAXIMUM = 3.9800000190734863
NONE = 0.0
NORMAL = 0.800000011920929
RICOCHET = 1.5
STATIC = 1.25
class engines.sound.Channel

Bases: enum

AUTO = _engines._sound.Channel.AUTO
BODY = _engines._sound.Channel.BODY
ITEM = _engines._sound.Channel.ITEM
REPLACE = _engines._sound.Channel.REPLACE
STATIC = _engines._sound.Channel.STATIC
STREAM = _engines._sound.Channel.STREAM
USER_BASE = _engines._sound.Channel.USER_BASE
VOICE = _engines._sound.Channel.VOICE
VOICE_BASE = _engines._sound.Channel.VOICE_BASE
WEAPON = _engines._sound.Channel.WEAPON
names = {'AUTO': _engines._sound.Channel.AUTO, 'BODY': _engines._sound.Channel.BODY, 'ITEM': _engines._sound.Channel.ITEM, 'REPLACE': _engines._sound.Channel.REPLACE, 'STATIC': _engines._sound.Channel.STATIC, 'STREAM': _engines._sound.Channel.STREAM, 'USER_BASE': _engines._sound.Channel.USER_BASE, 'VOICE': _engines._sound.Channel.VOICE, 'VOICE_BASE': _engines._sound.Channel.VOICE_BASE, 'WEAPON': _engines._sound.Channel.WEAPON}
values = {-1: _engines._sound.Channel.REPLACE, 0: _engines._sound.Channel.AUTO, 1: _engines._sound.Channel.WEAPON, 2: _engines._sound.Channel.VOICE, 3: _engines._sound.Channel.ITEM, 4: _engines._sound.Channel.BODY, 5: _engines._sound.Channel.STREAM, 6: _engines._sound.Channel.STATIC, 8: _engines._sound.Channel.VOICE_BASE, 136: _engines._sound.Channel.USER_BASE}
class engines.sound.Pitch

Bases: enum

HIGH = _engines._sound.Pitch.HIGH
LOW = _engines._sound.Pitch.LOW
NORMAL = _engines._sound.Pitch.NORMAL
names = {'HIGH': _engines._sound.Pitch.HIGH, 'LOW': _engines._sound.Pitch.LOW, 'NORMAL': _engines._sound.Pitch.NORMAL}
values = {95: _engines._sound.Pitch.LOW, 100: _engines._sound.Pitch.NORMAL, 120: _engines._sound.Pitch.HIGH}
class engines.sound.Sound(*args, **kwargs)[source]

Bases: _BaseSound

Class used to interact with precached sounds.

Note

On some engines (e.g. CS:GO) server is unable to precache the sound, thus the sound won’t be played. StreamSound is recommended in that case. However, sounds located in sound/music/ directory are always streamed on those engines, and this class will be able to play them.

precache()[source]

Precache the sample.

property is_precached

Return whether or not the sample is precached.

Return type:

bool

class engines.sound.SoundFlags

Bases: enum

CHANGE_PITCH = _engines._sound.SoundFlags.CHANGE_PITCH
CHANGE_VOL = _engines._sound.SoundFlags.CHANGE_VOL
DELAY = _engines._sound.SoundFlags.DELAY
IGNORE_NAME = _engines._sound.SoundFlags.IGNORE_NAME
IGNORE_PHONEMES = _engines._sound.SoundFlags.IGNORE_PHONEMES
NO_FLAGS = _engines._sound.SoundFlags.NO_FLAGS
SHOULD_PAUSE = _engines._sound.SoundFlags.SHOULD_PAUSE
SPAWNING = _engines._sound.SoundFlags.SPAWNING
SPEAKER = _engines._sound.SoundFlags.SPEAKER
STOP = _engines._sound.SoundFlags.STOP
STOP_LOOPING = _engines._sound.SoundFlags.STOP_LOOPING
names = {'CHANGE_PITCH': _engines._sound.SoundFlags.CHANGE_PITCH, 'CHANGE_VOL': _engines._sound.SoundFlags.CHANGE_VOL, 'DELAY': _engines._sound.SoundFlags.DELAY, 'IGNORE_NAME': _engines._sound.SoundFlags.IGNORE_NAME, 'IGNORE_PHONEMES': _engines._sound.SoundFlags.IGNORE_PHONEMES, 'NO_FLAGS': _engines._sound.SoundFlags.NO_FLAGS, 'SHOULD_PAUSE': _engines._sound.SoundFlags.SHOULD_PAUSE, 'SPAWNING': _engines._sound.SoundFlags.SPAWNING, 'SPEAKER': _engines._sound.SoundFlags.SPEAKER, 'STOP': _engines._sound.SoundFlags.STOP, 'STOP_LOOPING': _engines._sound.SoundFlags.STOP_LOOPING}
values = {0: _engines._sound.SoundFlags.NO_FLAGS, 1: _engines._sound.SoundFlags.CHANGE_VOL, 2: _engines._sound.SoundFlags.CHANGE_PITCH, 4: _engines._sound.SoundFlags.STOP, 8: _engines._sound.SoundFlags.SPAWNING, 16: _engines._sound.SoundFlags.DELAY, 32: _engines._sound.SoundFlags.STOP_LOOPING, 64: _engines._sound.SoundFlags.SPEAKER, 128: _engines._sound.SoundFlags.SHOULD_PAUSE, 256: _engines._sound.SoundFlags.IGNORE_PHONEMES, 512: _engines._sound.SoundFlags.IGNORE_NAME}
class engines.sound.StreamSound(*args, **kwargs)[source]

Bases: _BaseSound

Class used to interact with streamed sounds.

Note

This class is a recommended choice on some engines (e.g. CS:GO), however, it’s unable to play *.wav-files.

Note

On some engines (e.g. CS:GO) files that are located in sound/music/ directory are already streamed, so simple Sound class can be used instead.

precache()[source]

Precache the sample.

property is_precached

Return whether or not the sample is precached.

Return type:

bool