Skip to content

Synchronize airplay volume #1071

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.

Sign up for GitHub

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

Jump to bottom
Draft
SteveMicroNova wants to merge 38 commits into
base: SpotifyVolumeReflection
Choose a base branch
from
Draft

Synchronize airplay volume #1071

SteveMicroNova wants to merge 38 commits into from

Conversation

@SteveMicroNova
Copy link
Contributor

@SteveMicroNova SteveMicroNova commented Nov 19, 2025

What does this change intend to accomplish?

Does the same as #1063, but for airplay
Airplay does not allow outside sources change the volume of the airplay host, so it's a one way street this time

Checklist

  • Have you tested your changes and ensured they work?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • If applicable, have you updated the documentation/manual?
  • If applicable, have you updated the CHANGELOG?
  • Does your submission pass linting & tests? You can test on localhost using ./scripts/test
  • Have you written new tests for your core features/changes, as applicable?
  • If this is a UI change, have you tested it across multiple browser platforms on both desktop and mobile?

SteveMicroNova
SteveMicroNova commented Nov 19, 2025
View reviewed changes
amplipi/streams/airplay.py
Comment on lines +91 to +117
'drift_in_seconds': 2, # allow this number of frames of drift away from exact synchronisation before attempting to correct it
'resync_threshold_in_seconds': 0, # a synchronisation error greater than this will cause resynchronisation; 0 disables it
'log_verbosity': "diagnostics", # "none" means no debug verbosity, "diagnostics" is most verbose.
Copy link
Contributor Author

@SteveMicroNova SteveMicroNova Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The log file contained warnings about all of these values, it now has no complaints

SteveMicroNova
SteveMicroNova commented Nov 19, 2025
View reviewed changes
This was linked to issues Nov 19, 2025
Sync AirPlay volume with AmpliPi volume #337
Open
Sync airplay and amplipi volumes #1070
Open
@SteveMicroNova SteveMicroNova force-pushed the AirplayVolSync branch 2 times, most recently from 772cb10 to ad8df1e Compare November 19, 2025 21:21
@SteveMicroNova
Copy link
Contributor Author

SteveMicroNova commented Nov 19, 2025

This will require some internal debate before merging, but I'm going to suggest this is ready for review even if not ready for merging

