Skip to content

add support for fetching loudness levels of audio streams #1529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions plexapi/media.py
Original file line number Diff line number Diff line change
Expand Up @@ -433,10 +433,34 @@ def setSelected(self):
"""
return self._parent().setSelectedAudioStream(self)

def levels(self, subSample=128):
""" Load time series loudness levels.

Attributes:
subSample: (int): the number of loudness segments to load
"""

key = f'/library/streams/{self.id}/levels'
params = {'subsample': subSample}

levels = self.fetchItems(ekey=key, cls=Level, params=params)
return levels

@deprecated('Use "setSelected" instead.')
def setDefault(self):
return self.setSelected()

@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 SubtitleStream(MediaPartStream):
Expand Down
1 change: 1 addition & 0 deletions tests/test_audio.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


def test_audio_Track_album(album):
Expand Down