Provide alternative ways of implementing route selection

[defagos]

As a UI/UX designer I would like to be able to add route selection (usually AirPlay) in alternative ways, most notably when other route picking options are available (e.g. Google Cast).

Acceptance criteria

• Options have been investigated.
• A list of useful UI components is provided to answer this need.

Hints

Modern route picking occurs using AVRoutePickerView. Since iOS 16 this view makes it possible to customize route selection via customRoutingController, so this might open up new possibilities. Moreover some apps (e.g. YouTube) provide a consolidated menu for route selection, especially since Google Cast is also supported. This could possibly make integration with Castor receiver selection even more natural.

Also check the official documentation.

Tasks

• Create a PoC to integrate a route picker view as a Menu item.
• Create a PoC to integrate non-standard routes (not related to AirPlay) using customRoutingController. Might not be possible since it is likely we can only re-route AVFoundation playback.
• Try to have the connection state displayed in PoC components (if meaningful).
• Implement identified useful components based on PoC output.
• Update our route picker views so that they support customRoutingController as well.
• Create a Castor issue to implement a customRoutingController if a PoC shows this is possible, and create a method to return a menu item content as well.

[defagos]

I implemented a Poc for a route picker button in Menu on 1237/route-picker-menu-item-poc. Some remarks:

• RoutePickerView offers little customization in how it is represented. To make the view customizable an invisible RoutePickerView is embedded in a representable which, with the help of a trick borrowed from Play SRG, makes it possible to trigger the button action.
• The button is currently searched in subviews but should likely be searched recursively for more robustness.
• I currently used a Label but we could make the appearance customizable very easily. We could offer a button with a state if possible (not connected, connecting, connected) that can be customized. This very same button could then be used as a replacement of RoutePickerView if the default icon needs to be changed, or when used in a Menu.
• I provided a menu helper but maybe this is actually not needed (the method does not need any Player anyway).
• Our current RoutePickerView implementation could probably be updated to support customization. We might need to think about modifiers, though (e.g. the modifier that sets the active tint color). Some API changes might be needed so that the API is consistent in the end, whether the default button or a custom one are used.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 14 days or if the stale label is not removed.