@SteveMicroNova SteveMicroNova marked this pull request as ready for review November 19, 2025 21:26
@SteveMicroNova SteveMicroNova force-pushed the SpotifyVolumeReflection branch from 7de343e to e83de61 Compare November 26, 2025 14:41
@linknum23 linknum23 marked this pull request as draft November 26, 2025 16:15
@SteveMicroNova SteveMicroNova force-pushed the SpotifyVolumeReflection branch from e83de61 to 7fc8fd7 Compare November 26, 2025 17:42
@SteveMicroNova SteveMicroNova force-pushed the AirplayVolSync branch 4 times, most recently from 94d957b to 672fbaf Compare December 1, 2025 19:21
@SteveMicroNova SteveMicroNova force-pushed the SpotifyVolumeReflection branch from 9e275c2 to 39d9455 Compare December 1, 2025 20:57
@SteveMicroNova SteveMicroNova mentioned this pull request Dec 1, 2025
Open
5 tasks
@SteveMicroNova
Add basic vol change functionality to spotify metadata reader
d830e2d
@SteveMicroNova
Add secondary script that handles volume changes much cleaner, remove…
b1a0e31 
… most of the changes to the metadata script
@SteveMicroNova
Revert all changes to spot connect meta
f8c5a6d
@SteveMicroNova
Make the volume handler multithreaded and event based on the spotify …
44b8c79 
…side, combine both prior volumes into a more authoritative "shared volume" that is checked against as the authority for what is true or what should become true
@SteveMicroNova
Change prints, add documentation
eb3ac18
@SteveMicroNova
Remove unused print
191cf2a
@SteveMicroNova
Add ignore to false linting error
a7c7627
@SteveMicroNova
Refactor spotify_volume_handler to be multithreaded, event based, and…
b0afb89 
… more accurate
@SteveMicroNova
Linting
9adc2eb
@SteveMicroNova
Reduce complexity of SpotifyVolumeHandler by splitting up the events …
741cf6f 
…so they each call their own function
@SteveMicroNova
Explicitly provide source rather than attempting to calculate it
d8dcd3a 
swap from debug prints to loggers
add commented out WIP of a direct house.json reader
@SteveMicroNova
Implement vol script
91b1569 
Gate a few things in the vol script better
@SteveMicroNova
Improve event gating
877dd8c
@SteveMicroNova
Generalize volume synchronizer script for future use with airplay and…
3b0f603 
… other streams
@SteveMicroNova
Remove unused utils function
541826b
@SteveMicroNova
Lint
79cd961
@SteveMicroNova
Improve variable name
11c8f34
@SteveMicroNova
Reduce the lag time between changing volume and seeing it reflected o…
e8ca331 
…n the other side
@SteveMicroNova
Pass a fully formed object to VolumeSynchronizer instead of the const…
fa86790 
…ructor and the kwargs, update documentation
@SteveMicroNova
Change event_queue.get() to be a blocking call, meaning that any new …
86cf823 
…events in the queue will instantly reflect their requested changes rather than waiting for 1-2 seconds due to the time.sleep()
@SteveMicroNova
Add FIFO-based volume listening for amplipi streams
78432e2
@SteveMicroNova
Stop filtering flow by "If not is not None"
e1c737c
@SteveMicroNova
Move typehint "list" to "Typing.List" to fit with our python version …
ec6f264 
…and linting practices
@SteveMicroNova
linting
a0b5209
@SteveMicroNova
Close the fifo cleanly
0c67268
@SteveMicroNova
Increase the speed of volume gathering
0b7cfee
@SteveMicroNova
Remove unnecessary stream_id plumbing through every stream type
8492f08 
Change names of attributes in spotify_connect.py

Update documentation in volume_synchronizer.py
@SteveMicroNova
Remove the last vestiges of stream_id plumbing
19d9273
@SteveMicroNova
Remove last bit of stream_id drilling for real this time
2999e44
@SteveMicroNova
Add a lot of documentation
7be75c5 
Change variable names
Add VolEvent enum
@SteveMicroNova
Remove typing.Annotated
94c18c4
@SteveMicroNova
Update docstring of volume_synchronizer.py
4d2b723
@SteveMicroNova SteveMicroNova force-pushed the SpotifyVolumeReflection branch from 24a5664 to 4d2b723 Compare December 2, 2025 17:55
@SteveMicroNova
Close things properly
f0f51bf 
Add more docs
Rename some classes, attributes, and variables
SteveMicroNova
SteveMicroNova commented Dec 4, 2025
View reviewed changes
streams/shairport_volume_handler.py
Comment on lines +55 to +57
# In any future MPRIS based volume synchronizers, you can check if self.mpris.CanControl is true and then potentially directly set self.mpris.Volume
# Note that we cannot do this due to this line: <property name='Volume' type='d' access='read'/>
# That exists in the MPRIS config xml at https://github.com/mikebrady/shairport-sync/blob/master/org.mpris.MediaPlayer2.xml
Copy link
Contributor Author

@SteveMicroNova SteveMicroNova Dec 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll either have to make a PR in shairport-sync or move to a new implementation to make this vol sync a good user experience

Copy link
Contributor

@linknum23 linknum23 Dec 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since shareport-sync is extremely well maintained I would suggest the PR route.

@SteveMicroNova SteveMicroNova force-pushed the SpotifyVolumeReflection branch 2 times, most recently from 61789c5 to 6d89922 Compare December 5, 2025 21:28
@SteveMicroNova SteveMicroNova mentioned this pull request Dec 15, 2025
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@linknum23 linknum23 linknum23 left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Sync airplay and amplipi volumes Sync AirPlay volume with AmpliPi volume

3 participants

@SteveMicroNova @linknum23