(This function is part of SDL_mixer, a separate library from SDL.)

Mix_SetSoundFonts

Set SoundFonts paths to use by supported MIDI backends.

Header File

Defined in <SDL_mixer.h>

Syntax

int Mix_SetSoundFonts(const char *paths);

Function Parameters

const char *

paths

Paths on the filesystem where SoundFonts are available, separated by semicolons.

Return Value

(int) Returns 1 if successful, 0 on error (out of memory).

Remarks

You may specify multiple paths in a single string by separating them with semicolons; they will be searched in the order listed.

This function replaces any previously-specified paths.

Passing a NULL path will remove any previously-specified paths.

Note that unlike most SDL and SDL_mixer functions, this function returns zero if there's an error, not on success. We apologize for the API design inconsistency here.

Version

This function is available since SDL_mixer 2.0.0.

---

CategoryAPI, CategoryAPIFunction

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.