mxvk_wrap.media.Sound Class Reference

Public Member Functions
None	__init__ (self)
	Optional WAV and music playback helper.
None	close (self)
int	load_wav (self, str|Path path)
int	play (self, int sound_id, int loops=0)

Public Attributes
	native = mxvk.Mixer()
	Initialize the audio mixer.

Detailed Description

Definition at line 32 of file media.py.

Constructor & Destructor Documentation

__init__()

None mxvk_wrap.media.Sound.__init__

(

self

)

Optional WAV and music playback helper.

Definition at line 35 of file media.py.

    def __init__(self) -> None:
        ## @brief Initialize the audio mixer.
        if not getattr(mxvk, "has_mixer", False):
            raise RuntimeError("MXVK was built without MIXER support")
        self.native = mxvk.Mixer()
        self.native.init()
 

Member Function Documentation

close()

None mxvk_wrap.media.Sound.close

(

self

)

Definition at line 50 of file media.py.

    def close(self) -> None:
        ## @brief Release mixer resources.
        if self.native is not None:
            self.native.cleanup()
            self.native = None
 
 

load_wav()

int mxvk_wrap.media.Sound.load_wav	(		self,
		str | Path	path )

Definition at line 42 of file media.py.

    def load_wav(self, path: str | Path) -> int:
        ## @brief Load a WAV file and return its playback ID.
        return self.native.load_wav(str(path))
 

play()

int mxvk_wrap.media.Sound.play	(		self,
		int	sound_id,
		int	loops = 0 )

Definition at line 46 of file media.py.

    def play(self, sound_id: int, loops: int = 0) -> int:
        ## @brief Play a loaded WAV and return its mixer channel.
        return self.native.play_wav(sound_id, loops)
 

Member Data Documentation

native

mxvk_wrap.media.Sound.native = mxvk.Mixer()

Initialize the audio mixer.

Definition at line 39 of file media.py.

---

The documentation for this class was generated from the following file:

• python-examples/mxvk_wrap/media.py