Clarify async loading documentation in preset load callback

revmischa · revmischa · commit 5acd8bf9eea2 · 2026-02-01T21:23:03.000-08:00
diff --git a/src/playlist/api/projectM-4/playlist_callbacks.h b/src/playlist/api/projectM-4/playlist_callbacks.h
@@ -76,7 +76,6 @@ typedef void (*projectm_playlist_preset_switch_failed_event)(const char* preset_
  * letting the playlist library load presets from the filesystem. This is useful for:
  * - Loading presets from archives (e.g., ZIP files)
  * - Loading presets from network sources (e.g., HTTP)
- * - Asynchronous preset loading
  * - Custom preset storage solutions
  *
  * When this callback is set and returns true, the playlist library will NOT attempt
@@ -86,6 +85,9 @@ typedef void (*projectm_playlist_preset_switch_failed_event)(const char* preset_
  * - Handling any loading errors
  * - Firing the preset_switched_event callback when the preset is ready (if desired)
  *
+ * Note: If implementing asynchronous loading, the application must complete the load and
+ * fire the preset_switched_event callback itself after the async operation completes.
+ *
  * If the callback returns false or is not set, the playlist library will use the
  * default behavior of loading the preset from the filesystem.
  *

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,6 @@ typedef void (projectm_playlist_preset_switch_failed_event)(const char preset_`
`76`	`76`	`* letting the playlist library load presets from the filesystem. This is useful for:`
`77`	`77`	`* - Loading presets from archives (e.g., ZIP files)`
`78`	`78`	`* - Loading presets from network sources (e.g., HTTP)`
`79`		`- * - Asynchronous preset loading`
`80`	`79`	`* - Custom preset storage solutions`
`81`	`80`	`*`
`82`	`81`	`* When this callback is set and returns true, the playlist library will NOT attempt`
`@@ -86,6 +85,9 @@ typedef void (projectm_playlist_preset_switch_failed_event)(const char preset_`
`86`	`85`	`* - Handling any loading errors`
`87`	`86`	`* - Firing the preset_switched_event callback when the preset is ready (if desired)`
`88`	`87`	`*`
	`88`	`+ * Note: If implementing asynchronous loading, the application must complete the load and`
	`89`	`+ * fire the preset_switched_event callback itself after the async operation completes.`
	`90`	`+ *`
`89`	`91`	`* If the callback returns false or is not set, the playlist library will use the`
`90`	`92`	`* default behavior of loading the preset from the filesystem.`
`91`	`93`	`*`