Make streams easy to reset

[linknum23]

Context

In AmpliPi a stream is defined as any type audio input that can be played on a source in the system. To play audio out a zone a stream needs to be connected to a source with one or more zones.

Steams come in a couple of different flavors. Some streams hold their state and implement the PersistentSream interface, others just implement the BaseStream interface. To reset a PersistentSream it needs to be deactivated and then activated. To reset a BaseStream disconnecting and connecting it from a source provides a full reset.

Problem

Sometimes a stream gets into a bad state and needs to be restarted. How to do this is not obvious at either an API level or from the UI. For the API it even depends on what type of stream it is.

Solution

• Add a api/streams/{sid}/reset endpoint to make unified reset interface
• Add a UI view in settings that allows running streams to be reset (and stopped?)
• Optional: add a button in the player view to reset a stream as well?

[mjustian]

What should happen to a PersistentStream that doesn't support activation/deactivation?

[linknum23]

I'm guessing you are talking about:

  def _activate(self, vsrc: int):
    raise NotImplementedError(f'{self.stype} does not support activation')

This is the pythonic way of creating an abstract class. Any stream that implements PersistentStream should implement those. As with everything python this is a little loose.

[mjustian]

Should this restart a file player stream to the beginning?

[linknum23]

Yup. Realistically that stream is used mostly for announcements. It should work like the reset of streams though to keep a similar user experience.

[sumnerboy12]

Is this implemented in v0.3.6 as restart;

[linknum23]

Yup it got included. There's even a button to do it in the UI in Settings->Streams:. To use it select a stream and click the reset button at the bottom of the stream configuration modal..

[linknum23]

The meat of this issue is implemented, closing...