add support for fetching loudness levels of audio streams #1529
+25
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Added a basic test that fetches a custom amount of levels and checks the returned list length. |
|
@JonnyWong16 no interest in this patch? |
JonnyWong16
requested changes
Jun 28, 2025
| @@ -433,10 +433,34 @@ def setSelected(self): | |||
| """ | |||
| return self._parent().setSelectedAudioStream(self) | |||
|
|
|||
| def levels(self, subSample=128): | |||
| """ Load time series loudness levels. | |||
There was a problem hiding this comment.
Suggested change
| """ Load time series loudness levels. | |
| """ Returns a list of :class:`~plexapi.media.Level` objects for this AudioStream. | |
| Only available for Tracks which have been analyzed for loudness. |
| """ Load time series loudness levels. | ||
|
|
||
| Attributes: | ||
| subSample: (int): the number of loudness segments to load |
There was a problem hiding this comment.
Suggested change
| subSample: (int): the number of loudness segments to load | |
| subSample (int): The number of loudness samples to return. Default 128. |
Comment on lines
+442
to
+447
|
|
||
| key = f'/library/streams/{self.id}/levels' | ||
| params = {'subsample': subSample} | ||
|
|
||
| levels = self.fetchItems(ekey=key, cls=Level, params=params) | ||
| return levels |
There was a problem hiding this comment.
Suggested change
| key = f'/library/streams/{self.id}/levels' | |
| params = {'subsample': subSample} | |
| levels = self.fetchItems(ekey=key, cls=Level, params=params) | |
| return levels | |
| key = f'/library/streams/{self.id}/levels' | |
| params = {'subsample': subSample} | |
| return self.fetchItems(key, params=params) |
Comment on lines
+453
to
+463
| @utils.registerPlexObject | ||
| class Level(PlexObject): | ||
| """ Represents an instance of loudness for an audio stream. | ||
|
|
||
| Attributes: | ||
| loudness (float): loudness level in db | ||
| """ | ||
| def _loadData(self, data): | ||
| """ Load attribute values from Plex XML response. """ | ||
| self.loudness = data.attrib.get('v') | ||
|
|
There was a problem hiding this comment.
Move to the bottom of the file.
Suggested change
| @utils.registerPlexObject | |
| class Level(PlexObject): | |
| """ Represents an instance of loudness for an audio stream. | |
| Attributes: | |
| loudness (float): loudness level in db | |
| """ | |
| def _loadData(self, data): | |
| """ Load attribute values from Plex XML response. """ | |
| self.loudness = data.attrib.get('v') | |
| @utils.registerPlexObject | |
| class Level(PlexObject): | |
| """ Represents a single loudness Level sample for an AudioStream. | |
| Attributes: | |
| loudness (float): Loudness level value | |
| """ | |
| def _loadData(self, data): | |
| """ Load attribute values from Plex XML response. """ | |
| self.loudness = utils.cast(float, data.attrib.get('v')) |
| @@ -397,6 +397,7 @@ def test_audio_Track_attrs(album): | |||
| assert stream.lra is None | |||
| assert stream.peak is None | |||
| assert stream.startRamp is None | |||
| assert len(stream.levels(subSample=32)) == 32 | |||
There was a problem hiding this comment.
Suggested change
| assert len(stream.levels(subSample=32)) == 32 | |
| if stream.loudness is not None: | |
| assert len(stream.levels(subSample=32)) == 32 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This adds support for fetching loudness levels. This is used in Plexamp and Dash to show a waveform of the currently playing track. See here for a screenshot of what I mean.
Type of change
Checklist:
I have not added tests (yet). Python is not my first language and I'm having a bit of trouble wrapping my head around how the test suite works.