music-commons-fx/net.transgressoft.commons.fx.music/FXMusicLibrary

FXMusicLibrary

class FXMusicLibrary : MusicLibrary<ObservableAudioItem, ObservablePlaylist>

JavaFX-compatible entry point for managing an observable audio library, playlist hierarchy, and waveform repository. Exposes JavaFX properties for direct binding to UI components.

Composes ObservableAudioLibrary, ObservablePlaylistHierarchy, and an AudioWaveformRepository and wires their event subscriptions so that audio item changes propagate to dependent components automatically.

Construct via builder:

val library = FXMusicLibrary.builder()
    .audioLibraryJsonFile(audioFile)
    .playlistHierarchyJsonFile(playlistFile)
    .build()

Types

Builder

class Builder

Builder for FXMusicLibrary.

Companion

object Companion

Properties

albumCountProperty

val albumCountProperty: ReadOnlyIntegerProperty

Observable count of distinct albums in the library.

albumsProperty

val albumsProperty: ReadOnlySetProperty<Album>

Observable set of all albums across all artists in the library.

artistCatalogPublisher

val artistCatalogPublisher: LirpEventPublisher<CrudEvent.Type, CrudEvent<Artist, ObservableArtistCatalog>>

Publisher that emits artist catalog CrudEvent notifications.

artistCatalogsProperty

val artistCatalogsProperty: ReadOnlySetProperty<ObservableArtistCatalog>

Observable set of all artist catalogs, each grouping albums and items by artist.

artistsProperty

val artistsProperty: ReadOnlySetProperty<Artist>

Observable set of all distinct artists in the library.

audioItemsProperty

val audioItemsProperty: ReadOnlyListProperty<ObservableAudioItem>

Observable list of all audio items in the library, suitable for direct JavaFX binding.

emptyLibraryProperty

val emptyLibraryProperty: ReadOnlyBooleanProperty

Boolean property that is true when the library contains no audio items.

playerSubscriber

val playerSubscriber: PlayedEventSubscriber

Subscriber that receives AudioItemPlayerEvent notifications.

playlistsProperty

val playlistsProperty: ReadOnlySetProperty<ObservablePlaylist>

Observable set of all playlists in the hierarchy.

Functions

audioItemFromFile

open override fun audioItemFromFile(path: Path): ObservableAudioItem

Creates an ObservableAudioItem from the audio file at path and adds it to the library.

audioLibrary

open override fun audioLibrary(): ObservableAudioLibrary

Returns the underlying observable audio library for advanced operations.

open override fun close()

createPlaylist

open override fun createPlaylist(name: String): ObservablePlaylist

@JvmName(name = "createPlaylistWithIds")

open override fun createPlaylist(name: String, audioItemIds: List<Int>): ObservablePlaylist

fun createPlaylist(name: String, audioItems: List<ObservableAudioItem>): ObservablePlaylist

Creates a new playlist with name pre-populated with audioItems.

createPlaylistDirectory

open override fun createPlaylistDirectory(name: String): ObservablePlaylist

findPlaylistByName

open override fun findPlaylistByName(name: String): Optional<out ObservablePlaylist>

movePlaylist

open override fun movePlaylist(playlistNameToMove: String, destinationPlaylistName: String)

playlistHierarchy

open override fun playlistHierarchy(): ObservablePlaylistHierarchy

Returns the underlying observable playlist hierarchy for advanced operations.

waveformRepository

fun waveformRepository(): AudioWaveformRepository<AudioWaveform, ObservableAudioItem>

Returns the underlying waveform repository for advanced operations.