2.4.0 (2024-03-08)

Features

• add an auto-loop option to the MusicManager's play method to allow non-looping tracks to repeat playback with an integrated crossfade (f3885c7)
• allow polyphonic players to be stopped and synchronise the is_playing state with the underlying polyphonic streams (b91e062)

2.3.4 (2024-02-23)

Bug Fixes

• fix sound and music manager parse errors on exported projects (081e753)

2.3.3 (2024-02-17)

Bug Fixes

• ensure that the Sound and Music managers ref-count banks to avoid unexpected removal for multi-users (2fb7223)
• fix the Music and Sound manager default bank bus settings and migrate older addon values if present (9d614db)

2.3.2 (2024-02-09)

Bug Fixes

• add missing reset_* methods to the null audio players (8cd9b7c)
• alter the attachment logic for 2D and 3D players to avoid issues with players being freed before returning to the pool (deprecates auto_release) (d53d856)
• replace the remote transform behaviour with an inbuilt follow-target mechanism to avoid audio artifacts (b741318)

2.3.1 (2024-02-07)

Bug Fixes

• ensure 3D players registered as auto-released aren't lost during scene tree exiting events (aa0d702)
• fix the project settings registration process when the addon loads (4b17eec)

2.3.0 (2024-02-06)

Features

• add a volume variable to sound events (bank-configured) (6b3d66d)
• add enhanced return types, signals, and helper methods to the music manager (e621269)
• add null object pattern to the sound manager for instances and some additional helper methods and events for implementation (df8eb86)
• add pitch variable to sound event resources and fix pitch and volume behaviour across audio stream players (5918f8e)
• add play_varied, play_at_position_varied, and play_on_node_varied methods to the sound manager (3f2ec86)
• add reset_volume, reset_pitch, and reset_all methods to pooled audio stream players (07ec5ef)
• add the quick_instance method to the sound manager for bulk instances, or for shorter registration calls (03f2515)

Bug Fixes

• ensure that pooled audio stream players return the player volume back to the base volume when calling trigger after trigger_varied, and that trigger_varied isn't affected by the base volume on polyphonic playback (f53f709)
• fix the "signal already connected" error in multiple single-script auto_released instances and ensure the connection is deferred (f7b2553)
• fix the error handling & messages for missing streams or players in the sound manager (9e4d27d)
• fix the volume adjustment in the trigger_varied method on non-polyphonic pooled audio stream players (1ed5ebd)
• increase the volume step resolution on music stem resources to allow for fractional dBs (51cf761)
• push a warning when instanced sound events that contain looping variations are released with "finish playing" - these will be forced to stop playback (fdce4d2)

2.2.0 (2024-02-01)

Features

• add a warning for when a music track contains non-looping stems (3577b09)
• add auto_release and auto_stop convenience methods to the sound and music managers (5640a57)

Bug Fixes

• ensure that pooled audio stream players immediately stop playback (by default) on release (3cf44cd)
• ensure the pool entity release method immediately stops the playback of looping stems even if finish_playing is set (8014e20)

2.1.0 (2024-01-31)

Features

• add automatic detection of new sound and music banks during scene changes & runtime node insertion/deletion (f964908)
• enhance the is_playing method on the MusicManager to allow bank and track scoping (90eb8d3)

2.0.0 (2024-01-30)

⚠ BREAKING CHANGES

• rename MusicResource to MusicTrackResource

Features

• add a bus override option to MusicBanks and MusicTrackResources (61ede7e)
• add global MusicManager and individual stem volume management (02696cd)
• add labels to MusicBanks to allow the grouping/scoping of music tracks (1192122)
• expose the MusicManager's loaded status via a has_loaded public variable (4145ac0)

Bug Fixes

• rename MusicResource to MusicTrackResource (8ba7355)
• update the build script to include a top-level name & version directory in the release .zip and also bundle-in a copy of the documentation (8db1ae4)

1.0.2 (2024-01-29)

Bug Fixes

• remove the extraneous pool_updated signal and PoolType enum from the SoundManager (2066868)
• remove the SoundManager type references from the pooled audio stream players to avoid errors when the addon is disabled (c3e3cd9)