Skip to content

Commit 310813b

Browse files
authored
Update SDL_mixer bindings to 2.6.0 (#237)
* Update mixer bindings to 2.6.0 * Add some new docstrings * Overhaul and expand mixer unit tests * Expand the mixer docs some more * More docs updates
1 parent 588e74a commit 310813b

File tree

5 files changed

+821
-156
lines changed

5 files changed

+821
-156
lines changed

doc/modules/sdl2_sdlmixer.rst

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ corresponding functions. All other audio playback is performed using
2929
can be used in the meantime to fill in any gaps.
3030

3131
The official documentation for the SDL_mixer library can be found `here
32-
<http://www.libsdl.org/projects/SDL_mixer/docs/index.html>`_. Note that
33-
not all functions may be documented, as the official doucmentation is
34-
currently several releases out-of-date.
32+
<https://wiki.libsdl.org/SDL_mixer/FrontPage>`_.
3533

3634

3735
Main data types
@@ -123,9 +121,25 @@ Decoder availability & info functions
123121

124122
.. autofunction:: Mix_GetMusicDecoder
125123

124+
.. autofunction:: Mix_HasMusicDecoder
125+
126126
.. autofunction:: Mix_GetMusicType
127127

128128

129+
Music metadata functions
130+
------------------------
131+
132+
.. autofunction:: Mix_GetMusicTitle
133+
134+
.. autofunction:: Mix_GetMusicTitleTag
135+
136+
.. autofunction:: Mix_GetMusicArtistTag
137+
138+
.. autofunction:: Mix_GetMusicAlbumTag
139+
140+
.. autofunction:: Mix_GetMusicCopyrightTag
141+
142+
129143
Channel functions
130144
-----------------
131145

@@ -201,6 +215,8 @@ Music playback
201215

202216
.. autofunction:: Mix_RewindMusic
203217

218+
.. autofunction:: Mix_ModMusicJumpToOrder
219+
204220
.. autofunction:: Mix_SetMusicPosition
205221

206222
.. autofunction:: Mix_HaltMusic
@@ -219,6 +235,10 @@ Volume functions
219235

220236
.. autofunction:: Mix_VolumeMusic
221237

238+
.. autofunction:: Mix_GetMusicVolume
239+
240+
.. autofunction:: Mix_MasterVolume
241+
222242

223243
Playback status functions
224244
-------------------------
@@ -237,6 +257,16 @@ Playback status functions
237257

238258
.. autofunction:: Mix_FadingMusic
239259

260+
.. autofunction:: Mix_GetMusicPosition
261+
262+
.. autofunction:: Mix_MusicDuration
263+
264+
.. autofunction:: Mix_GetMusicLoopStartTime
265+
266+
.. autofunction:: Mix_GetMusicLoopEndTime
267+
268+
.. autofunction:: Mix_GetMusicLoopLengthTime
269+
240270

241271
Effects-processing functions
242272
----------------------------
@@ -279,12 +309,15 @@ MikMod configuration functions
279309
.. autofunction:: Mix_GetSynchroValue
280310

281311

282-
MIDI SoundFont functions
283-
^^^^^^^^^^^^^^^^^^^^^^^^
312+
MIDI configuration functions
313+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
284314

285315
.. autofunction:: Mix_SetSoundFonts
286316

287317
.. autofunction:: Mix_GetSoundFonts
288318

289319
.. autofunction:: Mix_EachSoundFont
290320

321+
.. autofunction:: Mix_SetTimidityCfg
322+
323+
.. autofunction:: Mix_GetTimidityCfg

doc/news.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This describes the latest changes between the PySDL2 releases.
88
New Features:
99

1010
* Updated to wrap new functions and constants in SDL2_ttf 2.20.0 (PR #236).
11+
* Updated to wrap new functions and constants in SDL2_mixer 2.6.0 (PR #237).
1112
* Updated to wrap new functions and constants in SDL2_image 2.6.0 (PR #238).
1213
* Added a new function :func:`sdl2.ext.load_svg` that allows loading simple SVG
1314
images at arbitrary resolutions with SDL2_image 2.6.0 or later (PR #238).

0 commit comments

Comments
 (0)