Add optional cache data to streamdetails

Author: marcelveldt

music_assistant_models/enums.py

@@ -379,7 +379,7 @@ class EventType(StrEnum):
     PLAYER_ADDED = "player_added"
     PLAYER_UPDATED = "player_updated"
     PLAYER_REMOVED = "player_removed"
-    PLAYER_SETTINGS_UPDATED = "player_settings_updated"
+    PLAYER_CONFIG_UPDATED = "player_config_updated"
     QUEUE_ADDED = "queue_added"
     QUEUE_UPDATED = "queue_updated"
     QUEUE_ITEMS_UPDATED = "queue_items_updated"
@@ -390,7 +390,6 @@ class EventType(StrEnum):
     MEDIA_ITEM_UPDATED = "media_item_updated"
     MEDIA_ITEM_DELETED = "media_item_deleted"
     PROVIDERS_UPDATED = "providers_updated"
-    PLAYER_CONFIG_UPDATED = "player_config_updated"
     SYNC_TASKS_UPDATED = "sync_tasks_updated"
     AUTH_SESSION = "auth_session"
     UNKNOWN = "unknown"
@@ -526,6 +525,9 @@ class StreamType(StrEnum):
     # other_ffmpeg: any other ffmpeg compatible input stream (used together with extra_input_args)
     OTHER_FFMPEG = "other_ffmpeg"
 
+    # cache_file: (temporary) cached file - path provided in path
+    CACHE_FILE = "cache_file"
+
     # custom: custom (bytes) stream - provided by an (async) generator
     CUSTOM = "custom"
 

music_assistant_models/streamdetails.py

@@ -103,6 +103,19 @@ class StreamDetails(DataClassDictMixin):
         repr=False,
     )
 
+    # enable_cache: bool to indicate that the audio be be temporary cached
+    # this increases performance (especially while seeking) and reduces network
+    # usage for streams that are played multiple times. For some (slow) streams
+    # its even required to prevent buffering issues.
+    # leave/set to None to let the core decide based on the stream type.
+    # True to enforce caching, False to disable caching.
+    enable_cache: bool | None = field(
+        default=None,
+        compare=False,
+        metadata=field_options(serialize="omit", deserialize=pass_through),
+        repr=False,
+    )
+
     #############################################################################
     # the fields below will be set/controlled by the streamcontroller           #
     #############################################################################
@@ -150,6 +163,12 @@ class StreamDetails(DataClassDictMixin):
         metadata=field_options(serialize="omit", deserialize=pass_through),
         repr=False,
     )
+    cache: Any = field(
+        default=None,
+        compare=False,
+        metadata=field_options(serialize="omit", deserialize=pass_through),
+        repr=False,
+    )
 
     def __str__(self) -> str:
         """Return pretty printable string of object."""